Java Doc for UIBean.java in  » Web-Framework » struts-2.0.11 » org » apache » struts2 » components » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Attribute	Theme	Data Types	Description
cssClass	simple	String	define html class attribute
cssStyle	simple	String	define html style attribute
title	simple	String	define html title attribute
disabled	simple	String	define html disabled attribute
label	xhtml	String	define label of form element
labelPosition	xhtml	String	define label position of form element (top/left), default to left
requiredposition	xhtml	String	define required label position of form element (left/right), default to right
name	simple	String	Form Element's field name mapping
required	xhtml	Boolean	add * to label (true to add false otherwise)
tabIndex	simple	String	define html tabindex attribute
value	simple	Object	define value of form element

Attribute	Theme	Data Types	Description
onclick	simple	String	html javascript onclick attribute
ondbclick	simple	String	html javascript ondbclick attribute
onmousedown	simple	String	html javascript onmousedown attribute
onmouseup	simple	String	html javascript onmouseup attribute
onmouseover	simple	String	html javascript onmouseover attribute
onmouseout	simple	String	html javascript onmouseout attribute
onfocus	simple	String	html javascript onfocus attribute
onblur	simple	String	html javascript onblur attribute
onkeypress	simple	String	html javascript onkeypress attribute
onkeyup	simple	String	html javascript onkeyup attribute
onkeydown	simple	String	html javascript onkeydown attribute
onselect	simple	String	html javascript onselect attribute
onchange	simple	String	html javascript onchange attribute

Attribute	Data Type	Default	Description
tooltip	String	none	Set the tooltip of this particular component
jsTooltipEnabled	String	false	Enable js tooltip rendering
tooltipIcon	String	/struts/static/tooltip/tooltip.gif	The url to the tooltip icon
tooltipDelay	String	500	Tooltip shows up after the specified timeout (miliseconds). A behavior similar to that of OS based tooltips.
key	simple	String	The name of the property this input field represents. This will auto populate the name, label, and value

Every Form UI component (in xhtml / css_xhtml or any others that extends of them) could have tooltip assigned to a them. The Form component's tooltip related attribute once defined will be applicable to all form UI component that is created under it unless explicitly overriden by having the Form UI component itself defined that tooltip attribute.

In Example 1, the textfield will inherit the tooltipDelay adn tooltipIcon attribte from its containing form. In other words, although it doesn't defined a tooltipAboveMousePointer attribute, it will have that attributes inherited from its containing form.

In Example 2, the the textfield will inherite both the tooltipDelay and tooltipIcon attribute from its containing form but tooltipDelay attribute is overriden at the textfield itself. Hence, the textfield actually will have tooltipIcon defined as /myImages/myIcon.gif, inherited from its containing form and tooltipDelay defined as 5000, due to overriden at the textfield itself.

Example 3, 4 and 5 shows different way of setting the tooltipConfig attribute.
Example 3:Set tooltip config through body of param tag
Example 4:Set tooltip config through value attribute of param tag
Example 5:Set tooltip config through tooltipConfig attribute of component tag

 
 <!-- Example 1: -->
 <s:form
 tooltipConfig="#{'tooltipDelay':'500',
 'tooltipIcon='/myImages/myIcon.gif'}" .... >
 ....
 <s:textfield label="Customer Name" tooltip="Enter the customer name" .... />
 ....
 </s:form>
 <!-- Example 2: -->
 <s:form
 tooltipConfig="#{'tooltipDelay':'500',
 'tooltipIcon':'/myImages/myIcon.gif'}" ... >
 ....
 <s:textfield label="Address"
 tooltip="Enter your address"
 tooltipConfig="#{'tooltipDelay':'5000'}" />
 ....
 </s:form>
 <-- Example 3: -->
 <s:textfield
 label="Customer Name"
 tooltip="One of our customer Details'">
 <s:param name="tooltipConfig">
 tooltipDelay = 500 |
 tooltipIcon = /myImages/myIcon.gif
 </s:param>
 </s:textfield>
 <-- Example 4: -->
 <s:textfield
 label="Customer Address"
 tooltip="Enter The Customer Address" >
 <s:param
 name="tooltipConfig"
 value="#{'tooltipDelay':'500',
 'tooltipIcon':'/myImages/myIcon.gif'}" />
 </s:textfield>
 <-- Example 5: -->
 <s:textfield
 label="Customer Telephone Number"
 tooltip="Enter customer Telephone Number"
 tooltipConfig="#{'tooltipDelay':'500',
 'tooltipIcon':'/myImages/myIcon.gif'}" />
 
 

1. This component id attribute
2. [containing_form_id]_[this_component_name]
3. [this_component_name]