| java.lang.Object com.opensymphony.webwork.components.Component com.opensymphony.webwork.components.UIBean
All known Subclasses: com.opensymphony.webwork.components.TextArea, com.opensymphony.webwork.components.Debug, com.opensymphony.webwork.components.Head, com.opensymphony.webwork.components.TextField, com.opensymphony.webwork.components.ActionMessage, com.opensymphony.webwork.components.ListUIBean, com.opensymphony.webwork.components.ActionError, com.opensymphony.webwork.components.FieldError, com.opensymphony.webwork.components.GenericUIBean, com.opensymphony.webwork.components.RichTextEditor, com.opensymphony.webwork.components.Checkbox, com.opensymphony.webwork.components.File, com.opensymphony.webwork.components.Token, com.opensymphony.webwork.components.Label, com.opensymphony.webwork.components.FormButton, com.opensymphony.webwork.components.Hidden, com.opensymphony.webwork.components.ClosingUIBean,
UIBean | abstract public class UIBean extends Component (Code) | | UIBean is the standard superclass of all webwork UI componentns.
It defines common webwork and html properties all UI components should present for usage.
Attribute |
Theme |
Data Types |
Description |
templateDir |
n/a |
String |
define the template directory |
theme |
n/a |
String |
define the theme name |
template |
n/a |
String |
define the template name |
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 |
tooltipIcon |
String |
/webwork/static/tooltip/tooltip.gif |
The url to the tooltip icon |
tooltipAboveMousePointer |
Boolean |
false |
Places the tooltip above the mousepointer. Additionally applied the tooltipOffseY allows to set the vertical distance from the mousepointer. |
tooltipBgColor |
String |
#e6ecff |
Background color of the tooltip. |
tooltipBgImg |
String |
none |
Background image. |
tooltipBorderWidth |
String |
1 |
Width of tooltip border. |
tooltipBorderColor |
String |
#003399 |
Background color of the tooltip |
tooltipDelay |
String |
500 |
Tooltip shows up after the specified timeout (miliseconds). A behavior similar to that of OS based tooltips. |
tooltipFixCoordinateX |
String |
not specified |
Fixes the tooltip to the X co-ordinates specified. Useful for example if combined with tooltipSticky attribute. |
tooltipFixCoordinateY |
String |
not specified |
Fixes the tooltip to the Y co-ordinates specified. Useful for example if combined with tooltipSticky attribute. |
tooltipFontColor |
String |
#000066 |
Font color. |
tooltipFontFace |
String |
arial,helvetica,sans-serif |
Font face/family eg. verdana,geneva,sans-serif |
tooltipFontSize |
String |
11px |
Font size + unit eg. 30px |
tooltipFontWeight |
String |
normal |
Font weight. either normal or bold |
tooltipLeftOfMousePointer |
Boolean |
false |
Tooltip positioned on the left side of the mousepointer |
tooltipOffsetX |
String |
12 |
Horizontal offset from mouse-pointer. |
tooltipOffsetY |
String |
15 |
Vertical offset from mouse-pointer. |
tooltipOpacity |
String |
100 |
Transparency of tooltip. Opacity is the opposite of transparency. Value must be a number between 0 (fully transparent) and 100 (opaque, no transparency). Not (yet) supported by Opera. |
tooltipPadding |
String |
3 |
Inner spacing, ie. the spacing between border and content, for instance text or image(s) |
tooltipShadowColor |
String |
#cccccc |
Creates shadow with the specified color. |
tooltipShadowWidth |
String |
5 |
Creates shodow with the specified width (offset). |
tooltipStatic |
Boolean |
false |
Like OS-based tooltips, the tooltip doesn't follow the movements of the mouse pointer. |
tooltipSticky |
Boolean |
false |
The tooltip stays fixed on its inital position until anohter tooltip is activated, or the user clicks on the document. |
tooltipStayAppearTime |
String |
0 |
Specifies a time span in miliseconds after which the tooltip disappears, even if the mousepointer is still on the concerned HTML element, with value <=0 it acts as if no time span is defined |
tooltipTextAlign |
String |
left |
Aligns the text of both the title and the body of the tooltip. Either right, left or justify |
tooltipTitle |
String |
none |
title |
tooltipTitleColor |
String |
#ffffff |
Color of the title text |
tooltipWidth |
String |
300 |
Width of tooltip |
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 tooltipAboveMousePointer attribte from
its containing form. In other words, although it doesn't defined a tooltipAboveMousePointer
attribute, it will have that attribute defined as true inherited from its containing form.
In Example 2, the the textfield will inherite both the tooltipAboveMousePointer and
tooltipLeftOfMousePointer attribute from its containing form but tooltipLeftOfMousePointer
attribute is overriden at the textfield itself. Hence, the textfield actually will
have tooltipAboveMousePointer defined as true, inherited from its containing form and
tooltipLeftOfMousePointer defined as false, 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: -->
<ww:form
tooltipConfig="#{'tooltipAboveMousePointer':'true',
'tooltipBgColor='#eeeeee'}" .... >
....
<ww:textfield label="Customer Name" tooltip="Enter the customer name" .... />
....
</ww:form>
<!-- Example 2: -->
<ww:form
tooltipConfig="#{'tooltipAboveMousePointer':'true',
'tooltipLeftOfMousePointer':'true'}" ... >
....
<ww:textfield label="Address"
tooltip="Enter your address"
tooltipConfig="#{'tooltipLeftOfMousePointer':'false'}" />
....
</ww:form>
<-- Example 3: -->
<ww:textfield
label="Customer Name"
tooltip="One of our customer Details'">
<ww:param name="tooltipConfig">
tooltipWidth = 150 |
tooltipAboveMousePointer = false |
tooltipLeftOfMousePointer = false
</ww:param>
</ww:textfield>
<-- Example 4: -->
<ww:textfield
label="Customer Address"
tooltip="Enter The Customer Address" >
<ww:param
name="tooltipConfig"
value="#{'tooltipStatic':'true',
'tooltipSticky':'true',
'tooltipAboveMousePointer':'false',
'tooltipLeftOfMousePointer':'false'}" />
</ww:textfield>
<-- Example 5: -->
<ww:textfield
label="Customer Telephone Number"
tooltip="Enter customer Telephone Number"
tooltipConfig="#{'tooltipBgColor':'#cccccc',
'tooltipFontColor':'#eeeeee',
'tooltipAboveMousePointer':'false',
'tooltipLeftOfMousePointer':'false'}" /<
author: Patrick Lightbody author: Rene Gielen author: Rainer Hermanns author: tm_jee version: $Revision: 2929 $ since: 2.2 |
enableAncestorFormCustomOnsubmit | protected void enableAncestorFormCustomOnsubmit()(Code) | | |
evaluateExtraParams | protected void evaluateExtraParams()(Code) | | |
evaluateNameValue | protected boolean evaluateNameValue()(Code) | | |
evaluateParams | public void evaluateParams()(Code) | | |
getDefaultTemplate | abstract protected String getDefaultTemplate()(Code) | | A contract that requires each concrete UI Tag to specify which template should be used as a default. For
example, the CheckboxTab might return "checkbox.vm" while the RadioTag might return "radio.vm". This value
not begin with a '/' unless you intend to make the path absolute rather than relative to the
current theme.
The name of the template to be used as the default. |
getValueClassType | protected Class getValueClassType()(Code) | | |
populateComponentHtmlId | protected void populateComponentHtmlId(Form form)(Code) | | Create HTML id element for the component and populate this component parmaeter
map.
The order is as follows :-
- This component id attribute
- [containing_form_id]_[this_component_name]
- [this_component_name]
Parameters: form - |
setAccesskey | public void setAccesskey(String accesskey)(Code) | | Set the html accesskey attribute on rendered html ekement
|
setCssClass | public void setCssClass(String cssClass)(Code) | | The css class to use for element
|
setCssStyle | public void setCssStyle(String cssStyle)(Code) | | The css style definitions for element ro use
|
setDisabled | public void setDisabled(String disabled)(Code) | | Set the html disabled attribute on rendered html element
|
setLabel | public void setLabel(String label)(Code) | | Label expression used for rendering a element specific label
|
setLabelposition | public void setLabelposition(String labelPosition)(Code) | | define label position of form element (top/left)
|
setName | public void setName(String name)(Code) | | The name to set for element
|
setOnblur | public void setOnblur(String onblur)(Code) | | Set the html onblur attribute on rendered html element
|
setOnchange | public void setOnchange(String onchange)(Code) | | Set the html onchange attribute on rendered html element
|
setOnclick | public void setOnclick(String onclick)(Code) | | Set the html onclick attribute on rendered html element
|
setOndblclick | public void setOndblclick(String ondblclick)(Code) | | Set the html ondblclick attribute on rendered html element
|
setOnfocus | public void setOnfocus(String onfocus)(Code) | | Set the html onfocus attribute on rendered html element
|
setOnkeydown | public void setOnkeydown(String onkeydown)(Code) | | Set the html onkeydown attribute on rendered html element
|
setOnkeypress | public void setOnkeypress(String onkeypress)(Code) | | Set the html onkeypress attribute on rendered html element
|
setOnkeyup | public void setOnkeyup(String onkeyup)(Code) | | Set the html onkeyup attribute on rendered html element
|
setOnmousedown | public void setOnmousedown(String onmousedown)(Code) | | Set the html onmousedown attribute on rendered html element
|
setOnmousemove | public void setOnmousemove(String onmousemove)(Code) | | Set the html onmousemove attribute on rendered html element
|
setOnmouseout | public void setOnmouseout(String onmouseout)(Code) | | Set the html onmouseout attribute on rendered html element
|
setOnmouseover | public void setOnmouseover(String onmouseover)(Code) | | Set the html onmouseover attribute on rendered html element
|
setOnmouseup | public void setOnmouseup(String onmouseup)(Code) | | Set the html onmouseup attribute on rendered html element
|
setOnselect | public void setOnselect(String onselect)(Code) | | Set the html onselect attribute on rendered html element
|
setRequired | public void setRequired(String required)(Code) | | If set to true, the rendered element will indicate that input is required
|
setRequiredposition | public void setRequiredposition(String requiredposition)(Code) | | define required position of required form element (left|right)
|
setTabindex | public void setTabindex(String tabindex)(Code) | | Set the html tabindex attribute on rendered html element
|
setTemplate | public void setTemplate(String template)(Code) | | The template (other than default) to use for rendering the element
|
setTemplateDir | public void setTemplateDir(String templateDir)(Code) | | The template directory (other than default) to used to find the themes and hence the template.
|
setTheme | public void setTheme(String theme)(Code) | | The theme (other than default) to use for rendering the element
|
setTitle | public void setTitle(String title)(Code) | | Set the html title attribute on rendered html element
|
setTooltip | public void setTooltip(String tooltip)(Code) | | Set the tooltip of this particular component
|
setTooltipConfig | public void setTooltipConfig(String tooltipConfig)(Code) | | Set the tooltip configuration
|
setValue | public void setValue(String value)(Code) | | Preset the value of input element.
|
Methods inherited from com.opensymphony.webwork.components.Component | public void addAllParameters(Map params)(Code)(Java Doc) public void addParameter(String key, Object value)(Code)(Java Doc) public boolean altSyntax()(Code)(Java Doc) public void copyParams(Map params)(Code)(Java Doc) protected String determineActionURL(String action, String namespace, String method, HttpServletRequest req, HttpServletResponse res, Map parameters, String scheme, boolean includeContext, boolean encodeResult, boolean escapeXml)(Code)(Java Doc) protected String determineNamespace(String namespace, OgnlValueStack stack, HttpServletRequest req)(Code)(Java Doc) public boolean end(Writer writer, String body)(Code)(Java Doc) protected boolean end(Writer writer, String body, boolean popComponentStack)(Code)(Java Doc) protected WebWorkException fieldError(String field, String errorMsg, Exception e)(Code)(Java Doc) protected Component findAncestor(Class clazz)(Code)(Java Doc) protected String findString(String expr)(Code)(Java Doc) protected String findString(String expr, String field, String errorMsg)(Code)(Java Doc) protected Object findValue(String expr)(Code)(Java Doc) protected Object findValue(String expr, String field, String errorMsg)(Code)(Java Doc) protected Object findValue(String expr, Class toType)(Code)(Java Doc) public Stack getComponentStack()(Code)(Java Doc) public String getId()(Code)(Java Doc) public Map getParameters()(Code)(Java Doc) public OgnlValueStack getStack()(Code)(Java Doc) protected void popComponentStack()(Code)(Java Doc) public void setId(String id)(Code)(Java Doc) public boolean start(Writer writer)(Code)(Java Doc) protected String toString(Throwable t)(Code)(Java Doc) public boolean usesBody()(Code)(Java Doc)
|
|
|