Package org.zkoss.zkmax.zul

Class GoldenPanel

    • Constructor Detail

      • GoldenPanel

        public GoldenPanel()

      • GoldenPanel

        public GoldenPanel​(java.lang.String area)

    • Method Detail

      • onInitMatrix

        public void onInitMatrix()

      • getArea

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

      • setArea

        public void setArea​(java.lang.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

      • setHeight

        public void setHeight​(java.lang.String height)
        Not supported, use vflex instead.
        Overrides:
        setHeight in class HtmlBasedComponent

      • setVflexDirectly

        protected void setVflexDirectly​(java.lang.String flex)
        Description copied from class: HtmlBasedComponent
        Sets the vflex directly without sending back the result (smart update) to the client
        Overrides:
        setVflexDirectly in class HtmlBasedComponent

      • setVflex

        public void setVflex​(java.lang.String flex)
        Description copied from class: HtmlBasedComponent
        Sets vertical flexibility hint of this component.

        Number flex indicates how this component's container distributes remaining empty space among its children vertically. Flexible component grow and shrink to fit their given space. Flexible components with larger flex values will be made larger than components with lower flex values, at the ratio determined by all flexible components. The actual flex value is not relevant unless there are other flexible components within the same container. Once the default sizes of components in a container are calculated, the remaining space in the container is divided among the flexible components, according to their flex ratios.

        Specify a flex value of negative value, 0, or "false" has the same effect as leaving the flex attribute out entirely. Specify a flex value of "true" has the same effect as a flex value of 1.

        Special flex hint, "min", indicates that the minimum space shall be given to this flexible component to enclose all of its children components. That is, the flexible component grow and shrink to fit its children components.

        Overrides:
        setVflex in class HtmlBasedComponent
        Parameters:
        flex - the vertical flex hint.
        See Also:
        HtmlBasedComponent.setHflex(java.lang.String), HtmlBasedComponent.getVflex()

      • setHflexDirectly

        protected void setHflexDirectly​(java.lang.String flex)
        Description copied from class: HtmlBasedComponent
        Sets the hflex directly without sending back the result (smart update) to the client
        Overrides:
        setHflexDirectly in class HtmlBasedComponent

      • setHflex

        public void setHflex​(java.lang.String flex)
        Description copied from class: HtmlBasedComponent
        Sets horizontal flex hint of this component.

        Number flex indicates how this component's container distributes remaining empty space among its children horizontally. Flexible component grow and shrink to fit their given space. Flexible components with larger flex values will be made larger than components with lower flex values, at the ratio determined by all flexible components. The actual flex value is not relevant unless there are other flexible components within the same container. Once the default sizes of components in a container are calculated, the remaining space in the container is divided among the flexible components, according to their flex ratios.

        Specify a flex value of negative value, 0, or "false" has the same effect as leaving the flex attribute out entirely. Specify a flex value of "true" has the same effect as a flex value of 1.

        Special flex hint, "min", indicates that the minimum space shall be given to this flexible component to enclose all of its children components. That is, the flexible component grow and shrink to fit its children components.

        Overrides:
        setHflex in class HtmlBasedComponent
        Parameters:
        flex - horizontal flex hint of this component.
        See Also:
        HtmlBasedComponent.setVflex(java.lang.String), HtmlBasedComponent.getHflex()

      • getTitle

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

      • setTitle

        public void setTitle​(java.lang.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()

      • droppedToRoot

        protected void droppedToRoot​(java.lang.String region)

      • droppedTo

        protected void droppedTo​(GoldenPanel dropTarget,
                         java.lang.String region)

      • getLocation

        public java.util.Map<java.lang.String,​java.lang.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

      • getPropertyAccess

        public PropertyAccess getPropertyAccess​(java.lang.String prop)
        Description copied from interface: ComponentCtrl
        Returns the corresponding property access object from the given property name, if any.
        Specified by:
        getPropertyAccess in interface ComponentCtrl
        Overrides:
        getPropertyAccess in class XulElement
        Parameters:
        prop - the name of the property
        Returns:
        null it means not to support for the property name.