Package org.zkoss.zkmax.zul

Class Drawer

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, Component, Scope, ComponentCtrl
    public class Drawer
extends XulElement
    A drawer.

    Available in ZK EE.

    Only support browsers that support Flex and CSS Transitions. (IE10+, Edge, Chrome, Firefox, Safari)

    Since:
    9.0.0
    Author:
    rudyhuang
    See Also:
    Serialized Form

    • Constructor Detail

      • Drawer

        public Drawer()

    • Method Detail

      • getTitle

        public java.lang.String getTitle()
        Returns the title of this drawer. null means no title.

        Default: null.

      • setTitle

        public void setTitle​(java.lang.String title)
        Sets the title of this drawer. null means no title.
        Parameters:
        title - the title.

      • getPosition

        public java.lang.String getPosition()
        Returns the position of this drawer. Valid values are "left", "right", "top" and "bottom".

        Default: right.

      • setPosition

        public void setPosition​(java.lang.String position)
                 throws WrongValueException
        Sets the position of this drawer. Valid values are "left", "right", "top" and "bottom".
        Parameters:
        position - the position of this drawer.
        Throws:
        WrongValueException - if value is not valid.

      • isMask

        public boolean isMask()
        Returns whether it is masked when opened.

        Default: true.

      • setMask

        public void setMask​(boolean mask)
        Sets whether it is masked when opened.
        Parameters:
        mask - mask enabled?

      • isClosable

        public boolean isClosable()
        Returns whether it is closeable by user (a button).

        Default: false.

      • setClosable

        public void setClosable​(boolean closable)
        Sets whether it is closeable by user (a button).
        Parameters:
        closable - closable enabled?

      • isAutodrop

        public boolean isAutodrop()
        Returns whether it is opened automatically when the mouse cursor is near the page edge.

        Default: false.

      • setAutodrop

        public void setAutodrop​(boolean autodrop)
        Sets whether it is opened automatically when the mouse cursor is near the page edge.
        Parameters:
        autodrop - autodrop enabled?

      • 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()

      • 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()

      • open

        public void open()
        Opens the drawer.

      • close

        public void close()
        Closes the drawer.