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

Class AbstractContentBrowser

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      class  AbstractContentBrowser.BrowserFocusDiv  

      • 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

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected void cleanup()  
      void desktopRemoved​(org.zkoss.zk.ui.Desktop desktop)  
      void detach()  
      ActionColumnConfiguration getActionConfiguration()  
      AbstractBrowserComponent getCaptionComponent()  
      protected org.zkoss.zk.ui.HtmlBasedComponent getContentBrowserComponent()  
      AbstractBrowserComponent getContextAreaComponent()  
      protected DragAndDropWrapper getDDWrapper()  
      protected org.zkoss.zk.ui.HtmlBasedComponent getFocusComponent()  
      AbstractBrowserComponent getMainAreaComponent()  
      BrowserModel getModel()  
      AbstractBrowserComponent getToolbarComponent()  
      protected abstract boolean initialize()
      Initializes this content browser i.e.
      boolean isActiveWhenUnfocused()  
      boolean isInitialized()  
      abstract void resize()  
      void setActiveWhenUnfocused​(boolean activeWhenUnfocused)  
      void setContentBrowserComponent​(org.zkoss.zk.ui.HtmlBasedComponent contentBrowserComponent)  
      void setFocus​(boolean focus)  
      void setFocusComponent​(org.zkoss.zk.ui.HtmlBasedComponent focusComponent)  
      void setModel​(BrowserModel model)  
      void setParent​(org.zkoss.zk.ui.Component parent)  
      void setRealSclass​(java.lang.String sclass)  
      void setSclass​(java.lang.String sclass)  
      abstract boolean update()
      Updates this content browser i.e.
      abstract void updateActivation()
      This method makes it possible to force the view to get the currently active item(s) from its model, thus synchronizing itself.
      abstract void updateActiveItems()
      This method makes it possible to force the view to re-render the items which are considered "active".
      abstract void updateCaption()  
      abstract void updateContextArea()  
      void updateItem​(TypedObject item, java.util.Set<PropertyDescriptor> modifiedProperties)  
      abstract void updateItem​(TypedObject item, java.util.Set<PropertyDescriptor> modifiedProperties, java.lang.Object reason)
      This method makes it possible to force the view to re-render a list of items.
      abstract void updateMainArea()  
      abstract void updateSelectedItems()
      This method makes it possible to force the view to re-render the items which are considered "selected".
      void updateStatusBar()  
      abstract void updateToolbar()  
      abstract void updateViewMode()  

      • 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

        focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, service, setAction, setClass, setDraggable, setDroppable, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, 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, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, 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, 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

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

    • Constructor Detail

      • AbstractContentBrowser

        public AbstractContentBrowser()

    • Method Detail

      • setFocus

        public void setFocus​(boolean focus)
        Overrides:
        setFocus in class org.zkoss.zk.ui.HtmlBasedComponent

      • setSclass

        public void setSclass​(java.lang.String sclass)
        Overrides:
        setSclass in class org.zkoss.zk.ui.HtmlBasedComponent

      • setRealSclass

        public void setRealSclass​(java.lang.String sclass)

      • setFocusComponent

        public void setFocusComponent​(org.zkoss.zk.ui.HtmlBasedComponent focusComponent)

      • getFocusComponent

        protected org.zkoss.zk.ui.HtmlBasedComponent getFocusComponent()

      • setContentBrowserComponent

        public void setContentBrowserComponent​(org.zkoss.zk.ui.HtmlBasedComponent contentBrowserComponent)

      • getContentBrowserComponent

        protected org.zkoss.zk.ui.HtmlBasedComponent getContentBrowserComponent()

      • updateActiveItems

        public abstract void updateActiveItems()
        This method makes it possible to force the view to re-render the items which are considered "active".

        Note: This will not affect which items are considered active or not.

        See Also:
        updateActivation()

      • updateSelectedItems

        public abstract void updateSelectedItems()
        This method makes it possible to force the view to re-render the items which are considered "selected".

      • updateItem

        public abstract void updateItem​(TypedObject item,
                                java.util.Set<PropertyDescriptor> modifiedProperties,
                                java.lang.Object reason)
        This method makes it possible to force the view to re-render a list of items.
        Parameters:
        item - the item which should be re-rendered
        modifiedProperties - set of modified properties
        reason - the object that causes the update, can be null

      • updateActivation

        public abstract void updateActivation()
        This method makes it possible to force the view to get the currently active item(s) from its model, thus synchronizing itself.
        See Also:
        updateActiveItems()

      • updateMainArea

        public abstract void updateMainArea()

      • updateViewMode

        public abstract void updateViewMode()

      • updateContextArea

        public abstract void updateContextArea()

      • updateCaption

        public abstract void updateCaption()

      • updateToolbar

        public abstract void updateToolbar()

      • update

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

      • initialize

        protected abstract boolean initialize()
        Initializes this content browser i.e. creates all required components, adds event listeners etc.

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

        Implementation note: Do not forget to set the initialized flag before returning.

        Returns:
        true if initialization was successful, false otherwise
        See Also:
        setModel(BrowserModel)

      • resize

        public abstract void resize()

      • updateStatusBar

        public void updateStatusBar()

      • setActiveWhenUnfocused

        public void setActiveWhenUnfocused​(boolean activeWhenUnfocused)
        Parameters:
        activeWhenUnfocused - the activeWhenUnfocused to set

      • isActiveWhenUnfocused

        public boolean isActiveWhenUnfocused()
        Returns:
        the activeWhenUnfocused

      • isInitialized

        public boolean isInitialized()

      • setParent

        public void setParent​(org.zkoss.zk.ui.Component parent)
        Specified by:
        setParent in interface org.zkoss.zk.ui.Component
        Overrides:
        setParent in class org.zkoss.zk.ui.AbstractComponent

      • detach

        public void detach()
        Specified by:
        detach in interface org.zkoss.zk.ui.Component
        Overrides:
        detach in class org.zkoss.zk.ui.AbstractComponent

      • cleanup

        protected void cleanup()