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:
  • Field Details

  • Method Details

    • 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

      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

      org.zkoss.zk.ui.event.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

      org.zkoss.zul.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

      org.zkoss.zul.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

      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

      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

      org.zkoss.zk.ui.event.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

      org.zkoss.zul.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

      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