oracle.adf.view.faces.component.core.layout
Class CorePanelLabelAndMessage

java.lang.Object
  javax.faces.component.UIComponent
      oracle.adf.view.faces.component.UIXComponent
          oracle.adf.view.faces.component.UIXComponentBase
              oracle.adf.view.faces.component.UIXPanel
                  oracle.adf.view.faces.component.core.layout.CorePanelLabelAndMessage

All Implemented Interfaces:

StateHolder

public class CorePanelLabelAndMessage

extends UIXPanel

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 always set simple="true" on the input components. Non-simple ADF input components already effectively have all the functionality of panelLabelAndMessage.

To lay out multiple panelLabelAndMessage components - or multiple non-simple ADF input components - you can use the panelForm component. When panelLabelAndMessage components are placed inside a panelForm the labels will line up.

Example:

 <af:panelLabelAndMessage for="selectDate"
                tip="Pick a date">
   <af:selectInputDate id="selectDate" simple="true"/>
 </af:panelLabelAndMessage>

Field Summary

static PropertyKey	ACCESS_KEY_KEY
static PropertyKey	ANCHOR_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	CONTENT_STYLE_CLASS_KEY
static java.lang.String	END_FACET
static PropertyKey	FOR_KEY
static PropertyKey	INLINE_STYLE_KEY
static PropertyKey	LABEL_KEY
static PropertyKey	MESSAGE_DESC_URL_KEY
static PropertyKey	MESSAGE_KEY
static PropertyKey	MESSAGE_TARGET_FRAME_KEY
static java.lang.String	MESSAGE_TYPE_ERROR Enumerated value indicating that the control has an error message
static java.lang.String	MESSAGE_TYPE_INFO Enumerated value indicating that the control has an informational message
static PropertyKey	MESSAGE_TYPE_KEY
static java.lang.String	MESSAGE_TYPE_NONE Enumerated value indicating that the control has no associated message
static java.lang.String	MESSAGE_TYPE_WARNING Enumerated value indicating that the control has a warning message
static PropertyKey	ONCLICK_KEY
static PropertyKey	ONDBLCLICK_KEY
static PropertyKey	ONKEYDOWN_KEY
static PropertyKey	ONKEYPRESS_KEY
static PropertyKey	ONKEYUP_KEY
static PropertyKey	ONMOUSEDOWN_KEY
static PropertyKey	ONMOUSEMOVE_KEY
static PropertyKey	ONMOUSEOUT_KEY
static PropertyKey	ONMOUSEOVER_KEY
static PropertyKey	ONMOUSEUP_KEY
static PropertyKey	PARTIAL_TRIGGERS_KEY
static PropertyKey	SHORT_DESC_KEY
static PropertyKey	SHOW_REQUIRED_KEY
static PropertyKey	STYLE_CLASS_KEY
static PropertyKey	TIP_KEY
static FacesBean.Type	TYPE
static java.lang.String	VALIGN_BOTTOM Enumerated value indicating that the valign value is bottom.
static PropertyKey	VALIGN_KEY
static java.lang.String	VALIGN_MIDDLE Enumerated value indicating that the valign value is middle.
static java.lang.String	VALIGN_TOP Enumerated value indicating that the valign value is top.

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

	CorePanelLabelAndMessage() Construct an instance of the CorePanelLabelAndMessage.
protected	CorePanelLabelAndMessage(java.lang.String rendererType) Construct an instance of the CorePanelLabelAndMessage.

Method Summary

