de.hybris.platform.cockpit.components.listview

Interface ListViewAction

All Known Subinterfaces:

AdvancedListViewAction

All Known Implementing Classes:

AbstractCommentAction, AbstractJobListViewAction, AbstractListViewAction, AbstractMultiSelectOnlyAction, AbstractPerspectiveSwitchAction, AbstractProductAction, AbstractSynchronizationAction, ActivateItemAction, AddAttachmentCommentAction, AddItemCommentAction, AddMultiItemCommentAction, AddProductToExpressUdateAction, AnswerCommentAction, AnswerCommentFromCommenLayerAction, ApprovalAction, ApprovalStatus, BaseProductAction, ClassificationAction, ClonesAction, CompareAction, CoverageInfoAction, DecisionAction, DefaultDeleteJobAction, DefaultExportEditorAreaAction, DefaultJobMappingAction, DefaultJobStartStopAction, DefaultPerspectiveSwitchAction, DeleteAction, DeleteCommentAction, DeleteCommentFromCommentLayerAction, DuplicateAction, EditAction, EditCommentAction, EditCommentFromCommentLayerAction, EditItemAction, ExportCsvAction, ExportEditorArea2PdfAction, ExportEditorArea2XlsAction, NewItemAction, OpenCommentAction, PendingAction, ProductSynchronizationAction, ProductSynchronizationStatus, PullSynchronizationAction, RecalculateOrderAction, RemoveContextItemAction, ShowSynchProductsAction, SplitterDummyAction, TaskStatusAction, VariantsAction, VariantsStatus

public interface ListViewAction

Represents a list view action.

See Also:

ActionCellRenderer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ListViewAction.Context

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AFFECTED_ITEMS_KEY

Method Summary

Modifier and Type	Method and Description
ListViewAction.Context	createContext(ListComponentModel listModel, TypedObject item) Initialize values only once to be used by following service methods
ListViewAction.Context	createContext(TableModel model, TypedObject item, ColumnDescriptor column) Initialize values only once to be used by following service methods
Menupopup	getContextPopup(ListViewAction.Context context) Gets the context popup of the action button.
EventListener	getEventListener(ListViewAction.Context context) Gets the EventListener which is to be registered for the Events#ON_CLICK event.
java.lang.String	getImageURI(ListViewAction.Context context) Gets the image URI which represents the action button.
EventListener	getMultiSelectEventListener(ListViewAction.Context context) Gets the EventListener for selection operation which is to be registered for the Events#ON_CLICK event.
java.lang.String	getMultiSelectImageURI(ListViewAction.Context context) Gets the image URI for selection operation which represents the action button.
Menupopup	getMultiSelectPopup(ListViewAction.Context context) Gets the popup of the action button for selection operation.
Menupopup	getPopup(ListViewAction.Context context) Gets the popup of the action button.
java.lang.String	getStatusCode(ListViewAction.Context context) Get a status code for this action.
java.lang.String	getTooltip(ListViewAction.Context context) Gets the tooltip of the action button.

Field Detail

AFFECTED_ITEMS_KEY

static final java.lang.String AFFECTED_ITEMS_KEY

See Also:

Constant Field Values

Method Detail

createContext

ListViewAction.Context createContext(TableModel model,
                                     TypedObject item,
                                     ColumnDescriptor column)

Initialize values only once to be used by following service methods

Parameters:

model -

item -

column -

Returns:

Context containing computed value for subsequent service calls

createContext

ListViewAction.Context createContext(ListComponentModel listModel,
                                     TypedObject item)

Initialize values only once to be used by following service methods

Parameters:

listModel -

item -

Returns:

Context containing computed value for subsequent service calls

getImageURI

java.lang.String getImageURI(ListViewAction.Context context)

Gets the image URI which represents the action button.

Returns:

URI of the image to represent the action button

getEventListener

EventListener getEventListener(ListViewAction.Context context)

Gets the EventListener which is to be registered for the Events#ON_CLICK event.

Returns:

the event listener which should be called when user clicks the action button

getPopup

Menupopup getPopup(ListViewAction.Context context)

Gets the popup of the action button.

Returns:

the popup which should appear when the user clicks the action button or null if no popup is available

getContextPopup

Menupopup getContextPopup(ListViewAction.Context context)

Gets the context popup of the action button.

Returns:

the popup which should appear when the user right-clicks the action button or null if no popup is available

getTooltip

java.lang.String getTooltip(ListViewAction.Context context)

Gets the tooltip of the action button.

Returns:

the tooltip string which should appear when the user hovers over the action button

getMultiSelectImageURI

java.lang.String getMultiSelectImageURI(ListViewAction.Context context)

Gets the image URI for selection operation which represents the action button.

Returns:

URI of the image to represent the action button or null, if action doesn't support multi select operation

getMultiSelectEventListener

EventListener getMultiSelectEventListener(ListViewAction.Context context)

Gets the EventListener for selection operation which is to be registered for the Events#ON_CLICK event.

Returns:

the event listener which should be called when user clicks the action button

getMultiSelectPopup

Menupopup getMultiSelectPopup(ListViewAction.Context context)

Gets the popup of the action button for selection operation.

Returns:

the popup which should appear when the user clicks the action button or null if no popup is available

getStatusCode

java.lang.String getStatusCode(ListViewAction.Context context)

Get a status code for this action. This is used e.g. by the id generator.

Parameters:

context - the Context

Returns:

a custom string defined by the instance of listviewaction