Package org.zkoss.zkmax.zul

Class Drawer

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl
    public class Drawer
extends org.zkoss.zul.impl.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

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Closes the drawer.
      java.lang.String getPosition()
      Returns the position of this drawer.
      java.lang.String getTitle()
      Returns the title of this drawer.
      java.lang.String getZclass()  
      boolean isAutodrop()
      Returns whether it is opened automatically when the mouse cursor is near the page edge.
      boolean isClosable()
      Returns whether it is closeable by user (a button).
      boolean isMask()
      Returns whether it is masked when opened.
      void open()
      Opens the drawer.
      protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)  
      void service​(org.zkoss.zk.au.AuRequest request, boolean everError)  
      void setAutodrop​(boolean autodrop)
      Sets whether it is opened automatically when the mouse cursor is near the page edge.
      void setClosable​(boolean closable)
      Sets whether it is closeable by user (a button).
      void setHflex​(java.lang.String flex)  
      void setMask​(boolean mask)
      Sets whether it is masked when opened.
      void setPosition​(java.lang.String position)
      Sets the position of this drawer.
      void setTitle​(java.lang.String title)
      Sets the title of this drawer.
      void setVflex​(java.lang.String flex)  

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

        clone, getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, 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, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setClientAction, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, 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, 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, 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 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 org.zkoss.zk.ui.WrongValueException
        Sets the position of this drawer. Valid values are "left", "right", "top" and "bottom".
        Parameters:
        position - the position of this drawer.
        Throws:
        org.zkoss.zk.ui.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?

      • renderProperties

        protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws java.io.IOException
        Overrides:
        renderProperties in class org.zkoss.zul.impl.XulElement
        Throws:
        java.io.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

      • getZclass

        public java.lang.String getZclass()
        Overrides:
        getZclass in class org.zkoss.zk.ui.HtmlBasedComponent

      • setHflex

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

      • setVflex

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

      • open

        public void open()
        Opens the drawer.

      • close

        public void close()
        Closes the drawer.