Package de.hybris.platform.cockpit.components.contentbrowser

Class AbstractBrowserComponent

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
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:
AbstractContextBrowserComponent, AbstractMainAreaBrowserComponent, AbstractMultiViewToolbarBrowserComponent, CaptionBrowserComponent, MacFinderTreeComponent, ReportDashboardCaptionComponent, WidgetDashboardToolbarComponent
public abstract class AbstractBrowserComponent extends org.zkoss.zul.Div implements BrowserComponent
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
    ADV_QUERY_BTN_ACTIVE_IMG
     
    protected static final String
    ADV_QUERY_BTN_IMG
     
    protected static final String
    BROWSER_TOOLBAR_SCLASS
     
    protected static final String
    CLOSE_BTN_IMG
     
    protected static final String
    CONTENT_BROWSER_GB_SCLASS
     
    protected static final String
    CONTENT_BROWSER_STICKY_GB_SCLASS
     
    protected static final String
    DUPLICATE_BTN_IMG
     
    protected boolean
    initialized
     
    protected static final String
    MAIN_AREA_BL_SCLASS
     
    protected static final String
    MINIMIZE_BTN_IMG
     
    protected static final String
    SAVE_QUERY_BTN_IMG
     
    protected static final String
    SEARCH_MAGNIFIER_BTN_IMG
     
    protected static final String
    SPLIT_ACTIVE_BTN_IMG
     
    protected static final String
    SPLIT_INACTIVE_BTN_IMG
     

    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
    AbstractBrowserComponent(BrowserModel model, AbstractContentBrowser contentBrowser)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    AbstractContentBrowser
    getContentBrowser()
    Returns the content browser containing this browser component.
    BrowserModel
    getModel()
     
    abstract boolean
    initialize()
    Initializes this browser component i.e.
    abstract void
    resize()
    Notifies this browser component that it should resize itself if possible, since the view state might require it.
    abstract void
    setActiveItem(TypedObject activeItem)
    Sets the active item of this browser component to activeItem.
    void
    setModel(BrowserModel model)
    Sets the model to model and calls initialize().
    abstract boolean
    update()
    Updates this browser component i.e.
    abstract void
    updateActiveItems()
    Re-renders the currently active item(s).
    abstract void
    updateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties)
    Re-renders the item.
    void
    updateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties, Object reason)
    Override if you want to react on the reason for the update
    abstract void
    updateSelectedItems()
    Re-renders the currently selected item(s).

    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, 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, isChildable, 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.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

    • update

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

    • setActiveItem

      public abstract void setActiveItem(TypedObject activeItem)
      Sets the active item of this browser component to activeItem.
      Specified by:
      setActiveItem in interface CockpitComponent
      Parameters:
      activeItem - the new active item

    • updateActiveItems

      public abstract void updateActiveItems()
      Re-renders the currently active item(s).
      Specified by:
      updateActiveItems in interface CockpitComponent

    • updateSelectedItems

      public abstract void updateSelectedItems()
      Re-renders the currently selected item(s).
      Specified by:
      updateSelectedItems in interface CockpitComponent

    • updateItem

      public abstract void updateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties)
      Re-renders the item.
      Specified by:
      updateItem in interface CockpitComponent
      Parameters:
      item - the item to be re-rendered
      modifiedProperties - modified properties

    • updateItem

      public void updateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties, Object reason)
      Override if you want to react on the reason for the update
      Parameters:
      reason - the reason for the update

    • initialize

      public abstract boolean initialize()
      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
      Returns:
      true if initialization was successful, false otherwise
      See Also:

    • resize

      public abstract void resize()
      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.

    • getModel

      public BrowserModel getModel()
      Specified by:
      getModel in interface BrowserComponent

    • getContentBrowser

      public AbstractContentBrowser getContentBrowser()
      Returns the content browser containing this browser component.
      Returns:
      the content browser containing this component

    • setModel

      public void setModel(BrowserModel model)
      Sets the model to model and calls initialize().
      Specified by:
      setModel in interface BrowserComponent
      Parameters:
      model - the model