char	getAccessKey() Gets 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).
java.lang.String	getAnchor() Gets Specifies the name of an anchor tag.
protected FacesBean.Type	getBeanType()
java.lang.String	getContentStyleClass() Gets the CSS style of the content area of the messaging 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 refers to
java.lang.String	getInlineStyle() Gets the inline CSS style for this element
java.lang.String	getLabel() Gets the label of the bean.
java.lang.String	getMessage() Gets the error, warning, or informational text.
java.lang.String	getMessageDescUrl() Gets an URL to a page with more information about the message.
java.lang.String	getMessageTargetFrame() Gets the target frame for the message description URL, if any.
java.lang.String	getMessageType() Gets the type of the message; acceptable values are "error", "warning", "info", and "none".
java.lang.String	getOnclick() Gets an onclick Javascript handler.
java.lang.String	getOndblclick() Gets an ondblclick Javascript handler.
java.lang.String	getOnkeydown() Gets an onkeydown Javascript handler.
java.lang.String	getOnkeypress() Gets an onkeypress Javascript handler.
java.lang.String	getOnkeyup() Gets an onkeyup Javascript handler.
java.lang.String	getOnmousedown() Gets an onmousedown Javascript handler.
java.lang.String	getOnmousemove() Gets an onmousemove Javascript handler.
java.lang.String	getOnmouseout() Gets an onmouseout Javascript handler.
java.lang.String	getOnmouseover() Gets an onmouseover Javascript handler.
java.lang.String	getOnmouseup() Gets an onmouseup Javascript handler.
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 bean.
java.lang.String	getStyleClass() Gets the CSS style class of the bean.
java.lang.String	getTip() Gets the tip text associated with the control
java.lang.String	getValign() Gets the vertical alignment of the label and other contents.
boolean	isShowRequired() Gets whether the panel should show an indicator that its contents are required.
void	setAccessKey(char accessKey) Sets 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	setAnchor(java.lang.String anchor) Sets Specifies the name of an anchor tag.
void	setContentStyleClass(java.lang.String contentStyleClass) Sets the CSS style of the content area of the messaging component.
void	setEnd(UIComponent endFacet) Component to render after the children.
void	setFor(java.lang.String forParam) Sets the ID of the component that this component refers to
void	setInlineStyle(java.lang.String inlineStyle) Sets the inline CSS style for this element
void	setLabel(java.lang.String label) Sets the label of the bean.
void	setMessage(java.lang.String message) Sets the error, warning, or informational text.
void	setMessageDescUrl(java.lang.String messageDescUrl) Sets an URL to a page with more information about the message.
void	setMessageTargetFrame(java.lang.String messageTargetFrame) Sets the target frame for the message description URL, if any.
void	setMessageType(java.lang.String messageType) Sets the type of the message; acceptable values are "error", "warning", "info", and "none".
void	setOnclick(java.lang.String onclick) Sets an onclick Javascript handler.
void	setOndblclick(java.lang.String ondblclick) Sets an ondblclick Javascript handler.
void	setOnkeydown(java.lang.String onkeydown) Sets an onkeydown Javascript handler.
void	setOnkeypress(java.lang.String onkeypress) Sets an onkeypress Javascript handler.
void	setOnkeyup(java.lang.String onkeyup) Sets an onkeyup Javascript handler.
void	setOnmousedown(java.lang.String onmousedown) Sets an onmousedown Javascript handler.
void	setOnmousemove(java.lang.String onmousemove) Sets an onmousemove Javascript handler.
void	setOnmouseout(java.lang.String onmouseout) Sets an onmouseout Javascript handler.
void	setOnmouseover(java.lang.String onmouseover) Sets an onmouseover Javascript handler.
void	setOnmouseup(java.lang.String onmouseup) Sets an onmouseup Javascript handler.
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 bean.
void	setShowRequired(boolean showRequired) Sets whether the panel should show an indicator that its contents are required.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.
void	setTip(java.lang.String tip) Sets the tip text associated with the control
void	setValign(java.lang.String valign) Sets the vertical alignment of the label and other contents.

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addAttributeChange, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VALIGN_MIDDLE

public static final java.lang.String VALIGN_MIDDLE

Enumerated value indicating that the valign value is middle.

See Also:

Constant Field Values

VALIGN_TOP

public static final java.lang.String VALIGN_TOP

Enumerated value indicating that the valign value is top.

See Also:

Constant Field Values

VALIGN_BOTTOM

public static final java.lang.String VALIGN_BOTTOM

Enumerated value indicating that the valign value is bottom.

See Also:

Constant Field Values

MESSAGE_TYPE_INFO

public static final java.lang.String MESSAGE_TYPE_INFO

Enumerated value indicating that the control has an informational message

See Also:

Constant Field Values

MESSAGE_TYPE_WARNING

public static final java.lang.String MESSAGE_TYPE_WARNING

Enumerated value indicating that the control has a warning message

See Also:

Constant Field Values

MESSAGE_TYPE_NONE

public static final java.lang.String MESSAGE_TYPE_NONE

Enumerated value indicating that the control has no associated message

See Also:

Constant Field Values

MESSAGE_TYPE_ERROR

public static final java.lang.String MESSAGE_TYPE_ERROR

Enumerated value indicating that the control has an error message

See Also:

Constant Field Values

TYPE

public static final FacesBean.Type TYPE

SHOW_REQUIRED_KEY

public static final PropertyKey SHOW_REQUIRED_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

LABEL_KEY

public static final PropertyKey LABEL_KEY

VALIGN_KEY

public static final PropertyKey VALIGN_KEY

MESSAGE_DESC_URL_KEY

public static final PropertyKey MESSAGE_DESC_URL_KEY

MESSAGE_TARGET_FRAME_KEY

public static final PropertyKey MESSAGE_TARGET_FRAME_KEY

MESSAGE_TYPE_KEY

public static final PropertyKey MESSAGE_TYPE_KEY

TIP_KEY

public static final PropertyKey TIP_KEY

MESSAGE_KEY

public static final PropertyKey MESSAGE_KEY

ANCHOR_KEY

public static final PropertyKey ANCHOR_KEY

CONTENT_STYLE_CLASS_KEY

public static final PropertyKey CONTENT_STYLE_CLASS_KEY

ACCESS_KEY_KEY

public static final PropertyKey ACCESS_KEY_KEY

FOR_KEY

public static final PropertyKey FOR_KEY

END_FACET

public static final java.lang.String END_FACET

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

CorePanelLabelAndMessage

public CorePanelLabelAndMessage()

Construct an instance of the CorePanelLabelAndMessage.

CorePanelLabelAndMessage

