|
Oracle UIX API Reference Release 2.1.22.0.0 B12196-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.cabo.ui.DeprecatedUINode | +--oracle.cabo.ui.BaseUINode | +--oracle.cabo.ui.BaseMutableUINode | +--oracle.cabo.ui.beans.BaseWebBean | +--oracle.cabo.ui.beans.MarlinBean | +--oracle.cabo.ui.beans.message.MessagePromptBean
Component that displays the prompt portion of an inline message, including a text prompt, an (optional) required icon, and an (optional) icon indicating the type of message. Developers should use this if they need more control over layout than the composite inline messaging elements allow.
<messagePrompt prompt="Name:" required="yes"/>
Constructor Summary | |
|
MessagePromptBean()
Construct an instance of the MessagePromptBean. |
protected |
MessagePromptBean(boolean ignored,
java.lang.String localName)
Construct an instance of the MessagePromptBean. |
Method Summary | |
char |
getAccessKey()
Gets Character used to gain quick access to the form element specified by the labeledNodeId , if set. |
static char |
getAccessKey(MutableUINode bean)
Gets Character used to gain quick access to the form element specified by the labeledNodeId , if set. |
java.lang.String |
getAnchor()
Gets Specifies the name of an anchor tag. |
static java.lang.String |
getAnchor(MutableUINode bean)
Gets Specifies the name of an anchor tag. |
java.lang.String |
getLabeledNodeID()
Gets The ID of the UINode that this prompt is acting as a label for. |
static java.lang.String |
getLabeledNodeID(MutableUINode bean)
Gets The ID of the UINode that this prompt is acting as a label for. |
java.lang.String |
getLongDescURL()
Gets an URL to a page with more information about the message. |
static java.lang.String |
getLongDescURL(MutableUINode bean)
Gets an URL to a page with more information about the message. |
java.lang.String |
getMessageType()
Gets the type of the message; acceptable values are "error", "warning", "info", and "none". |
static java.lang.String |
getMessageType(MutableUINode bean)
Gets the type of the message; acceptable values are "error", "warning", "info", and "none". |
java.lang.String |
getPrompt()
Gets the prompt of the bean. |
static java.lang.String |
getPrompt(MutableUINode bean)
Gets the prompt of the bean. |
java.lang.String |
getRequired()
Gets whether the associated control requires user input. |
static java.lang.String |
getRequired(MutableUINode bean)
Gets whether the associated control requires user input. |
java.lang.String |
getTargetFrame()
Gets the target frame for the URL, if any. |
static java.lang.String |
getTargetFrame(MutableUINode bean)
Gets the target frame for the URL, if any. |
java.lang.String |
getVAlign()
Gets the vertical alignment of the prompt and other contents. |
static java.lang.String |
getVAlign(MutableUINode bean)
Gets the vertical alignment of the prompt and other contents. |
void |
setAccessKey(char accessKey)
Sets Character used to gain quick access to the form element specified by the labeledNodeId , if set. |
static void |
setAccessKey(MutableUINode bean,
char accessKey)
Sets Character used to gain quick access to the form element specified by the labeledNodeId , if set. |
static void |
setAnchor(MutableUINode bean,
java.lang.String anchor)
Sets Specifies the name of an anchor tag. |
void |
setAnchor(java.lang.String anchor)
Sets Specifies the name of an anchor tag. |
static void |
setLabeledNodeID(MutableUINode bean,
java.lang.String labeledNodeId)
Sets The ID of the UINode that this prompt is acting as a label for. |
void |
setLabeledNodeID(java.lang.String labeledNodeId)
Sets The ID of the UINode that this prompt is acting as a label for. |
static void |
setLongDescURL(MutableUINode bean,
java.lang.String longDescURL)
Sets an URL to a page with more information about the message. |
void |
setLongDescURL(java.lang.String longDescURL)
Sets an URL to a page with more information about the message. |
void |
setLongDescURLBinding(BoundValue boundValue)
Binds the an URL to a page with more information about the message. |
static void |
setLongDescURLBinding(MutableUINode bean,
BoundValue boundValue)
Binds the an URL to a page with more information about the message. |
static void |
setLongDescURLBinding(MutableUINode bean,
java.lang.Object selectKey)
Binds the an URL to a page with more information about the message. |
static void |
setLongDescURLBinding(MutableUINode bean,
java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the an URL to a page with more information about the message. |
void |
setLongDescURLBinding(java.lang.Object selectKey)
Binds the an URL to a page with more information about the message. |
void |
setLongDescURLBinding(java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the an URL to a page with more information about the message. |
static void |
setMessageType(MutableUINode bean,
java.lang.String messageType)
Sets the type of the message; acceptable values are "error", "warning", "info", and "none". |
void |
setMessageType(java.lang.String messageType)
Sets the type of the message; acceptable values are "error", "warning", "info", and "none". |
void |
setMessageTypeBinding(BoundValue boundValue)
Binds the the type of the message; acceptable values are "error", "warning", "info", and "none". |
static void |
setMessageTypeBinding(MutableUINode bean,
BoundValue boundValue)
Binds the the type of the message; acceptable values are "error", "warning", "info", and "none". |
static void |
setMessageTypeBinding(MutableUINode bean,
java.lang.Object selectKey)
Binds the the type of the message; acceptable values are "error", "warning", "info", and "none". |
static void |
setMessageTypeBinding(MutableUINode bean,
java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the the type of the message; acceptable values are "error", "warning", "info", and "none". |
void |
setMessageTypeBinding(java.lang.Object selectKey)
Binds the the type of the message; acceptable values are "error", "warning", "info", and "none". |
void |
setMessageTypeBinding(java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the the type of the message; acceptable values are "error", "warning", "info", and "none". |
static void |
setPrompt(MutableUINode bean,
java.lang.String prompt)
Sets the prompt of the bean. |
void |
setPrompt(java.lang.String prompt)
Sets the prompt of the bean. |
static void |
setRequired(MutableUINode bean,
java.lang.String required)
Sets whether the associated control requires user input. |
void |
setRequired(java.lang.String required)
Sets whether the associated control requires user input. |
static void |
setTargetFrame(MutableUINode bean,
java.lang.String targetFrame)
Sets the target frame for the URL, if any. |
void |
setTargetFrame(java.lang.String targetFrame)
Sets the target frame for the URL, if any. |
static void |
setTranslatablePrompt(MutableUINode bean,
java.lang.String bundleName,
java.lang.String key)
Binds to a ResourceBundle the the prompt of the bean. |
void |
setTranslatablePrompt(java.lang.String bundleName,
java.lang.String key)
Binds to a ResourceBundle the the prompt of the bean. |
static void |
setVAlign(MutableUINode bean,
java.lang.String vAlign)
Sets the vertical alignment of the prompt and other contents. |
void |
setVAlign(java.lang.String vAlign)
Sets the vertical alignment of the prompt and other contents. |
Methods inherited from class oracle.cabo.ui.beans.MarlinBean |
isEqualMarlinName |
Methods inherited from class oracle.cabo.ui.BaseUINode |
getAttributeNames, getAttributeValue, getAttributeValueImpl, getChildArray, getChildNames, getIndexedChild, getIndexedChild, getIndexedChildCount, getLocalName, getNamedChild, getNamespaceURI, getNodeID, getNodeRole, getPreorderDescendentAttributeValue, getRawAttributeValue, getRenderedUINode, getRenderer, getRenderer, render, render, toString |
Methods inherited from class oracle.cabo.ui.DeprecatedUINode |
getAttributeValue, getChildNames, getNamedChild |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface oracle.cabo.ui.UINode |
getAttributeNames, getAttributeValue, getAttributeValue, getChildNames, getChildNames, getIndexedChild, getIndexedChild, getIndexedChildCount, getLocalName, getNamedChild, getNamedChild, getNamespaceURI, getNodeID, getNodeRole, getRawAttributeValue, render, render |
Constructor Detail |
public MessagePromptBean()
protected MessagePromptBean(boolean ignored, java.lang.String localName)
Method Detail |
public final java.lang.String getRequired()
public final void setRequired(java.lang.String required)
public final java.lang.String getMessageType()
public final void setMessageType(java.lang.String messageType)
public final void setMessageTypeBinding(BoundValue boundValue)
boundValue
- a BoundValue implementation to be used
to retrieve the value.public final void setMessageTypeBinding(java.lang.Object selectKey)
selectKey
- the key to be passed to selectValue()
on the
current DataObject
, e.g., the DataObject for the current
table row.public final void setMessageTypeBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
dataNamespace
- the namespace to be passed to
RenderingContext.getDataObject()
dataName
- the name to be passed to
RenderingContext.getDataObject()
selectKey
- the key to be passed to selectValue()
on the
DataObject
.public final java.lang.String getPrompt()
public final void setPrompt(java.lang.String prompt)
public final void setTranslatablePrompt(java.lang.String bundleName, java.lang.String key)
bundleName
- the name of the ResourceBundlekey
- the key of the string to retrieve from the ResourceBundlepublic final java.lang.String getLongDescURL()
public final void setLongDescURL(java.lang.String longDescURL)
public final void setLongDescURLBinding(BoundValue boundValue)
boundValue
- a BoundValue implementation to be used
to retrieve the value.public final void setLongDescURLBinding(java.lang.Object selectKey)
selectKey
- the key to be passed to selectValue()
on the
current DataObject
, e.g., the DataObject for the current
table row.public final void setLongDescURLBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
dataNamespace
- the namespace to be passed to
RenderingContext.getDataObject()
dataName
- the name to be passed to
RenderingContext.getDataObject()
selectKey
- the key to be passed to selectValue()
on the
DataObject
.public final java.lang.String getTargetFrame()
public final void setTargetFrame(java.lang.String targetFrame)
public final java.lang.String getVAlign()
public final void setVAlign(java.lang.String vAlign)
public final char getAccessKey()
labeledNodeId
, if set.
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".
The character specified by this attribute
must exist in the
prompt
attribute of this instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
The easiest, and most convenient
way to specify both the text and the mnemonic together is to use
NodeUtils.setTextAndAccessKey().
public final void setAccessKey(char accessKey)
labeledNodeId
, if set.
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".
The character specified by this attribute
must exist in the
prompt
attribute of this instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
The easiest, and most convenient
way to specify both the text and the mnemonic together is to use
NodeUtils.setTextAndAccessKey().
public final java.lang.String getAnchor()
public final void setAnchor(java.lang.String anchor)
public final java.lang.String getLabeledNodeID()
accessKey
attribute, the user
pressing the access key will move keyboard focus to the
UINode specified by
labeledNodeId
. In addition, even
when access keys are not used, using this attribute to
specify the logical relationship between a UINode and
its label can improve the accessibility of your UI.public final void setLabeledNodeID(java.lang.String labeledNodeId)
accessKey
attribute, the user
pressing the access key will move keyboard focus to the
UINode specified by
labeledNodeId
. In addition, even
when access keys are not used, using this attribute to
specify the logical relationship between a UINode and
its label can improve the accessibility of your UI.public static java.lang.String getRequired(MutableUINode bean)
public static void setRequired(MutableUINode bean, java.lang.String required)
public static java.lang.String getMessageType(MutableUINode bean)
public static void setMessageType(MutableUINode bean, java.lang.String messageType)
public static void setMessageTypeBinding(MutableUINode bean, BoundValue boundValue)
boundValue
- a BoundValue implementation to be used
to retrieve the value.public static void setMessageTypeBinding(MutableUINode bean, java.lang.Object selectKey)
selectKey
- the key to be passed to selectValue()
on the
current DataObject
, e.g., the DataObject for the current
table row.public static void setMessageTypeBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
dataNamespace
- the namespace to be passed to
RenderingContext.getDataObject()
dataName
- the name to be passed to
RenderingContext.getDataObject()
selectKey
- the key to be passed to selectValue()
on the
DataObject
.public static java.lang.String getPrompt(MutableUINode bean)
public static void setPrompt(MutableUINode bean, java.lang.String prompt)
public static void setTranslatablePrompt(MutableUINode bean, java.lang.String bundleName, java.lang.String key)
bundleName
- the name of the ResourceBundlekey
- the key of the string to retrieve from the ResourceBundlepublic static java.lang.String getLongDescURL(MutableUINode bean)
public static void setLongDescURL(MutableUINode bean, java.lang.String longDescURL)
public static void setLongDescURLBinding(MutableUINode bean, BoundValue boundValue)
boundValue
- a BoundValue implementation to be used
to retrieve the value.public static void setLongDescURLBinding(MutableUINode bean, java.lang.Object selectKey)
selectKey
- the key to be passed to selectValue()
on the
current DataObject
, e.g., the DataObject for the current
table row.public static void setLongDescURLBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
dataNamespace
- the namespace to be passed to
RenderingContext.getDataObject()
dataName
- the name to be passed to
RenderingContext.getDataObject()
selectKey
- the key to be passed to selectValue()
on the
DataObject
.public static java.lang.String getTargetFrame(MutableUINode bean)
public static void setTargetFrame(MutableUINode bean, java.lang.String targetFrame)
public static java.lang.String getVAlign(MutableUINode bean)
public static void setVAlign(MutableUINode bean, java.lang.String vAlign)
public static char getAccessKey(MutableUINode bean)
labeledNodeId
, if set.
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".
The character specified by this attribute
must exist in the
prompt
attribute of this instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
The easiest, and most convenient
way to specify both the text and the mnemonic together is to use
NodeUtils.setTextAndAccessKey().
public static void setAccessKey(MutableUINode bean, char accessKey)
labeledNodeId
, if set.
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".
The character specified by this attribute
must exist in the
prompt
attribute of this instance.
If it does not, the user will receive no visual indication of
the existence of the accessKey.
The easiest, and most convenient
way to specify both the text and the mnemonic together is to use
NodeUtils.setTextAndAccessKey().
public static java.lang.String getAnchor(MutableUINode bean)
public static void setAnchor(MutableUINode bean, java.lang.String anchor)
public static java.lang.String getLabeledNodeID(MutableUINode bean)
accessKey
attribute, the user
pressing the access key will move keyboard focus to the
UINode specified by
labeledNodeId
. In addition, even
when access keys are not used, using this attribute to
specify the logical relationship between a UINode and
its label can improve the accessibility of your UI.public static void setLabeledNodeID(MutableUINode bean, java.lang.String labeledNodeId)
accessKey
attribute, the user
pressing the access key will move keyboard focus to the
UINode specified by
labeledNodeId
. In addition, even
when access keys are not used, using this attribute to
specify the logical relationship between a UINode and
its label can improve the accessibility of your UI.
|
Oracle UIX API Reference Release 2.1.22.0.0 B12196-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |