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

Interface CockpitComponent

All Superinterfaces:
Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zul.api.Div, org.zkoss.zk.ui.api.HtmlBasedComponent, org.zkoss.zk.ui.ext.Scope, Serializable, org.zkoss.zul.impl.api.XulElement
All Known Subinterfaces:
BrowserComponent, BrowserSectionComponent, SectionComponent
All Known Implementing Classes:
AbstractBrowserComponent, AbstractBrowserSectionComponent, AbstractCmsPageMainAreaBrowserComponent, AbstractCommentTreeContextComponent, AbstractContextBrowserComponent, AbstractMainAreaBrowserComponent, AbstractMultiViewToolbarBrowserComponent, AbstractSectionComponent, AbstractSectionMainAreaBrowserComponent, BundleNavigationNodeContentMainComponent, CaptionBrowserComponent, CMSContentEditorSectionComponent, CmsContentSlotListBrowserSectionComponent, CmsListBrowserSectionComponent, CmsPageBrowserSectionComponent, CmsPageToolbarBrowserComponent, CmsStructListBrowserSectionComponent, CommentMainAreaBrowserComponent, CompareMainAreaBrowserComponent, ContextAreaBrowserComponent, ContextAreaCommentTreeComponent, DefaultMultiViewToolbarComponent, DefaultSectionMainAreaBrowserComponent, EditorListSectionComponent, ListBrowserSectionComponent, ListSectionComponent, LiveEditContentBrowser.DefaultLiveEditCaptionComponent, LiveEditContentBrowser.DefaultLiveEditMainAreaComponent, MacFinderTreeComponent, MainAreaGridviewBrowserComponent, MainAreaListviewBrowserComponent, NavigationNodeContentMainComponent, PagerToolbarBrowserComponent, QueryCaptionBrowserComponent, ReportDashboardCaptionComponent, SearchToolbarBrowserComponent, TaskMainAreaBrowserComponent, WelcomeMainAreaBrowserComponent, WidgetDashboardToolbarComponent, WorkflowPagerToolbarBrowserComponent
public interface CockpitComponent extends org.zkoss.zul.api.Div
A CockpitComponent represents a view component in the Cockpit Framework.

  • Field Summary

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

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    initialize()
    Initializes this browser component i.e.
    void
    setActiveItem(TypedObject activeItem)
    Sets the active item of this browser component to activeItem.
    boolean
    update()
    Updates this browser component i.e.
    void
    updateActiveItems()
    Re-renders the currently active item(s).
    void
    updateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties)
    Re-renders the items specified.
    void
    updateSelectedItems()
    Re-renders the currently selected item(s).

    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

  • Method Details

    • initialize

      boolean initialize()
      Initializes this browser component i.e. creates all required components, adds event listeners etc.
      Returns:
      true if initialization was successful, false otherwise

    • update

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

    • updateItem

      void updateItem(TypedObject item, Set<PropertyDescriptor> modifiedProperties)
      Re-renders the items specified.
      Parameters:
      item - the item to be re-rendered
      modifiedProperties - modified properties

    • setActiveItem

      void setActiveItem(TypedObject activeItem)
      Sets the active item of this browser component to activeItem.
      Parameters:
      activeItem - the new active item

    • updateActiveItems

      void updateActiveItems()
      Re-renders the currently active item(s).

    • updateSelectedItems

      void updateSelectedItems()
      Re-renders the currently selected item(s).