Package org.neotropic.kuwaiba.core.apis.integration.modules.actions

Class AbstractVisualAction<W extends com.vaadin.flow.component.Component>

java.lang.Object

org.neotropic.kuwaiba.core.apis.integration.modules.actions.AbstractVisualAction<W>

Type Parameters:

W - The visual component that will be displayed upon triggering the action.

All Implemented Interfaces:

Comparable<AbstractVisualAction>

Direct Known Subclasses:

AbstractVisualInventoryAction, AssociateProjectVisualAction, DeleteAttributeVisualAction, DeleteClassVisualAction, DeleteConfigurationVariablesPoolVisualAction, DeleteConfigurationVariableVisualAction, DeleteContactVisualAction, DeleteContractsPoolVisualAction, DeleteContractVisualAction, DeleteFavoriteVisualAction, DeleteFilterDefinitionVisualAction, DeleteGroupVisualAction, DeleteLayoutViewVisualAction, DeleteListTypeItemVisualAction, DeleteMplsViewVisualAction, DeleteParameterVisualAction, DeletePoolVisualAction, DeleteProjectActivityVisualAction, DeleteProjectsPoolVisualAction, DeleteProjectVisualAction, DeleteProxiesPoolVisualAction, DeleteProxyVisualAction, DeleteReportVisualAction, DeleteScriptedQueryPoolVisualAction, DeleteScriptVisualAction, DeleteSdhViewVisualAction, DeleteSparePoolVisualAction, DeleteSyncDataSourceConfigurationVisualAction, DeleteSynchronizationGroupVisualAction, DeleteTaskParameterVisualAction, DeleteTaskUserVisualAction, DeleteTaskVisualAction, DeleteTemplateItemVisualAction, DeleteTemplateSubItemVisualAction, DeleteTemplateVisualAction, DeleteTopologyViewVisualAction, DeleteUserVisualAction, DeleteValidatorDefinitionVisualAction, DeleteWarehouseVisualAction, NewAttributeVisualAction, NewBulkTemplateItemVisualAction, NewBulkTemplateSpecialItemVisualAction, NewClassReportVisualAction, NewClassVisualAction, NewConfigurationVariablesPoolVisualAction, NewConfigurationVariableVisualAction, NewContactVisualAction, NewContractsPoolVisualAction, NewContractVisualAction, NewFavoriteVisualAction, NewFilterDefinitionVisualAction, NewGroupVisualAction, NewInventoryReportVisualAction, NewLayoutViewVisualAction, NewListTypeItemVisualAction, NewMplsViewVisualAction, NewParameterVisualAction, NewPoolItemVisualAction, NewPoolVisualAction, NewProjectActivityVisualAction, NewProjectsPoolVisualAction, NewProjectVisualAction, NewProxiesPoolVisualAction, NewProxyVisualAction, NewScriptedQueryPoolVisualAction, NewScriptedQueryVisualAction, NewSdhViewVisualAction, NewSparePartVisulaAction, NewSparePoolVisualAction, NewSynchronizationGroupVisualAction, NewTaskParameterVisualAction, NewTaskUserVisualAction, NewTaskVisualAction, NewTemplateItemVisualAction, NewTemplateSpecialItemVisualAction, NewTemplateVisualAction, NewTopologyViewVisualAction, NewUserVisualAction, NewValidatorDefinitionVisualAction, NewWarehouseVisualAction, PoolConfigurationDialog, PoolContractDialog, PoolProxiesDialog, ProjectActivityDialog, ProjectPoolDialog, ReleaseObjectFromProjectVisualAction, ReleaseObjectVisualAction, ReleaseProjectVisualAction, ReleaseSyncDataSourceConfigurationVisualAction, ShowMoreInformationAction, SyncGroupDialog, TaskNotificationDialog, TaskParametersManagerDialog, TaskUserManagerDialog, TerminateSessionVisualAction, UpdateFilterDefinitionVisualAction, UpdateTaskParameterVisualAction, UpdateTaskVisualAction, UpdateValidatorDefinitionVisualAction

public abstract class AbstractVisualAction<W extends com.vaadin.flow.component.Component>
extends Object
implements Comparable<AbstractVisualAction>

