ICEfaces ACE Components
Tag drawerPanel


The DrawerPanel is a container component that can overlay other elements on the page, appearing from an edge of the page. The DrawerPanel has several customization options such as modal, width, position.

For more information, see the DrawerPanel Wiki Documentation.


Client Events
NameDescriptionSupported Classes for ArgumentDefault Event Scopes
openFired when the drawer panel is opened (default event).org.icefaces.ace.event.OpenEventexecute=@this render=@all
closeFired when the drawer panel is closed.org.icefaces.ace.event.CloseEventexecute=@this render=@all
Client events can be used with Client Behaviors and the ace:ajax tag.


Tag Information
Tag Classorg.icefaces.ace.component.drawerpanel.DrawerPanelTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
bindingnotruejavax.el.ValueExpressionUsing an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
closeOnEscapenotruebooleanBoolean value that specifies whether the drawer should be closed when it has focus and the user presses the escape (ESC) key. Default = 'true'.
closeOnOutsideClicknotruebooleanBoolean value that specifies whether the drawer should be closed when the user clicks (or touches) any part of the page outside the drawer. Default = 'true'.
containernotruejava.lang.StringSpecify the container whose edges the drawer will appear from. The default mode is the entire window, but it's possible to specify a client id of an element on the page to have the drawer. Default = 'window'.
effectnotruejava.lang.StringEffect to use when opening and closing the drawer. Possible values are 'drop', 'fade', and 'slide'. The default effect is 'slide'. Default = 'slide'.
headernotruejava.lang.StringText that will appear in the header of the drawer.
heightnotrueintHeight of the element in pixels. Default (not specified or value <= 0) is auto. If auto, IE7 may not size or position properly. This attribute only applies if the 'position' is 'top' or 'bottom'. Default = 'Integer.MIN_VALUE'.
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
modalnotruebooleanBoolean value that specifies whether the document should be shielded with a partially transparent mask to require the user to close the panel before being able to activate any elements in the document. Default = 'false'.
onClosenotruejava.lang.StringJavascript code to be executed when closing the drawer.
onOpennotruejava.lang.StringJavascript code to be executed when opening the drawer.
positionnotruejava.lang.StringSpecifies the side on which the drawer should be displayed. Possible values are 'left', 'right', 'top', and 'bottom'. Default = 'left'.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
setFocusnotruejava.lang.StringSpecifies the ID of the component that should receive focus when the drawer is opened.
showHandleClosenotruebooleanBoolean value that specifies whether to display a three-horizontal-bars icon inside the drawer to close it. This handle will appear at the upper left corner of the drawer, inside the drawer's header. Default = 'true'.
showHandleOpennotruebooleanBoolean value that specifies whether to display a three-horizontal-bars icon to open the drawer. This handle will appear at the upper left corner of the viewport if the 'position' is 'left' or 'top', at the uper right corner of the viewport if the 'position' is 'right', and at the lower left corner of the viewport if the 'position' is 'bottom'. This handle will only be displayed if the 'container' is set to 'window'. If a handle is desired when applying the drawer to a specific container, it has to be done manually; please consult the wiki page for this component for guidelines and sample markup. Default = 'true'.
showHeadernotruebooleanBoolean value that specifies whether the drawer should have a header (default true). If 'showHandleClose' is set to true, a header will be shown regardless of the value of this attribute. Default = 'true'.
stylenotruejava.lang.StringStyle to apply to the container element.
styleClassnotruejava.lang.StringStyle class of the main container of the drawer.
visiblenotruebooleanThis attribute can be used to toggle visibility on the server, rendered should not be used that way, setting rendered=false on a visible modal drawer will not remove the modality layer, visible=false must be set first (or client-side JS function called). Default = 'false'.
widthnotrueintWidth of the element in pixels. Default (not specified or value <= 0) is auto. If auto, IE7 may not size or position properly. This attribute only applies when the 'position' is 'left' or 'right'. Default = 'Integer.MIN_VALUE'.
zindexnotrueintz-index property to control overlapping with other elements. Default = '1000'.

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.