oracle.adf.view.faces.component.core.output
Class CoreOutputLabel

java.lang.Object
  javax.faces.component.UIComponent
      oracle.adf.view.faces.component.UIXComponent
          oracle.adf.view.faces.component.UIXComponentBase
              oracle.adf.view.faces.component.UIXValue
                  oracle.adf.view.faces.component.UIXOutput
                      oracle.adf.view.faces.component.core.output.CoreOutputLabel

All Implemented Interfaces:

StateHolder, ValueHolder

public class CoreOutputLabel

extends UIXOutput

Component that displays a label for a form component, including a text label, and an (optional) icon indicating the type of message. Developers should use this if they need more control over layout than the built-in label support for label components allows.

Example:

   <af:outputLabel value="Name:"
                   for="anInput"/>
   <af:inputText id="anInput"/>

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	FOR_KEY
static PropertyKey	INLINE_STYLE_KEY
static PropertyKey	MESSAGE_DESC_URL_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 FacesBean.Type	TYPE

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

CONVERTER_KEY, VALUE_KEY

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

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

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

Method Summary

char	getAccessKey() Gets Character used to gain quick access to the form element specified by the for, if set.
java.lang.String	getAnchor() Gets Specifies the name of an anchor tag.
protected FacesBean.Type	getBeanType()
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	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.
boolean	isShowRequired() Gets whether to show an indicator that the associated control is required.
void	setAccessKey(char accessKey) Sets Character used to gain quick access to the form element specified by the for, if set.
void	setAnchor(java.lang.String anchor) Sets Specifies the name of an anchor tag.
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	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 to show an indicator that the associated control is required.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.

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

getConverter, getLocalValue, getValue, setConverter, setValue

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

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

ACCESS_KEY_KEY

public static final PropertyKey ACCESS_KEY_KEY

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

MESSAGE_TYPE_KEY

public static final PropertyKey MESSAGE_TYPE_KEY

FOR_KEY

public static final PropertyKey FOR_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

ANCHOR_KEY

public static final PropertyKey ANCHOR_KEY

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

CoreOutputLabel

public CoreOutputLabel()

Construct an instance of the CoreOutputLabel.

CoreOutputLabel

protected CoreOutputLabel(java.lang.String rendererType)

Construct an instance of the CoreOutputLabel.

Method Detail

getAccessKey

public final char getAccessKey()

Gets Character used to gain quick access to the form element specified by the for, if set. 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. 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".

isShowRequired

public final boolean isShowRequired()

Gets whether to show an indicator that the associated control is required.

setShowRequired

public final void setShowRequired(boolean showRequired)

Sets whether to show an indicator that the associated control is 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

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

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

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.

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.

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UIXOutput

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXOutput