com.sun.rave.web.ui.component
Class Property

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.sun.rave.web.ui.component.PropertyBase
              extended by com.sun.rave.web.ui.component.Property
All Implemented Interfaces:
ComplexComponent, javax.faces.component.StateHolder

public class Property
extends PropertyBase
implements ComplexComponent


Field Summary
static java.lang.String CONTENT_FACET
           
static java.lang.String HELPTEXT_FACET
           
static java.lang.String LABEL_FACET
           
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
Property()
          Constructor.
 
Method Summary
 javax.faces.component.UIComponent getContentComponent()
          Return the a component that represents the content of the property.
 javax.faces.component.UIComponent getHelpTextComponent()
          Return the component that implements help text.
 javax.faces.component.UIComponent getLabelComponent()
          Return the component that implements a label.
 java.lang.String getPrimaryElementID(javax.faces.context.FacesContext context)
           This method calculates the proper UIComponent that should be used when the label property is used with this component.
 
Methods inherited from class com.sun.rave.web.ui.component.PropertyBase
getFamily, getHelpText, getLabel, getLabelAlign, getStyle, getStyleClass, isDisabled, isNoWrap, isOverlapLabel, isVisible, restoreState, saveState, setDisabled, setHelpText, setLabel, setLabelAlign, setNoWrap, setOverlapLabel, setStyle, setStyleClass, setVisible
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CONTENT_FACET

public static final java.lang.String CONTENT_FACET
See Also:
Constant Field Values

HELPTEXT_FACET

public static final java.lang.String HELPTEXT_FACET
See Also:
Constant Field Values

LABEL_FACET

public static final java.lang.String LABEL_FACET
See Also:
Constant Field Values
Constructor Detail

Property

public Property()
Constructor.

Method Detail

getPrimaryElementID

public java.lang.String getPrimaryElementID(javax.faces.context.FacesContext context)

This method calculates the proper UIComponent that should be used when the label property is used with this component.

This method provides the implementation for ComplexComponent

Specified by:
getPrimaryElementID in interface ComplexComponent
Parameters:
context - The FacesContext.
Returns:
The id of the label target.

getContentComponent

public javax.faces.component.UIComponent getContentComponent()
Return the a component that represents the content of the property. If a facet called content does not exist null is returned.


getHelpTextComponent

public javax.faces.component.UIComponent getHelpTextComponent()
Return the component that implements help text. If a facet named helpText is found that component is returned. Otherwise a HelpInline component is returned. It is assigned the id
getId() + "_helpText"

If the facet is not defined then the returned HelpInline component is re-intialized every time this method is called.

If getHelpeText returns null, null is returned.

Returns:
a help text facet component

getLabelComponent

public javax.faces.component.UIComponent getLabelComponent()
Return the component that implements a label. If a facet named label is found that component is returned. Otherwise a Label component is returned. It is assigned the id
getId() + "_label"

If the facet is not defined then the returned Label component is re-intialized every time this method is called.

Returns:
a label facet component