ICEfaces-EE ACE Components
Tag dialog


The Dialog is a container component that can overlay other elements on page. Dialog has several customization options such as modal, resize, width, height, position. If position of dialog is out of place, try putting it as last child of body.

For more information, see the Dialog Wiki Documentation.


Client Events
NameDescriptionSupported classes for argument
closeFired when the panel is closed (default event).org.icefaces.ace.event.CloseEvent
Client events can be used with Client Behaviors and the ace:ajax tag.


Tag Information
Tag Classorg.icefaces.ace.component.dialog.DialogTag
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.
closablenotruebooleanBoolean value that specifies whether the dialog should have a close button in the header. Default = 'true'.
closeOnEscapenotruebooleanBoolean value that Specifies whether the dialog should close when it has focus and the user presses the escape (ESC) key. Default = 'true'.
dialogPositionnotruejava.lang.StringThe side of the dialog to position in relation to the target component. The format is " ". Possible horizontal values are "left", "right" and "center". Possible vertical values are "top", "center", and "bottom". Example: "left top" or "center center". Default = 'center'.
draggablenotruebooleanBoolean value whether to allow the user to drag the Panel using its header Default = 'true'.
headernotruejava.lang.StringHeader text
heightnotrueintHeight of the element in pixels. Default (not specified or value <= 0) is auto. If auto, resizable should be false, or resizing may hehave erratically. If auto, IE7 may not size or position properly. Default = 'Integer.MIN_VALUE'.
hideEffectnotruejava.lang.StringEffect to use when hiding the dialog. Possible values are 'blind', 'clip', 'drop', 'explode, 'fade', 'fold', 'puff', 'slide', 'scale', 'bounce', 'highlight', and 'shake' (Some effects are not supported in IE browsers, see wiki page for more information).
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
minHeightnotrueintMinimum height of resizable dialog Default = '0'.
minWidthnotrueintMinimum width of a resizable dialog Default = '150'.
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'.
onHidenotruejava.lang.StringJavascript code to be executed when hiding the dialog
onShownotruejava.lang.StringJavascript code to be executed when showing the dialog
positionnotruejava.lang.StringSpecifies where the dialog should be displayed relative to the viewport. Possible values: 1) a single string representing position within viewport: 'center', 'left', 'right', 'top', 'bottom'. 2) an array containing an x,y coordinate pair in pixel offset from left, top corner of viewport (e.g. [350,100]) 3) an array containing x,y position string values (e.g. ['right','top'] for top right corner).
relativePositionnotruejava.lang.StringThe side of the target component to position the dialog against. The format is " ". Possible horizontal values are "left", "right" and "center". Possible vertical values are "top", "center", and "bottom". Example: "left top" or "center center". Default = 'center'.
relativeTonotruejava.lang.StringId of the component to position the dialog against. Setting this id will override the 'position' attribute, using 'dialogPosition' and 'relativePosition' instead.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
resizablenotruebooleanMakes the dialog resizable. Should be false if width or height is auto, or resizing may hehave erratically. Default = 'true'.
setFocusnotruejava.lang.StringSpecifies the ID of the component contained within the dialog that should receive focus when the dialog is made visible. Note that this feature does not work with ACE components in this release (h: and ice: are supported).
showEffectnotruejava.lang.StringEffect to use when showing the dialog. Possible values are 'blind', 'clip', 'drop', 'explode, 'fade', 'fold', 'puff', 'slide', 'scale', 'bounce', 'highlight', 'pulsate', and 'shake' (Some effects are not supported in IE7, see wiki page for more information).
showHeadernotruebooleanBoolean value that specifies whether the dialog should have a header (default true) Default = 'true'.
styleClassnotruejava.lang.StringStyle class of the main container of dialog
visiblenotruebooleanvisible can be used to toggle visibility on the server, rendered should not be used that way, setting rendered=false on a visible modal dialog will not remove the modality layer, visible=false must be set first (or client-side JS function called) Default = 'false'.
widgetVarnotruejava.lang.StringName of the widget to access client side api
widthnotrueintWidth of the element in pixels. Default (not specified or value <= 0) is auto. If auto, resizable should be false, or resizing may hehave erratically. If auto, IE7 may not size or position properly. Default = 'Integer.MIN_VALUE'.
zindexnotrueintzindex 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.