Class AbstractListViewAction
java.lang.Object
de.hybris.platform.cockpit.components.listview.AbstractListViewAction
- All Implemented Interfaces:
AdvancedListViewAction,ListViewAction
- Direct Known Subclasses:
AbstractCmscockpitListViewAction,AbstractCommentAction,AbstractMultiSelectOnlyAction,AbstractPerspectiveSwitchAction,AbstractProductAction,AbstractSynchronizationAction,ActivateItemAction,ClassificationAction,ClonesAction,CmsComponentIconAction,CmsCreatePersonalizedPageAction,CmsMultiplePagesAction,CoverageInfoAction,DecisionAction,DefaultExportEditorAreaAction,DeleteAction,DuplicateAction,EditItemAction,MoveContentElementAction,NewItemAction,PageLockBrowserAction,PendingAction,RecalculateOrderAction,RemoveContentSlotAction,SitePreviewThumbnailAction,SplitterDummyAction,TaskStatusAction,ZoomContentElementAction
-
Nested Class Summary
Nested classes/interfaces inherited from interface de.hybris.platform.cockpit.components.listview.ListViewAction
ListViewAction.Context -
Field Summary
FieldsFields inherited from interface de.hybris.platform.cockpit.components.listview.ListViewAction
AFFECTED_ITEMS_KEY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateContext(ListComponentModel listModel, TypedObject item) Initialize values only once to be used by following service methodscreateContext(TableModel model, TypedObject item, ColumnDescriptor column) Initialize values only once to be used by following service methodsprotected abstract voiddoCreateContext(ListViewAction.Context context) protected TypedObjectgetItem(ListViewAction.Context context) org.zkoss.zk.ui.event.EventListenerGets theEventListenerfor selection operation which is to be registered for theEvents.ON_CLICKevent.Gets the image URI for selection operation which represents the action button.org.zkoss.zul.MenupopupGets the popup of the action button for selection operation.getSelectedItems(ListViewAction.Context context) getStatusCode(ListViewAction.Context context) Get a status code for this action.booleanSpecifies whether this action should be enabled even though the component (where this action is used) is marked as non-editable.voidsendEvent(String event, ContextAreaValueContainer cavc, ListViewAction.Context context) protected voidvoidsetAlwaysEnabled(boolean alwaysEnabled) Sets whether this action is always enabled or not.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface de.hybris.platform.cockpit.components.listview.ListViewAction
getContextPopup, getEventListener, getImageURI, getPopup, getTooltip
-
Field Details
-
alwaysEnabled
protected boolean alwaysEnabled -
IN_EDITOR_AREA_SECTION_PANEL
-
-
Constructor Details
-
AbstractListViewAction
public AbstractListViewAction()
-
-
Method Details
-
isAlwaysEnabled
public boolean isAlwaysEnabled()Description copied from interface:AdvancedListViewActionSpecifies whether this action should be enabled even though the component (where this action is used) is marked as non-editable.- Specified by:
isAlwaysEnabledin interfaceAdvancedListViewAction- Returns:
trueif this action is always enabled,falseotherwise
-
setAlwaysEnabled
public void setAlwaysEnabled(boolean alwaysEnabled) Description copied from interface:AdvancedListViewActionSets whether this action is always enabled or not.- Specified by:
setAlwaysEnabledin interfaceAdvancedListViewAction- Parameters:
alwaysEnabled-truemeans this action will always be enabled even though the component is marked as non-editable
-
createContext
public ListViewAction.Context createContext(TableModel model, TypedObject item, ColumnDescriptor column) Description copied from interface:ListViewActionInitialize values only once to be used by following service methods- Specified by:
createContextin interfaceListViewAction- Returns:
- Context containing computed value for subsequent service calls
-
createContext
Description copied from interface:ListViewActionInitialize values only once to be used by following service methods- Specified by:
createContextin interfaceListViewAction- Returns:
- Context containing computed value for subsequent service calls
-
sendEvent
-
sendUpdateItemsEvent
-
doCreateContext
-
getStatusCode
Description copied from interface:ListViewActionGet a status code for this action. This is used e.g. by the id generator.- Specified by:
getStatusCodein interfaceListViewAction- Parameters:
context- the Context- Returns:
- a custom string defined by the instance of listviewaction
-
getMultiSelectImageURI
Description copied from interface:ListViewActionGets the image URI for selection operation which represents the action button.- Specified by:
getMultiSelectImageURIin interfaceListViewAction- Returns:
- URI of the image to represent the action button or null, if action doesn't support multi select operation
-
getMultiSelectEventListener
public org.zkoss.zk.ui.event.EventListener getMultiSelectEventListener(ListViewAction.Context context) Description copied from interface:ListViewActionGets theEventListenerfor selection operation which is to be registered for theEvents.ON_CLICKevent.- Specified by:
getMultiSelectEventListenerin interfaceListViewAction- Returns:
- the event listener which should be called when user clicks the action button
-
getMultiSelectPopup
Description copied from interface:ListViewActionGets the popup of the action button for selection operation.- Specified by:
getMultiSelectPopupin interfaceListViewAction- Returns:
- the popup which should appear when the user clicks the action button or
nullif no popup is available
-
getSelectedItems
-
getItem
-