box (Tag Library Documentation Generator - Generated Documentation)

Overview

Library

Tag

Help

FRAMES NO FRAMES

v
Tag box

The Box Component is a container.

It can have a graphical representation or not; But it is mainly used to apply a collective treatment to a set of component, for example show or hide a group of component.

The Box Component has the following capabilities :

Position & Size
Foreground & Background Color
Margin
Help
Visibility
Background Image
Border
Events Handling
Contextual Menu
Async Render (AJAX)

Tag Information
Tag Class	org.rcfaces.core.internal.taglib.BoxTag
TagExtraInfo Class	org.rcfaces.core.internal.taglib.CameliaTagExtraInfo
Body Content	JSP
Display Name	None

Attributes
Name	Required	Request-time	Type	Description
id	false	true	`java.lang.String`	A string specifying the identifier for this component. This value must be unique within the closest parent component that is a naming container.
binding	false	false	`javax.el.ValueExpression` (must evaluate to `javax.faces.component.UIComponent`)	The value binding expression linking this component to a property in a backing bean.
rendered	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	A boolean value indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit.
unlockedClientAttributeNames	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value holding a comma separated list of the client modifiable properties.
propertyChangeListener	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Executed when a component's property is changed (by javascript). A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
userEventListener	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Executed when the component is called. A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
errorListener	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	No Description
waiRole	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	No Description
x	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value (as specified by CSS) for the x position of the component.
y	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value (as specified by CSS) for the x position of the component.
width	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value (as specified by CSS) for the width of the component.
height	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value (as specified by CSS) for the height of the component.
marginBottom	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value specifying the margin size for the component's bottom (compliant to CSS margin-bottom).
marginLeft	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value specifying the margin size for the component's left (compliant to CSS margin-left).
marginRight	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value specifying the margin size for the component's right (compliant to CSS margin-right).
marginTop	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value specifying the margin size for the component's top (compliant to CSS margin-top).
helpMessage	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value specifying the message to be shown by a helpMessageZone Component.
helpURL	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	An URL that points to a help page for the component. it is used for example by a helpButton Component.
toolTipText	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value specifying the tooltip for the component (shown when the pointe hover the component).
backgroundColor	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A color value (as specified by CSS) for the background.
foregroundColor	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A color value (as specified by CSS) for the text.
visible	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	A boolean value indicating wether the composant is visible.
hiddenMode	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value specifying the management of invisible state on the client. Authorized values are : server : if not visible, nothing is sent to the client phantom : if not visible, the data is sent to the client and the page estate is reserved for a futur eventual display of the component ignore : if not visible, the data is sent to the client but no page estate is reserved
lookId	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value specifying the choosen look of the component.
styleClass	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A space-separated list of CSS style class(es) to be applied to the component. This value will be passed through as the "class" attribute on generated markup.
margins	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value specifying the margins for the component (compliant to CSS margin).
backgroundImageHorizontalPosition	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string indicating the horizontal positionning for the background image.
backgroundImageHorizontalRepeat	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	A boolean value indicating wether the background image should be repeated horizontally or not.
backgroundImageURL	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	An url string pointing to the background image.
backgroundImageVerticalPosition	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string indicating the vertical positionning for the background image.
backgroundImageVerticalRepeat	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	A boolean value indicating wether the background image should be repeated vertically or not.
border	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	A boolean value that indicates if the component should show a border or not.
mouseOutListener	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Executed when the pointer leaves the area of the component. A string that represent a javascript expression to evaluate.
mouseOverListener	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Executed when the pointer hover the component's area. A string that represent a javascript expression to evaluate.
initListener	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Executed when the component is intialized. A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
loadListener	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Executed when the component is fully loaded (similar to init for AJAX). A string that represent a javascript expression to evaluate and eventually a server action to execute. the two parts are separated by a semi-column. If the javascript evaluation return false (by using the return keyword) the server action is not executed. The server action is represented by a binding.
asyncRenderMode	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string that indicates the rendering mode for asynchronous capable component. If value is "none", the rendering is synchronous (made with the englobing page rendering). If value is "buffer", the rendering is calculated with the page and may contains HTML elements, it is sent to the client only when needed (asynchrponously). If value is "tree", the rendering is calculated only when needed (the HTML elements are ignored)
asyncDecodeMode	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	No Description
scopeSaveValue	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	No Description
scopeValue	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.Object`)	A string value specifying the binding associated to a variable representing a shortcut. (cf. scopeVar) ex: if scopeVar "bat" is associated to scopeValue "bean.attribute1.attribute2" then the use of "bat.attribute3" will be equivalente to "bean.attribute1.attribute2.attribute3"
scopeVar	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value specifying the name of a variable representing a shortcut to a binding. (cf. scopeValue) ex: if scopeVar "bat" is associated to scopeValue "bean.attribute1.attribute2" then the use of "bat.attribute3" will be equivalente to "bean.attribute1.attribute2.attribute3"
type	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	A string value specifying the type of data (Java) to convert to or from.
overStyleClass	false	false	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	No Description
horizontalScroll	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	A boolean value indicating wether the horizontal scroll is shown.
verticalScroll	false	false	`javax.el.ValueExpression` (must evaluate to `boolean`)	A boolean value indicating wether the vertical scroll is shown.

Variables
No Variables Defined.

Overview

Library

Tag

Help

FRAMES NO FRAMES

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.

v Tag box

v
Tag box