Class AbstractMultiViewToolbarBrowserComponent

java.lang.Object
org.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.Div
de.hybris.platform.cockpit.components.contentbrowser.AbstractBrowserComponent
de.hybris.platform.cockpit.components.contentbrowser.AbstractMultiViewToolbarBrowserComponent
All Implemented Interfaces:
BrowserComponent, CockpitComponent, Serializable, Cloneable, org.zkoss.zk.ui.api.HtmlBasedComponent, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl, org.zkoss.zul.api.Div, org.zkoss.zul.impl.api.XulElement
Direct Known Subclasses:
CmsPageToolbarBrowserComponent, DefaultMultiViewToolbarComponent, PagerToolbarBrowserComponent

public abstract class AbstractMultiViewToolbarBrowserComponent extends AbstractBrowserComponent
See Also:
  • Nested Class Summary

    Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

    org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

    Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

    org.zkoss.zk.ui.AbstractComponent.Children
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final String
     
    protected static final String
     

    Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

    _zclass

    Fields inherited from interface org.zkoss.zk.ui.Component

    APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

    Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

    AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.zkoss.zk.ui.HtmlBasedComponent
     
    protected org.zkoss.zk.ui.HtmlBasedComponent
     
    protected org.zkoss.zk.ui.HtmlBasedComponent
     
    protected boolean
     
     
     
    org.zkoss.zul.Div
     
     
    org.zkoss.zul.Div
     
    List<org.zkoss.zul.Toolbarbutton>
     
    boolean
    Initializes this browser component i.e.
    protected void
     
    boolean
     
    void
    Notifies this browser component that it should resize itself if possible, since the view state might require it.
    void
    Sets the active item of this browser component to activeItem.
    void
    setCommentToolbarSlot(org.zkoss.zul.Div commentToolbarSlot)
     
    void
    setViewButtonsVisible(boolean viewButtonsVisible)
     
    boolean
    Updates this browser component i.e.
    protected void
    updateActionArea(ActionColumnConfiguration actionConfig, org.zkoss.zk.ui.HtmlBasedComponent actionArea, Boolean isMultiSelect)
     
    protected void
    updateActionAreaAction(ListViewAction.Context context, ListViewAction action, org.zkoss.zk.ui.HtmlBasedComponent actionArea, Boolean isMultiSelect)
     
    void
    Re-renders the currently active item(s).
    protected void
     
    void
    updateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties)
    Re-renders the item.
    protected void
     
    void
    Re-renders the currently selected item(s).
    protected void
     

    Methods inherited from class de.hybris.platform.cockpit.components.contentbrowser.AbstractBrowserComponent

    getContentBrowser, setModel, updateItem

    Methods inherited from class org.zkoss.zul.Div

    getAlign, renderProperties, setAlign

    Methods inherited from class org.zkoss.zul.impl.XulElement

    clone, getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes

    Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

    addSclass, evalCSSFlex, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, removeSclass, removeSclass, service, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

    Methods inherited from class org.zkoss.zk.ui.AbstractComponent

    addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, invalidatePartial, isChildable, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.zkoss.zk.ui.Component

    addEventListener, addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getDefinition, getDesktop, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getShadowVariable, getShadowVariable, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, query, queryAll, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride

    Methods inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

    invalidatePartial

    Methods inherited from interface org.zkoss.zul.api.Div

    getAlign, setAlign

    Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent

    focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex

    Methods inherited from interface org.zkoss.zk.ui.ext.Scope

    addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

    Methods inherited from interface org.zkoss.zul.impl.api.XulElement

    getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
  • Field Details

  • Constructor Details

  • Method Details

    • currentViewHasOwnModel

      protected boolean currentViewHasOwnModel()
    • createLeftToolbarContent

      protected org.zkoss.zk.ui.HtmlBasedComponent createLeftToolbarContent()
    • initializeCommentToolbarSlot

      protected void initializeCommentToolbarSlot()
    • createRightToolbarContent

      protected org.zkoss.zk.ui.HtmlBasedComponent createRightToolbarContent()
    • updateViewModeButtons

      protected void updateViewModeButtons()
    • updateMultiSelectActionArea

      protected void updateMultiSelectActionArea()
    • updateActionArea

      protected void updateActionArea(ActionColumnConfiguration actionConfig, org.zkoss.zk.ui.HtmlBasedComponent actionArea, Boolean isMultiSelect)
    • updateActionAreaAction

      protected void updateActionAreaAction(ListViewAction.Context context, ListViewAction action, org.zkoss.zk.ui.HtmlBasedComponent actionArea, Boolean isMultiSelect)
    • getActionConfig

      protected ActionColumnConfiguration getActionConfig()
    • getAddtionalToolbarActionConfig

      protected ActionColumnConfiguration getAddtionalToolbarActionConfig()
    • getMultiSelectActionArea

      public org.zkoss.zul.Div getMultiSelectActionArea()
    • update

      public boolean update()
      Description copied from class: AbstractBrowserComponent
      Updates this browser component i.e. synchronizes its view width the underlying model.
      Specified by:
      update in interface CockpitComponent
      Specified by:
      update in class AbstractBrowserComponent
      Returns:
      true if this browser was successfully updated, false otherwise
    • initialize

      public boolean initialize()
      Description copied from class: AbstractBrowserComponent
      Initializes this browser component i.e. creates all required components, adds event listeners etc.

      Implementation note: Remember to set the initialized flag to true after this method has been called.

      Note: This method is automatically called when a model or browser controller is set.

      Specified by:
      initialize in interface CockpitComponent
      Specified by:
      initialize in class AbstractBrowserComponent
      Returns:
      true if initialization was successful, false otherwise
      See Also:
    • createToolbar

      protected org.zkoss.zk.ui.HtmlBasedComponent createToolbar()
    • updateCommentToolbarSlot

      protected void updateCommentToolbarSlot()
    • getCommentToolbarSlot

      public org.zkoss.zul.Div getCommentToolbarSlot()
      Returns:
      the commentToolbarSlot
    • setCommentToolbarSlot

      public void setCommentToolbarSlot(org.zkoss.zul.Div commentToolbarSlot)
      Parameters:
      commentToolbarSlot - the commentToolbarSlot to set
    • getModel

      public AdvancedBrowserModel getModel()
      Specified by:
      getModel in interface BrowserComponent
      Overrides:
      getModel in class AbstractBrowserComponent
    • isViewButtonsVisible

      public boolean isViewButtonsVisible()
    • setViewButtonsVisible

      public void setViewButtonsVisible(boolean viewButtonsVisible)
    • setActiveItem

      public void setActiveItem(TypedObject activeItem)
      Description copied from class: AbstractBrowserComponent
      Sets the active item of this browser component to activeItem.
      Specified by:
      setActiveItem in interface CockpitComponent
      Specified by:
      setActiveItem in class AbstractBrowserComponent
      Parameters:
      activeItem - the new active item
    • updateActiveItems

      public void updateActiveItems()
      Description copied from class: AbstractBrowserComponent
      Re-renders the currently active item(s).
      Specified by:
      updateActiveItems in interface CockpitComponent
      Specified by:
      updateActiveItems in class AbstractBrowserComponent
    • updateSelectedItems

      public void updateSelectedItems()
      Description copied from class: AbstractBrowserComponent
      Re-renders the currently selected item(s).
      Specified by:
      updateSelectedItems in interface CockpitComponent
      Specified by:
      updateSelectedItems in class AbstractBrowserComponent
    • resize

      public void resize()
      Description copied from class: AbstractBrowserComponent
      Notifies this browser component that it should resize itself if possible, since the view state might require it.

      This is typically only necessary for ZK's Borderlayout components.

      Specified by:
      resize in class AbstractBrowserComponent
    • updateItem

      public void updateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties)
      Description copied from class: AbstractBrowserComponent
      Re-renders the item.
      Specified by:
      updateItem in interface CockpitComponent
      Specified by:
      updateItem in class AbstractBrowserComponent
      Parameters:
      item - the item to be re-rendered
      modifiedProperties - modified properties
    • getViewModeButtons

      public List<org.zkoss.zul.Toolbarbutton> getViewModeButtons()