Package org.adempiere.webui.adwindow

Class BreadCrumb

java.lang.Object
org.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zul.Div
org.adempiere.webui.adwindow.BreadCrumb
All Implemented Interfaces:
Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl
public class BreadCrumb extends org.zkoss.zul.Div implements org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>
Bread crumb component for AD Window.
Represent the hierarchical navigation path of a tab
Author:
hengsin
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, org.zkoss.zk.ui.AbstractComponent.ForwardInfo, org.zkoss.zk.ui.AbstractComponent.TargetInfo

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected Menupopup
    linkPopup
    popup for link to other tabs at same level

    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, AFTER_PARENT_CHANGED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

  • Constructor Summary

    Constructors
    Constructor
    Description
    BreadCrumb(AbstractADWindowContent windowContent, int windowNo)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addLinks(LinkedHashMap<String,String> links)
    Add links to other tabs at the same level
    void
    addPath(String label, String id, boolean clickable)
    Add path for tab
    void
    enableFirstNavigation(boolean enabled)
    Enable/disable first record and previous record toolbar button
    void
    enableLastNavigation(boolean enabled)
    Enable or disable the next record and last record toolbar button
    ToolBarButton
    getNextButton()
    Get next button component
    List<BreadCrumbLink>
    getParentLinks()
    Get parent BreadCrumbLinks
    ToolBarButton
    getPreviousButton()
    Get previous button component
    boolean
    hasParentLink()
    Are there one or more parent link
    boolean
    isEmpty()
     
    boolean
    isNextEnabled()
    Is next button enable
    boolean
    isPreviousEnabled()
    Is previous button enable
    void
    onEvent(org.zkoss.zk.ui.event.Event event)
     
    void
    onPageAttached(org.zkoss.zk.ui.Page newpage, org.zkoss.zk.ui.Page oldpage)
     
    void
    onPageDetached(org.zkoss.zk.ui.Page page)
     
    void
    reset()
    Remove all path and links
    void
    setNavigationToolbarVisibility(boolean visible)
    Set visibility of record navigation toolbar
    void
    setStatusDB(String text)
    Set record info text
    void
    setStatusDB(String text, DataStatusEvent dse, GridTab gridTab)
    Data status from AbstractADWindowContent.dataStatusChanged(DataStatusEvent)
    void
    setToolbarListener(ToolbarListener listener)
    Set toolbar listener

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

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

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

    addSclass, evalCSSFlex, focus, getAction, getClientAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, removeSclass, removeSclass, service, setAction, setClass, setClientAction, 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, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, destroyIndexCacheMap, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, disableHostChanged, enableBindingAnnotation, enableHostChanged, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, 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, getForwards, getId, getIndexCacheMap, getLastChild, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, initIndexCacheMap, insertBefore, invalidate, isChildable, isDisabledHostChanged, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onParentChanged, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, renderPropertiesOnly, 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, 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

  • Field Details

    • linkPopup

      protected Menupopup linkPopup
      popup for link to other tabs at same level

  • Constructor Details

    • BreadCrumb

      public BreadCrumb(AbstractADWindowContent windowContent, int windowNo)
      Parameters:
      windowContent -
      windowNo -

  • Method Details

    • setToolbarListener

      public void setToolbarListener(ToolbarListener listener)
      Set toolbar listener
      Parameters:
      listener -

    • addPath

      public void addPath(String label, String id, boolean clickable)
      Add path for tab
      Parameters:
      label - path label
      id - path id
      clickable - true to add clickable BreadCrumbLink, false to add text label

    • getParentLinks

      public List<BreadCrumbLink> getParentLinks()
      Get parent BreadCrumbLinks
      Returns:
      list of parent links

    • addLinks

      public void addLinks(LinkedHashMap<String,String> links)
      Add links to other tabs at the same level
      Parameters:
      links - Label:TabIndex map

    • onEvent

      public void onEvent(org.zkoss.zk.ui.event.Event event) throws Exception
      Specified by:
      onEvent in interface org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.Event>
      Throws:
      Exception

    • reset

      public void reset()
      Remove all path and links

    • enableFirstNavigation

      public void enableFirstNavigation(boolean enabled)
      Enable/disable first record and previous record toolbar button
      Parameters:
      enabled -

    • enableLastNavigation

      public void enableLastNavigation(boolean enabled)
      Enable or disable the next record and last record toolbar button
      Parameters:
      enabled -

    • setStatusDB

      public void setStatusDB(String text)
      Set record info text
      Parameters:
      text -

    • setStatusDB

      public void setStatusDB(String text, DataStatusEvent dse, GridTab gridTab)
      Data status from AbstractADWindowContent.dataStatusChanged(DataStatusEvent)
      Parameters:
      text - record info text (for e.g 1/1)
      dse -
      gridTab -

    • onPageDetached

      public void onPageDetached(org.zkoss.zk.ui.Page page)
      Specified by:
      onPageDetached in interface org.zkoss.zk.ui.sys.ComponentCtrl
      Overrides:
      onPageDetached in class org.zkoss.zk.ui.AbstractComponent

    • setNavigationToolbarVisibility

      public void setNavigationToolbarVisibility(boolean visible)
      Set visibility of record navigation toolbar
      Parameters:
      visible -

    • hasParentLink

      public boolean hasParentLink()
      Are there one or more parent link
      Returns:
      true if there are one or more parent link

    • onPageAttached

      public void onPageAttached(org.zkoss.zk.ui.Page newpage, org.zkoss.zk.ui.Page oldpage)
      Specified by:
      onPageAttached in interface org.zkoss.zk.ui.sys.ComponentCtrl
      Overrides:
      onPageAttached in class org.zkoss.zk.ui.AbstractComponent

    • isPreviousEnabled

      public boolean isPreviousEnabled()
      Is previous button enable
      Returns:
      true if previous button is enable

    • isNextEnabled

      public boolean isNextEnabled()
      Is next button enable
      Returns:
      true if next button is enable

    • getNextButton

      public ToolBarButton getNextButton()
      Get next button component
      Returns:
      next ToolBarButton

    • getPreviousButton

      public ToolBarButton getPreviousButton()
      Get previous button component
      Returns:
      previous ToolBarButton

    • isEmpty

      public boolean isEmpty()
      Returns:
      true if path/link is empty