Package org.neotropic.kuwaiba.modules.core.favorites.actions

Class FavoritesVisualAction

java.lang.Object

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

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

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

org.neotropic.kuwaiba.modules.core.favorites.actions.FavoritesVisualAction

All Implemented Interfaces:

Comparable

@Component
public class FavoritesVisualAction
extends AbstractVisualAdvancedAction

Action to manage favorites.

Author:

Mauricio Ruiz <mauricio.ruiz@kuwaiba.org>

Nested Class Summary

Nested classes/interfaces inherited from class org.neotropic.kuwaiba.core.apis.integration.modules.actions.AbstractVisualAction

AbstractVisualAction.VisualActionType

Field Summary

Fields inherited from class org.neotropic.kuwaiba.core.apis.integration.modules.actions.AbstractVisualInventoryAction

SELECTION_ANY_OBJECTS, SELECTION_NO_OBJECTS

Fields inherited from class org.neotropic.kuwaiba.core.apis.integration.modules.actions.AbstractVisualAction

childrenActions, formatOptions, icon, listeners, moduleId, type

Constructor Summary

Constructors

Constructor	Description
FavoritesVisualAction()

Method Summary

Modifier and Type	Method	Description
AbstractAction	getModuleAction()	The underlying action wrapped by this visual object.
int	getRequiredSelectedObjects()	How many objects have to be selected so this action is enabled.
WindowFavoritesManager	getVisualComponent(ModuleActionParameterSet parameters)	The visual component (a XXLayout, for example), to be embedded in a Dialog upon triggering the action.

Methods inherited from class org.neotropic.kuwaiba.core.apis.integration.modules.actions.AbstractVisualAdvancedAction

isReusable

Methods inherited from class org.neotropic.kuwaiba.core.apis.integration.modules.actions.AbstractVisualInventoryAction

appliesTo, getName, toString

Methods inherited from class org.neotropic.kuwaiba.core.apis.integration.modules.actions.AbstractVisualAction

clearListeners, compareTo, fireActionCompletedEvent, getChildrenActions, getFormatOptions, getIcon, getModuleId, registerActionCompletedLister, setChildrenActions, setFormatOptions, setIcon, setModuleId, unregisterListener

Methods inherited from class java.lang.Object

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

Constructor Detail

FavoritesVisualAction

public FavoritesVisualAction()

Method Detail

getRequiredSelectedObjects

public int getRequiredSelectedObjects()

Description copied from class: AbstractVisualInventoryAction

How many objects have to be selected so this action is enabled. Use -1 for any (-1), 0 if no objects have to be selected (0), or a number greater than 0 for a fixed number.

Specified by:

getRequiredSelectedObjects in class AbstractVisualInventoryAction

Returns:

The number of objects that have to be selected so the action is enabled.

getVisualComponent

public WindowFavoritesManager getVisualComponent(ModuleActionParameterSet parameters)

Description copied from class: AbstractVisualAction

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

Specified by:

getVisualComponent in class AbstractVisualAction

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 AbstractAction getModuleAction()

Description copied from class: AbstractVisualAction

The underlying action wrapped by this visual object.

Specified by:

getModuleAction in class AbstractVisualAction

Returns:

The action.