protected CorePanelLabelAndMessage(java.lang.String rendererType)

Construct an instance of the CorePanelLabelAndMessage.

Method Detail

getEnd

public final UIComponent getEnd()

Component to render after the children.

setEnd

public final void setEnd(UIComponent endFacet)

Component to render after the children.

isShowRequired

public final boolean isShowRequired()

Gets whether the panel should show an indicator that its contents are required.

setShowRequired

public final void setShowRequired(boolean showRequired)

Sets whether the panel should show an indicator that its contents are required.

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

getOnclick

public final java.lang.String getOnclick()

Gets an onclick Javascript handler.

setOnclick

public final void setOnclick(java.lang.String onclick)

Sets an onclick Javascript handler.

getOndblclick

public final java.lang.String getOndblclick()

Gets an ondblclick Javascript handler.

setOndblclick

public final void setOndblclick(java.lang.String ondblclick)

Sets an ondblclick Javascript handler.

getOnmousedown

public final java.lang.String getOnmousedown()

Gets an onmousedown Javascript handler.

setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)

Sets an onmousedown Javascript handler.

getOnmouseup

public final java.lang.String getOnmouseup()

Gets an onmouseup Javascript handler.

setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)

Sets an onmouseup Javascript handler.

getOnmouseover

public final java.lang.String getOnmouseover()

Gets an onmouseover Javascript handler.

setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)

Sets an onmouseover Javascript handler.

getOnmousemove

public final java.lang.String getOnmousemove()

Gets an onmousemove Javascript handler.

setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)

Sets an onmousemove Javascript handler.

getOnmouseout

public final java.lang.String getOnmouseout()

Gets an onmouseout Javascript handler.

setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)

Sets an onmouseout Javascript handler.

getOnkeypress

public final java.lang.String getOnkeypress()

Gets an onkeypress Javascript handler.

setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)

Sets an onkeypress Javascript handler.

getOnkeydown

public final java.lang.String getOnkeydown()

Gets an onkeydown Javascript handler.

setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)

Sets an onkeydown Javascript handler.

getOnkeyup

public final java.lang.String getOnkeyup()

Gets an onkeyup Javascript handler.

setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)

Sets an onkeyup Javascript handler.

getStyleClass

public final java.lang.String getStyleClass()

Gets the CSS style class of the bean.

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets the CSS style class of the bean.

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the inline CSS style for this element

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the inline CSS style for this element

getLabel

public final java.lang.String getLabel()

Gets the label of the bean.

setLabel

public final void setLabel(java.lang.String label)

Sets the label of the bean.

getValign

public final java.lang.String getValign()

Gets the vertical alignment of the label and other contents. The acceptable values are "middle", "top", and "bottom".

setValign

public final void setValign(java.lang.String valign)

Sets the vertical alignment of the label and other contents. The acceptable values are "middle", "top", and "bottom".

getMessageDescUrl

public final java.lang.String getMessageDescUrl()

Gets an URL to a page with more information about the message.

setMessageDescUrl

public final void setMessageDescUrl(java.lang.String messageDescUrl)

Sets an URL to a page with more information about the message.

getMessageTargetFrame

public final java.lang.String getMessageTargetFrame()

Gets the target frame for the message description URL, if any.

setMessageTargetFrame

public final void setMessageTargetFrame(java.lang.String messageTargetFrame)

Sets the target frame for the message description URL, if any.

getMessageType

public final java.lang.String getMessageType()

Gets the type of the message; acceptable values are "error", "warning", "info", and "none". Defaults to "none".

setMessageType

public final void setMessageType(java.lang.String messageType)

Sets the type of the message; acceptable values are "error", "warning", "info", and "none". Defaults to "none".

getTip

public final java.lang.String getTip()

Gets the tip text associated with the control

setTip

public final void setTip(java.lang.String tip)

Sets the tip text associated with the control

getMessage

public final java.lang.String getMessage()

Gets the error, warning, or informational text.

setMessage

public final void setMessage(java.lang.String message)

Sets the error, warning, or informational text.

getAnchor

public final java.lang.String getAnchor()

Gets Specifies the name of an anchor tag. This tag will uniquely identify this message component across a single page. The destinations of links in a messages tag would reference this anchor.

setAnchor

public final void setAnchor(java.lang.String anchor)

Sets Specifies the name of an anchor tag. This tag will uniquely identify this message component across a single page. The destinations of links in a messages tag would reference this anchor.

getContentStyleClass

public final java.lang.String getContentStyleClass()

Gets the CSS style of the content area of the messaging component.

setContentStyleClass

public final void setContentStyleClass(java.lang.String contentStyleClass)

Sets the CSS style of the content area of the messaging component.

getAccessKey

public final char getAccessKey()

Gets 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). 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".

setAccessKey

public final void setAccessKey(char accessKey)

Sets 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). 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".

getFor

public final java.lang.String getFor()

Gets the ID of the component that this component refers to

setFor

public final void setFor(java.lang.String forParam)

Sets the ID of the component that this component refers to

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UIXPanel

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXPanel