Package org.zkoss.zkmax.zul

Class GoldenPanel

java.lang.Object
org.zkoss.zk.ui.AbstractComponent
org.zkoss.zk.ui.HtmlBasedComponent
org.zkoss.zul.impl.XulElement
org.zkoss.zkmax.zul.GoldenPanel
All Implemented Interfaces:
Serializable, Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl
public class GoldenPanel extends org.zkoss.zul.impl.XulElement
A GoldenPanel component. Which is the only child type for GoldenLayout.
Since:
8.6.0
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 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_CLONED, 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
    GoldenPanel()
     
    GoldenPanel(String area)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    beforeParentChanged(org.zkoss.zk.ui.Component parent)
     
    protected void
    droppedTo(GoldenPanel dropTarget, String region)
     
    protected void
    droppedToRoot(String region)
     
    boolean
    evalCSSFlex()
     
    String
    getArea()
     
    Map<String,Integer>
    getLocation()
    Returns the location x0, x1, y0, y1 in the GoldenLayout areas layout matrix of this GoldenPanel.
    org.zkoss.zk.ui.sys.PropertyAccess
    getPropertyAccess(String prop)
     
    String
    getTitle()
    Returns the title on the tab of the GoldenPanel.
    boolean
    isClosable()
    Returns whether this panel is closable.
    boolean
    isDraggable()
    Returns whether the GoldenPanel should be draggable.
    boolean
    isDroppable()
    Returns whether the stack of this GoldenPanel is droppable by other GoldenPanel.
    void
    onClose()
     
    void
    onInitMatrix()
     
    protected void
    renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer)
     
    void
    service(org.zkoss.zk.au.AuRequest request, boolean everError)
     
    void
    setArea(String area)
    Sets the area of this GoldenPanel, use to represent the area of this panel on initial rendering.
    void
    setClosable(boolean closable)
    Sets whether this panel is closable.
    void
    setDraggable(boolean draggable)
    Sets whether the GoldenPanel should be draggable or not.
    void
    setDroppable(boolean droppable)
    Sets whether the whole stack of this GoldenPanel is droppable by other GoldenPanel.
    void
    setHeight(String height)
    Not supported, use vflex instead.
    void
    setHflex(String flex)
     
    protected void
    setHflexDirectly(String flex)
     
    void
    setTitle(String title)
    Sets the title to the tab of the GoldenPanel.
    void
    setVflex(String flex)
     
    protected void
    setVflexDirectly(String flex)
     
    void
    setWidth(String width)
    Not supported, use hflex instead.

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

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

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

    addSclass, focus, getAction, getClientAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getSkeleton, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setClientAction, setDraggable, setDroppable, setFocus, setHeight0, setHeightDirectly, setHflex0, setLeft, setLeftDirectly, setRenderdefer, setSclass, setSkeleton, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex0, 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, 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, getStubonlyDescendants, 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, onPageAttached, onPageDetached, 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, setStubonlyDescendants, 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

  • Constructor Details

    • GoldenPanel

      public GoldenPanel()

    • GoldenPanel

      public GoldenPanel(String area)

  • Method Details

    • onInitMatrix

      public void onInitMatrix()

    • getArea

      public String getArea()
      Returns:
      the area of this GoldenPanel.

    • setArea

      public void setArea(String area)
      Sets the area of this GoldenPanel, use to represent the area of this panel on initial rendering. Note that the area is not changeable after specified. And it doesn't remain the same due to user's action.
      Parameters:
      area - of this GoldenPanel

    • setWidth

      public void setWidth(String width)
      Not supported, use hflex instead.
      Overrides:
      setWidth in class org.zkoss.zk.ui.HtmlBasedComponent

    • setHeight

      public void setHeight(String height)
      Not supported, use vflex instead.
      Overrides:
      setHeight in class org.zkoss.zk.ui.HtmlBasedComponent

    • setVflexDirectly

      protected void setVflexDirectly(String flex)
      Overrides:
      setVflexDirectly in class org.zkoss.zk.ui.HtmlBasedComponent

    • setVflex

      public void setVflex(String flex)
      Overrides:
      setVflex in class org.zkoss.zk.ui.HtmlBasedComponent

    • setHflexDirectly

      protected void setHflexDirectly(String flex)
      Overrides:
      setHflexDirectly in class org.zkoss.zk.ui.HtmlBasedComponent

    • setHflex

      public void setHflex(String flex)
      Overrides:
      setHflex in class org.zkoss.zk.ui.HtmlBasedComponent

    • getTitle

      public String getTitle()
      Returns the title on the tab of the GoldenPanel.
      Returns:
      the title

    • setTitle

      public void setTitle(String title)
      Sets the title to the tab of the GoldenPanel.
      Parameters:
      title -

    • isDraggable

      public boolean isDraggable()
      Returns whether the GoldenPanel should be draggable.

      Note that this method overwrites the normal action of zk isDraggable. Draggable true doesn't performs the normal zk draggable action, but only the GoldenPanel tabs are draggable.

      Returns:
      draggable or not

    • setDraggable

      public void setDraggable(boolean draggable)
      Sets whether the GoldenPanel should be draggable or not.

      Note that this method overwrites the normal action of zk setDraggable. Setting true doesn't performs the normal zk draggable action, but only the GoldenPanel tabs are draggable.

      Parameters:
      draggable -

    • isDroppable

      public boolean isDroppable()
      Returns whether the stack of this GoldenPanel is droppable by other GoldenPanel.
      Returns:
      droppable or not

    • setDroppable

      public void setDroppable(boolean droppable)
      Sets whether the whole stack of this GoldenPanel is droppable by other GoldenPanel.
      Parameters:
      droppable -

    • isClosable

      public boolean isClosable()
      Returns whether this panel is closable.
      Returns:
      closable or not

    • setClosable

      public void setClosable(boolean closable)
      Sets whether this panel is closable.
      Parameters:
      closable -

    • onClose

      public void onClose()

    • beforeParentChanged

      public void beforeParentChanged(org.zkoss.zk.ui.Component parent)
      Specified by:
      beforeParentChanged in interface org.zkoss.zk.ui.sys.ComponentCtrl
      Overrides:
      beforeParentChanged in class org.zkoss.zk.ui.AbstractComponent

    • droppedToRoot

      protected void droppedToRoot(String region)

    • droppedTo

      protected void droppedTo(GoldenPanel dropTarget, String region)

    • getLocation

      public Map<String,Integer> getLocation()
      Returns the location x0, x1, y0, y1 in the GoldenLayout areas layout matrix of this GoldenPanel.
      Returns:
      the location x0, x1, y0, y1

    • renderProperties

      protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer) throws IOException
      Overrides:
      renderProperties in class org.zkoss.zul.impl.XulElement
      Throws:
      IOException

    • service

      public void service(org.zkoss.zk.au.AuRequest request, boolean everError)
      Specified by:
      service in interface org.zkoss.zk.ui.sys.ComponentCtrl
      Overrides:
      service in class org.zkoss.zk.ui.HtmlBasedComponent

    • getPropertyAccess

      public org.zkoss.zk.ui.sys.PropertyAccess getPropertyAccess(String prop)
      Specified by:
      getPropertyAccess in interface org.zkoss.zk.ui.sys.ComponentCtrl
      Overrides:
      getPropertyAccess in class org.zkoss.zul.impl.XulElement

    • evalCSSFlex

      public boolean evalCSSFlex()
      Overrides:
      evalCSSFlex in class org.zkoss.zk.ui.HtmlBasedComponent