A module action has two parts: One is the actual, headless (that is, without graphical interface or any other mechanism to capture the necessary parameters) Abstract, and an optional AbstractVisualAction that in the end, will call the backend action.

Author:

Charles Edward Bedon Cortazar <charles.bedon@kuwaiba.org>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractVisualAction.VisualActionType	An enumeration with the possible behaviors of an action, such as opening a window, redirecting to a specific URL or replacing the current page contents.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<AbstractAction>	childrenActions	In case this is a composed action with sub-actions.
protected Properties	formatOptions	Settings useful to renderer to display the action.
protected com.vaadin.flow.component.icon.Icon	icon	Icon for buttons, menu entries, widget cards, etc.
protected List<ActionCompletedListener>	listeners	Those interested in being notified about the result of an action.
protected String	moduleId	The module the actions belongs to.
protected AbstractVisualAction.VisualActionType	type	What is the expected behavior of the action.

Constructor Summary

Constructors

Constructor	Description
AbstractVisualAction(String moduleId)

Method Summary

Modifier and Type	Method	Description
void	clearListeners()
int	compareTo(AbstractVisualAction otherAction)
void	fireActionCompletedEvent(ActionCompletedListener.ActionCompletedEvent ev)
List<AbstractAction>	getChildrenActions()
Properties	getFormatOptions()
com.vaadin.flow.component.icon.Icon	getIcon()
abstract AbstractAction	getModuleAction()	The underlying action wrapped by this visual object.
String	getModuleId()
abstract W	getVisualComponent(ModuleActionParameterSet parameters)	The visual component (a XXLayout, for example), to be embedded in a Dialog upon triggering the action.
void	registerActionCompletedLister(ActionCompletedListener listener)
void	setChildrenActions(List<AbstractAction> childrenActions)
void	setFormatOptions(Properties formatOptions)
void	setIcon(com.vaadin.flow.component.icon.Icon icon)
void	setModuleId(String moduleId)
void	unregisterListener(ActionCompletedListener listener)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

icon

protected com.vaadin.flow.component.icon.Icon icon

Icon for buttons, menu entries, widget cards, etc. SVG images are encouraged, because they can be easily rescaled.

formatOptions

protected Properties formatOptions

Settings useful to renderer to display the action. Currently suggested and supported options: bold (boolean) and color (HTML hex RGB value, including #).

childrenActions

protected List<AbstractAction> childrenActions

In case this is a composed action with sub-actions.

listeners

protected List<ActionCompletedListener> listeners

Those interested in being notified about the result of an action.

type

protected AbstractVisualAction.VisualActionType type

What is the expected behavior of the action. By default, the action opens a window. See AbstractVisualAction.VisualActionType for possible values.

moduleId

protected String moduleId

The module the actions belongs to.

Constructor Detail

AbstractVisualAction

public AbstractVisualAction(String moduleId)

Method Detail

getIcon

public com.vaadin.flow.component.icon.Icon getIcon()

setIcon

public void setIcon(com.vaadin.flow.component.icon.Icon icon)

getFormatOptions

public Properties getFormatOptions()

setFormatOptions

public void setFormatOptions(Properties formatOptions)

getChildrenActions

public List<AbstractAction> getChildrenActions()

setChildrenActions

public void setChildrenActions(List<AbstractAction> childrenActions)

registerActionCompletedLister

public void registerActionCompletedLister(ActionCompletedListener listener)

unregisterListener

public void unregisterListener(ActionCompletedListener listener)

clearListeners

public void clearListeners()

getModuleId

public String getModuleId()

setModuleId

public void setModuleId(String moduleId)

fireActionCompletedEvent

public void fireActionCompletedEvent(ActionCompletedListener.ActionCompletedEvent ev)

getVisualComponent

public abstract W getVisualComponent(ModuleActionParameterSet parameters)

The visual component (a XXLayout, for example), to be embedded in a Dialog upon triggering the action.

Parameters:

parameters - The initial parameters necessary to build the visual component. Some or all these parameters might be later passed to the underlying AbstractAction.

Returns:

The visual component.

getModuleAction

public abstract AbstractAction getModuleAction()

The underlying action wrapped by this visual object.

Returns:

The action.

compareTo

public int compareTo(AbstractVisualAction otherAction)

Specified by:

compareTo in interface Comparable<W extends com.vaadin.flow.component.Component>