Java Doc for PropertyBase.java in  » IDE-Netbeans » visualweb.api.designer » com » sun » rave » web » ui » component » 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 » IDE Netbeans » visualweb.api.designer » com.sun.rave.web.ui.component 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.sun.rave.web.ui.component.PropertyBase

All known Subclasses:   com.sun.rave.web.ui.component.Property,
PropertyBase
abstract public class PropertyBase extends javax.faces.component.UIComponentBase (Code)

HTML Elements and Layout

The Property component was written to be used within the PropertySheetSection component, which is in turn used within the context of a PropertySheet component. The Property component allows you to encapsulate a logic "property" and help you lay it out on the page. A "property" has a number of configuration options, including: the property content; an optional label; the ability to stretch the property to include the label area (in addition to the content area of the "property"; the ability to mark a property required; and the ability to associate help text with the property to inform your end user how to interact with the property.

Help text can be provided for each property by supplying the helpText attribute. This attribute may be a literal String or a ValueBinding expression. The help text will appear below the content of the "property". Optionally, the helpText may also be provided as a facet named "helpText". This allows advanced users to have more control over the types of content provided in the helpText area.

The label may be provided via the label attribute. The label will be rendered to the left of the content area of the "property". The label area will not exist if the overlapLabel attribute is set to true. Optionally advanced users may provide a label facet named "label". This allows developers to have more control over the content of the label area.

The labelAlign attribute can use used to specify "left" or "right" alignment of the label table cell.

Setting the noWrap attribute to true specifies that the label should not be wraped to a new line.

The overlapLabel attribute causes the content of the property to be stretched into the label area as well as the content area. This may be useful for titles which should span the entire width, or other cases where you need the whole width of the PropertySheet.

Client Side Javascript Functions

None.

Examples

Example 1

The label is specified via the label attribute. The components of the content area are specified as children of the ui:property tag.

 
 <ui:property id="prop1" label="Log file name: ">           
 <ui:textField id="logfile" required="true"/>
 <h:message id="logfile_error" for="logfile" showDetail="true"/> 
 </ui:property>
 

Example 2

The components of the content area are specified as children of the ui:property tag. The label is specified via a label facet, to label the dropDown in the content area.

            
 <ui:property id="prop2">    
 <f:facet name="label">
 <ui:label id="prop2label" 
 text="Select update frequency"
 for="unit"/>
 </f:facet>   
 <ui:textField id="frequency" 
 text="#{Logger.frequency.number}"
 label="Every "/>
 <ui:dropDown id="unit" 
 selected="#{Logger.frequency.unit}"  
 items="#{Logger.frequency.units}"  
 required="true"/>
 <h:message id="msg1"_msg4b" for="frequency" showDetail="true"/> 
 <h:message id="msg2" for="unit" showDetail="true"/> 
 </ui:property>
 

Example 3

The components of the content area are specified inside a PanelGroup child component.

 
 <ui:property id="prop3" label="Admin Server URI"> 
 <ui:panelGroup id="pg">
 <ui:textField id="uri" text="#{Server.uri}" required="true"/>
 <h:message id="msg3" for="uri" showDetail="true"/> 
 </ui:panelGroup>                               
 </ui:property>
 

Example 4

The components of the content area are specified inside a PanelGroup inside a facet.

 
 <ui:property id="prop3" label="Admin Server URI"> 
 <f:facet name="content">
 <ui:panelGroup id="pg">
 <ui:textField id="uri" text="#{Server.uri}" required="true"/>
 <h:message id="msg3" for="uri" showDetail="true"/> 
 </ui:panelGroup>                               
 </f:facet>                       
 </ui:property>
 

Auto-generated component class. Do NOT modify; all changes will be lost!




Constructor Summary
public  PropertyBase()
    

Method Summary
public  StringgetFamily()
    

Return the identifier of the component family to which this component belongs.

public  StringgetHelpText()
    

The help text will appear below the content of the "property". Optionally, the helpText may also be provided as a facet named "helpText".

public  StringgetLabel()
    

Use this attribute to specify the text of the label of this property.

public  StringgetLabelAlign()
    

Specifies the label alignment for the label of this component.

public  StringgetStyle()
    
public  StringgetStyleClass()
    
public  booleanisDisabled()
    
public  booleanisNoWrap()
    

Specifies if the label component should not wrap.

public  booleanisOverlapLabel()
    

This indicates whether the property should overlap into the label area or not.

public  booleanisVisible()
    

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.

public  voidrestoreState(FacesContext _context, Object _state)
    
public  ObjectsaveState(FacesContext _context)
    
public  voidsetDisabled(boolean disabled)
    
public  voidsetHelpText(String helpText)
    

The help text will appear below the content of the "property". Optionally, the helpText may also be provided as a facet named "helpText".

public  voidsetLabel(String label)
    

Use this attribute to specify the text of the label of this property.

public  voidsetLabelAlign(String labelAlign)
    

Specifies the label alignment for the label of this component.

public  voidsetNoWrap(boolean noWrap)
    

Specifies if the label component should not wrap.

public  voidsetOverlapLabel(boolean overlapLabel)
    

This indicates whether the property should overlap into the label area or not.

public  voidsetStyle(String style)
    
public  voidsetStyleClass(String styleClass)
    
public  voidsetVisible(boolean visible)
    

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.



Constructor Detail
PropertyBase
public PropertyBase()(Code)

Construct a new PropertyBase.





Method Detail
getFamily
public String getFamily()(Code)

Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance.




getHelpText
public String getHelpText()(Code)

The help text will appear below the content of the "property". Optionally, the helpText may also be provided as a facet named "helpText". This allows advanced users to have more control over the types of content provided in the helpText area.




getLabel
public String getLabel()(Code)

Use this attribute to specify the text of the label of this property. The for attribute of the label will be the first input element in the content area of this component. To label a different component, use the label facet instead.




getLabelAlign
public String getLabelAlign()(Code)

Specifies the label alignment for the label of this component. The label itself may be added via the label property or the label facet. The value will typically be "left" or "right".




getStyle
public String getStyle()(Code)

CSS style(s) to be applied when this component is rendered.




getStyleClass
public String getStyleClass()(Code)

CSS style class(es) to be applied when this component is rendered.




isDisabled
public boolean isDisabled()(Code)

Flag indicating that the user is not permitted to activate this component, and that the component's value will not be submitted with the form.




isNoWrap
public boolean isNoWrap()(Code)

Specifies if the label component should not wrap. The label itself may be added via the label property or the label facet.




isOverlapLabel
public boolean isOverlapLabel()(Code)

This indicates whether the property should overlap into the label area or not. Default: false -- do not extend into the label area.




isVisible
public boolean isVisible()(Code)

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.




restoreState
public void restoreState(FacesContext _context, Object _state)(Code)

Restore the state of this component.




saveState
public Object saveState(FacesContext _context)(Code)

Save the state of this component.




setDisabled
public void setDisabled(boolean disabled)(Code)

Flag indicating that the user is not permitted to activate this component, and that the component's value will not be submitted with the form.


See Also:   PropertyBase.isDisabled()



setHelpText
public void setHelpText(String helpText)(Code)

The help text will appear below the content of the "property". Optionally, the helpText may also be provided as a facet named "helpText". This allows advanced users to have more control over the types of content provided in the helpText area.


See Also:   PropertyBase.getHelpText()



setLabel
public void setLabel(String label)(Code)

Use this attribute to specify the text of the label of this property. The for attribute of the label will be the first input element in the content area of this component. To label a different component, use the label facet instead.


See Also:   PropertyBase.getLabel()



setLabelAlign
public void setLabelAlign(String labelAlign)(Code)

Specifies the label alignment for the label of this component. The label itself may be added via the label property or the label facet. The value will typically be "left" or "right".


See Also:   PropertyBase.getLabelAlign()



setNoWrap
public void setNoWrap(boolean noWrap)(Code)

Specifies if the label component should not wrap. The label itself may be added via the label property or the label facet.


See Also:   PropertyBase.isNoWrap()



setOverlapLabel
public void setOverlapLabel(boolean overlapLabel)(Code)

This indicates whether the property should overlap into the label area or not. Default: false -- do not extend into the label area.


See Also:   PropertyBase.isOverlapLabel()



setStyle
public void setStyle(String style)(Code)

CSS style(s) to be applied when this component is rendered.


See Also:   PropertyBase.getStyle()



setStyleClass
public void setStyleClass(String styleClass)(Code)

CSS style class(es) to be applied when this component is rendered.


See Also:   PropertyBase.getStyleClass()



setVisible
public void setVisible(boolean visible)(Code)

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.


See Also:   PropertyBase.isVisible()



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