Interface ListViewAction
- All Known Subinterfaces:
AdvancedListViewAction
- All Known Implementing Classes:
AbstractCmscockpitListViewAction,AbstractCommentAction,AbstractListViewAction,AbstractMultiSelectOnlyAction,AbstractPerspectiveSwitchAction,AbstractProductAction,AbstractSynchronizationAction,ActivateItemAction,AddAttachmentCommentAction,AddItemCommentAction,AddMultiItemCommentAction,AddProductToExpressUdateAction,AnswerCommentAction,AnswerCommentFromCommenLayerAction,ApprovalAction,ApprovalPageStatusAction,ApprovalStatus,BaseProductAction,ClassificationAction,CloneContentElementAction,ClonesAction,CmsComponentIconAction,CmsCreatePersonalizedPageAction,CmsElementSyncAction,CmsListviewMoveItemAction,CmsMultiplePagesAction,CmsRestrictionAction,CompareAction,CoverageInfoAction,DecisionAction,DefaultExportEditorAreaAction,DefaultPerspectiveSwitchAction,DeleteAction,DeleteCommentAction,DeleteCommentFromCommentLayerAction,DuplicateAction,EditAction,EditCommentAction,EditCommentFromCommentLayerAction,EditContentElementAction,EditItemAction,EditPageBrowserAction,ElementLockedInfoAction,ExportCsvAction,ExportEditorArea2PdfAction,ExportEditorArea2XlsAction,MoveContentElementAction,NewItemAction,NewPageBrowserAction,OpenCommentAction,PageLockBrowserAction,PendingAction,ProductSynchronizationAction,ProductSynchronizationStatus,PullSynchronizationAction,RecalculateOrderAction,RemoveContentElementAction,RemoveContentSlotAction,RemoveContextItemAction,RemovePageBrowserAction,ShowSynchProductsAction,SitePreviewThumbnailAction,SplitterDummyAction,TaskStatusAction,VariantsAction,VariantsStatus,ZoomContentElementAction
public interface ListViewAction
Represents a list view action.
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
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 methodsorg.zkoss.zul.MenupopupgetContextPopup(ListViewAction.Context context) Gets the context popup of the action button.org.zkoss.zk.ui.event.EventListenergetEventListener(ListViewAction.Context context) Gets theEventListenerwhich is to be registered for theEvents.ON_CLICKevent.getImageURI(ListViewAction.Context context) Gets the image URI which represents the action button.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.org.zkoss.zul.MenupopupgetPopup(ListViewAction.Context context) Gets the popup of the action button.getStatusCode(ListViewAction.Context context) Get a status code for this action.getTooltip(ListViewAction.Context context) Gets the tooltip of the action button.
-
Field Details
-
AFFECTED_ITEMS_KEY
- See Also:
-
-
Method Details
-
createContext
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
Initialize values only once to be used by following service methods- Parameters:
listModel-item-- Returns:
- Context containing computed value for subsequent service calls
-
getImageURI
Gets the image URI which represents the action button.- Returns:
- URI of the image to represent the action button
-
getEventListener
Gets theEventListenerwhich is to be registered for theEvents.ON_CLICKevent.- Returns:
- the event listener which should be called when user clicks the action button
-
getPopup
Gets the popup of the action button.- Returns:
- the popup which should appear when the user clicks the action button or
nullif no popup is available
-
getContextPopup
Gets the context popup of the action button.- Returns:
- the popup which should appear when the user right-clicks the action button or
nullif no popup is available
-
getTooltip
Gets the tooltip of the action button.- Returns:
- the tooltip string which should appear when the user hovers over the action button
-
getMultiSelectImageURI
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
Gets theEventListenerfor selection operation which is to be registered for theEvents.ON_CLICKevent.- Returns:
- the event listener which should be called when user clicks the action button
-
getMultiSelectPopup
Gets the popup of the action button for selection operation.- Returns:
- the popup which should appear when the user clicks the action button or
nullif no popup is available
-
getStatusCode
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
-