Java Doc for UIBean.java in  » J2EE » webwork-2.2.6 » com » opensymphony » webwork » components » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » J2EE » webwork 2.2.6 » com.opensymphony.webwork.components 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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


Field Summary
protected  Stringaccesskey
    
protected  StringcssClass
    
protected  StringcssStyle
    
protected  Stringdisabled
    
protected  Stringlabel
    
protected  StringlabelPosition
    
protected  Stringname
    
protected  Stringonblur
    
protected  Stringonchange
    
protected  Stringonclick
    
protected  Stringondblclick
    
protected  Stringonfocus
    
protected  Stringonkeydown
    
protected  Stringonkeypress
    
protected  Stringonkeyup
    
protected  Stringonmousedown
    
protected  Stringonmousemove
    
protected  Stringonmouseout
    
protected  Stringonmouseover
    
protected  Stringonmouseup
    
protected  Stringonselect
    
protected  HttpServletRequestrequest
    
protected  Stringrequired
    
protected  Stringrequiredposition
    
protected  HttpServletResponseresponse
    
protected  Stringtabindex
    
protected  Stringtemplate
    
protected  StringtemplateDir
    
protected  StringtemplateSuffix
    
protected  Stringtheme
    
protected  Stringtitle
    
protected  Stringtooltip
    
protected  StringtooltipConfig
    
protected  Stringvalue
    

Constructor Summary
public  UIBean(OgnlValueStack stack, HttpServletRequest request, HttpServletResponse response)
    

Method Summary
public  voidaddFormParameter(String key, Object value)
    
protected  TemplatebuildTemplateName(String myTemplate, String myDefaultTemplate)
    
protected  voidenableAncestorFormCustomOnsubmit()
    
public  booleanend(Writer writer, String body)
    
protected  Stringescape(String name)
    
protected  voidevaluateExtraParams()
    
protected  booleanevaluateNameValue()
    
public  voidevaluateParams()
    
abstract protected  StringgetDefaultTemplate()
     A contract that requires each concrete UI Tag to specify which template should be used as a default.
public  StringgetTemplate()
    
public  StringgetTemplateDir()
    
public  StringgetTheme()
    
protected  MapgetTooltipConfig(UIBean component)
    
protected  ClassgetValueClassType()
    
protected  voidmergeTemplate(Writer writer, Template template)
    
protected  voidpopulateComponentHtmlId(Form form)
     Create HTML id element for the component and populate this component parmaeter map.
public  voidsetAccesskey(String accesskey)
    
public  voidsetCssClass(String cssClass)
    
public  voidsetCssStyle(String cssStyle)
    
public  voidsetDisabled(String disabled)
    
public  voidsetLabel(String label)
    
public  voidsetLabelPosition(String labelPosition)
     deprecated.
public  voidsetLabelposition(String labelPosition)
    
public  voidsetName(String name)
    
public  voidsetOnblur(String onblur)
    
public  voidsetOnchange(String onchange)
    
public  voidsetOnclick(String onclick)
    
public  voidsetOndblclick(String ondblclick)
    
public  voidsetOnfocus(String onfocus)
    
public  voidsetOnkeydown(String onkeydown)
    
public  voidsetOnkeypress(String onkeypress)
    
public  voidsetOnkeyup(String onkeyup)
    
public  voidsetOnmousedown(String onmousedown)
    
public  voidsetOnmousemove(String onmousemove)
    
public  voidsetOnmouseout(String onmouseout)
    
public  voidsetOnmouseover(String onmouseover)
    
public  voidsetOnmouseup(String onmouseup)
    
public  voidsetOnselect(String onselect)
    
public  voidsetRequired(String required)
    
public  voidsetRequiredposition(String requiredposition)
    
public  voidsetTabindex(String tabindex)
    
public  voidsetTemplate(String template)
    
public  voidsetTemplateDir(String templateDir)
     The template directory (other than default) to used to find the themes and hence the template.
public  voidsetTheme(String theme)
    
public  voidsetTitle(String title)
    
public  voidsetTooltip(String tooltip)
    
public  voidsetTooltipConfig(String tooltipConfig)
    
public  voidsetValue(String value)
     Preset the value of input element.

Field Detail
accesskey
protected String accesskey(Code)



cssClass
protected String cssClass(Code)



cssStyle
protected String cssStyle(Code)



disabled
protected String disabled(Code)



label
protected String label(Code)



labelPosition
protected String labelPosition(Code)



name
protected String name(Code)



onblur
protected String onblur(Code)



onchange
protected String onchange(Code)



onclick
protected String onclick(Code)



ondblclick
protected String ondblclick(Code)



onfocus
protected String onfocus(Code)



onkeydown
protected String onkeydown(Code)



onkeypress
protected String onkeypress(Code)



onkeyup
protected String onkeyup(Code)



onmousedown
protected String onmousedown(Code)



onmousemove
protected String onmousemove(Code)



onmouseout
protected String onmouseout(Code)



onmouseover
protected String onmouseover(Code)



onmouseup
protected String onmouseup(Code)



onselect
protected String onselect(Code)



request
protected HttpServletRequest request(Code)



required
protected String required(Code)



requiredposition
protected String requiredposition(Code)



response
protected HttpServletResponse response(Code)



tabindex
protected String tabindex(Code)



template
protected String template(Code)



templateDir
protected String templateDir(Code)



templateSuffix
protected String templateSuffix(Code)



theme
protected String theme(Code)



title
protected String title(Code)



tooltip
protected String tooltip(Code)



tooltipConfig
protected String tooltipConfig(Code)



value
protected String value(Code)




Constructor Detail
UIBean
public UIBean(OgnlValueStack stack, HttpServletRequest request, HttpServletResponse response)(Code)




Method Detail
addFormParameter
public void addFormParameter(String key, Object value)(Code)



buildTemplateName
protected Template buildTemplateName(String myTemplate, String myDefaultTemplate)(Code)



enableAncestorFormCustomOnsubmit
protected void enableAncestorFormCustomOnsubmit()(Code)



end
public boolean end(Writer writer, String body)(Code)



escape
protected String escape(String name)(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.



getTemplate
public String getTemplate()(Code)



getTemplateDir
public String getTemplateDir()(Code)



getTheme
public String getTheme()(Code)



getTooltipConfig
protected Map getTooltipConfig(UIBean component)(Code)



getValueClassType
protected Class getValueClassType()(Code)



mergeTemplate
protected void mergeTemplate(Writer writer, Template template) throws Exception(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 :-
  1. This component id attribute
  2. [containing_form_id]_[this_component_name]
  3. [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)
deprecated. UIBean.setLabelposition(String)



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.



Fields inherited from com.opensymphony.webwork.components.Component
final public static String COMPONENT_STACK(Code)(Java Doc)
protected String id(Code)(Java Doc)
protected Map parameters(Code)(Java Doc)
protected OgnlValueStack stack(Code)(Java Doc)

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)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.