|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXPanel
oracle.adf.view.rich.component.rich.layout.RichPanelLabelAndMessage
public class RichPanelLabelAndMessage
<html:p> This component lays out a label, children, tip, and associated message. Typically, the only child of this component will be an input element of some sort, but as many children as necessary can be added. When using panelLabelAndMessage with ADF input components, you should <html:strong>always</html:strong> set <html:code>simple="true"</html:code> on the input components. Non-simple ADF input components already effectively have all the functionality of panelLabelAndMessage. </html:p> <html:p> To lay out multiple panelLabelAndMessage components - or multiple non-simple ADF input components - you can use the panelFormLayout component. When panelLabelAndMessage components are placed inside a panelFormLayout the labels will line up. </html:p> <section name="Geometry_Management"> <html:ul> <html:li>This component cannot be stretched by a parent layout component that stretches its children, e.g., panelStretchLayout.</html:li> <html:li>This component does not stretch its children.</html:li> </html:ul> </section>
Type | Phases | Description |
---|---|---|
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
Invoke Application Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing. |
Field Summary | |
---|---|
static org.apache.myfaces.trinidad.bean.PropertyKey |
ACCESS_KEY_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CHANGED_DESC_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CHANGED_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_ATTRIBUTES_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_COMPONENT_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_LISTENERS_KEY |
static java.lang.String |
COMPONENT_FAMILY |
static java.lang.String |
COMPONENT_TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CUSTOMIZATION_ID_KEY Deprecated. |
static java.lang.String |
END_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
FOR_KEY |
static java.lang.String |
HELP_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
HELP_TOPIC_ID_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
LABEL_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
LABEL_STYLE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORT_DESC_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHOW_REQUIRED_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STYLE_CLASS_KEY |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VISIBLE_KEY |
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Constructor Summary | |
---|---|
|
RichPanelLabelAndMessage() Construct an instance of the RichPanelLabelAndMessage. |
protected |
RichPanelLabelAndMessage(java.lang.String rendererType) Construct an instance of the RichPanelLabelAndMessage. |
Method Summary | |
---|---|
char |
getAccessKey() Gets a character used to gain quick access to the form element specified by the for , if set (or this component itself, if it is a "non-simple" form element). |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
java.lang.String |
getChangedDesc() Gets the text commonly used by user agents to display tooltip text on the changed indicator icon. |
java.util.Set |
getClientAttributes() Gets a set of client attribute names. |
ClientListenerSet |
getClientListeners() Gets a set of client listeners. |
java.lang.String |
getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
javax.faces.component.UIComponent |
getEnd() Component to render after the children. |
java.lang.String |
getFamily() |
java.lang.String |
getFor() Gets the ID of the component that this component's label refers to. |
javax.faces.component.UIComponent |
getHelp() This facet is deprecated, helpTopicId should be used for providing help. |
java.lang.String |
getHelpTopicId() Gets the id used to look up a topic in a helpProvider. |
java.lang.String |
getInlineStyle() Gets the CSS styles to use for this component. |
java.lang.String |
getLabel() Gets the label of the bean. |
java.lang.String |
getLabelStyle() Gets the inline styles for the label portion of the component, e.g. |
java.lang.String[] |
getPartialTriggers() Gets the IDs of the components that should trigger a partial update. |
java.lang.String |
getShortDesc() Gets the short description of the component. |
java.lang.String |
getStyleClass() Gets a CSS style class to use for this component. |
java.util.Set<java.lang.String> |
getUnsecure() Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. |
boolean |
isChanged() Gets an attribute which if set to true, the changed indicator icon will be displayed on the component. |
boolean |
isClientComponent() Gets whether a client-side component will be generated. |
boolean |
isShowRequired() Gets whether the panel should show an indicator that its contents are required. |
boolean |
isVisible() Gets the visibility of the component. |
void |
setAccessKey(char accessKey) Sets a character used to gain quick access to the form element specified by the for , if set (or this component itself, if it is a "non-simple" form element). |
void |
setChanged(boolean changed) Sets an attribute which if set to true, the changed indicator icon will be displayed on the component. |
void |
setChangedDesc(java.lang.String changedDesc) Sets the text commonly used by user agents to display tooltip text on the changed indicator icon. |
void |
setClientAttributes(java.util.Set clientAttributes) Sets a set of client attribute names. |
void |
setClientComponent(boolean clientComponent) Sets whether a client-side component will be generated. |
void |
setClientListeners(ClientListenerSet clientListeners) Sets a set of client listeners. |
void |
setCustomizationId(java.lang.String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
void |
setEnd(javax.faces.component.UIComponent endFacet) Component to render after the children. |
void |
setFor(java.lang.String forParam) Sets the ID of the component that this component's label refers to. |
void |
setHelp(javax.faces.component.UIComponent helpFacet) This facet is deprecated, helpTopicId should be used for providing help. |
void |
setHelpTopicId(java.lang.String helpTopicId) Sets the id used to look up a topic in a helpProvider. |
void |
setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component. |
void |
setLabel(java.lang.String label) Sets the label of the bean. |
void |
setLabelStyle(java.lang.String labelStyle) Sets the inline styles for the label portion of the component, e.g. |
void |
setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update. |
void |
setShortDesc(java.lang.String shortDesc) Sets the short description of the component. |
void |
setShowRequired(boolean showRequired) Sets whether the panel should show an indicator that its contents are required. |
void |
setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component. |
void |
setUnsecure(java.util.Set<java.lang.String> unsecure) Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. |
void |
setVisible(boolean visible) Sets the visibility of the component. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent |
---|
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CHANGED_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_REQUIRED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LABEL_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ACCESS_KEY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey FOR_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY
public static final java.lang.String HELP_FACET
public static final java.lang.String END_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichPanelLabelAndMessage()
protected RichPanelLabelAndMessage(java.lang.String rendererType)
Method Detail |
---|
public final javax.faces.component.UIComponent getHelp()
public final void setHelp(javax.faces.component.UIComponent helpFacet)
public final javax.faces.component.UIComponent getEnd()
public final void setEnd(javax.faces.component.UIComponent endFacet)
public final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.util.Set<java.lang.String> getUnsecure()
public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value
@Deprecated
public final java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final boolean isChanged()
public final void setChanged(boolean changed)
changed
- the new changed valuepublic final java.lang.String getChangedDesc()
public final void setChangedDesc(java.lang.String changedDesc)
changedDesc
- the new changedDesc valuepublic final boolean isShowRequired()
public final void setShowRequired(boolean showRequired)
showRequired
- the new showRequired valuepublic final java.lang.String getLabel()
public final void setLabel(java.lang.String label)
label
- the new label valuepublic final java.lang.String getLabelStyle()
public final void setLabelStyle(java.lang.String labelStyle)
labelStyle
- the new labelStyle valuepublic final char getAccessKey()
for
, if set (or this component itself, if it is a "non-simple" form element). For accessibility reasons, this functionality is not supported in screen reader mode. If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.
This attribute is sometimes referred to as the "mnemonic".
Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.
public final void setAccessKey(char accessKey)
for
, if set (or this component itself, if it is a "non-simple" form element). For accessibility reasons, this functionality is not supported in screen reader mode. If the same access key appears in multiple locations in the same page of output, the rendering user agent will cycle among the elements accessed by the similar keys.
This attribute is sometimes referred to as the "mnemonic".
Note that the accessKey is triggered by browser-specific and platform-specific modifier keys. It even has browser-specific meaning. For example, Internet Explorer 7.0 will set focus when you press Alt+<accessKey>. Firefox 2.0 on some operating systems you press Alt+Shift+<accessKey>. Firefox 2.0 on other operating systems you press Control+<accessKey>. Refer to your browser's documentation for how it treats accessKey.
accessKey
- the new accessKey valuepublic final java.lang.String getFor()
Identifiers are relative to the component, and must account for NamingContainers. You can use a single colon to start the search from the root, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container and begin the search from there, ":::" will pop out of two naming containers and begin the search from there, etc.
public final void setFor(java.lang.String forParam)
Identifiers are relative to the component, and must account for NamingContainers. You can use a single colon to start the search from the root, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container and begin the search from there, ":::" will pop out of two naming containers and begin the search from there, etc.
forParam
- the new for valuepublic final java.lang.String getHelpTopicId()
public final void setHelpTopicId(java.lang.String helpTopicId)
helpTopicId
- the new helpTopicId valuepublic java.lang.String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXPanel
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXPanel
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |