|
UIX 2.2.16 | ||||||||
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.StyledTextBean
The StyledText bean supports styled text and links. Clients can just use a TextNode if they do not require styling or simple link capability. Use the LinkBean for more complex linking.
Basic example.
<styledText text="OraHeaderSubSub" styleClass="OraHeaderSubSub"/>
Example using a destination and an access key.
<styledText text="Destination has accessKey" destination="http://www.example.org" accessKey="d" styleClass="OraInstructionText"/>
Full-on example showing the use of textAndAccessKey, and labeledNodeId.
<flowLayout> <contents> <checkBox name="checkbox1" value="1" id="checkme"/> <styledText textAndAccessKey="&Toggle the <checkBox>" labeledNodeId="checkme" styleClass="OraHeaderSubSub"/> </contents> </flowLayout>
Constructor Summary | |
|
StyledTextBean()
Construct an instance of the StyledTextBean. |
protected |
StyledTextBean(boolean ignored,
java.lang.String localName)
Construct an instance of the StyledTextBean. |
|
StyledTextBean(java.lang.String styleClass)
Construct an instance of the StyledTextBean. |
|
StyledTextBean(java.lang.String text,
java.lang.String styleClass)
Construct an instance of the StyledTextBean. |
|
StyledTextBean(java.lang.String text,
java.lang.String styleClass,
java.lang.String destination)
Construct an instance of the StyledTextBean. |
Method Summary | |
char |
getAccessKey()
Gets Character used to gain quick access to the link on this styledText if the destination is set, or
the labeledNodeId , if set. |
static char |
getAccessKey(MutableUINode bean)
Gets Character used to gain quick access to the link on this styledText if the destination is set, or
the labeledNodeId , if set. |
java.lang.String |
getDescription()
Gets an additional description to be attached to the text, for use in improving accessibility. |
static java.lang.String |
getDescription(MutableUINode bean)
Gets an additional description to be attached to the text, for use in improving accessibility. |
java.lang.String |
getDestination()
Gets the URI this text should reference. |
static java.lang.String |
getDestination(MutableUINode bean)
Gets the URI this text should reference. |
java.lang.String |
getLabeledNodeID()
Gets The ID of the UINode that this styledText is acting as a label for. |
static java.lang.String |
getLabeledNodeID(MutableUINode bean)
Gets The ID of the UINode that this styledText is acting as a label for. |
ClientAction |
getPrimaryClientAction()
Deprecated. Since 2.2.0. Embed the styledText element within a link element instead. |
static ClientAction |
getPrimaryClientAction(MutableUINode bean)
Deprecated. Since 2.2.0. Embed the styledText element within a link element instead. |
java.lang.String |
getText()
Gets the text of the node |
static java.lang.String |
getText(MutableUINode bean)
Gets the text of the node |
int |
getTruncateAt()
Gets the length at which the text should automatically begin truncating. |
static int |
getTruncateAt(MutableUINode bean)
Gets the length at which the text should automatically begin truncating. |
void |
setAccessKey(char accessKey)
Sets Character used to gain quick access to the link on this styledText if the destination is set, or
the labeledNodeId , if set. |
static void |
setAccessKey(MutableUINode bean,
char accessKey)
Sets Character used to gain quick access to the link on this styledText if the destination is set, or
the labeledNodeId , if set. |
static void |
setDescription(MutableUINode bean,
java.lang.String description)
Sets an additional description to be attached to the text, for use in improving accessibility. |
void |
setDescription(java.lang.String description)
Sets an additional description to be attached to the text, for use in improving accessibility. |
static void |
setDestination(MutableUINode bean,
java.lang.String destination)
Sets the URI this text should reference. |
void |
setDestination(java.lang.String destination)
Sets the URI this text should reference. |
static void |
setLabeledNodeID(MutableUINode bean,
java.lang.String labeledNodeId)
Sets The ID of the UINode that this styledText is acting as a label for. |
void |
setLabeledNodeID(java.lang.String labeledNodeId)
Sets The ID of the UINode that this styledText is acting as a label for. |
void |
setPrimaryClientAction(ClientAction primaryClientAction)
Deprecated. Since 2.2.0. Embed the styledText element within a link element instead. |
static void |
setPrimaryClientAction(MutableUINode bean,
ClientAction primaryClientAction)
Deprecated. Since 2.2.0. Embed the styledText element within a link element instead. |
static void |
setText(MutableUINode bean,
java.lang.String text)
Sets the text of the node |
void |
setText(java.lang.String text)
Sets the text of the node |
void |
setTextBinding(BoundValue boundValue)
Binds the the text of the node |
static void |
setTextBinding(MutableUINode bean,
BoundValue boundValue)
Binds the the text of the node |
static void |
setTextBinding(MutableUINode bean,
java.lang.Object selectKey)
Binds the the text of the node |
static void |
setTextBinding(MutableUINode bean,
java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the the text of the node |
void |
setTextBinding(java.lang.Object selectKey)
Binds the the text of the node |
void |
setTextBinding(java.lang.String dataNamespace,
java.lang.String dataName,
java.lang.Object selectKey)
Binds the the text of the node |
static void |
setTranslatableDescription(MutableUINode bean,
java.lang.String bundleName,
java.lang.String key)
Binds to a ResourceBundle the an additional description to be attached to the text, for use in improving accessibility. |
void |
setTranslatableDescription(java.lang.String bundleName,
java.lang.String key)
Binds to a ResourceBundle the an additional description to be attached to the text, for use in improving accessibility. |
static void |
setTranslatableText(MutableUINode bean,
java.lang.String bundleName,
java.lang.String key)
Binds to a ResourceBundle the the text of the node |
void |
setTranslatableText(java.lang.String bundleName,
java.lang.String key)
Binds to a ResourceBundle the the text of the node |
void |
setTruncateAt(int truncateAt)
Sets the length at which the text should automatically begin truncating. |
static void |
setTruncateAt(MutableUINode bean,
int truncateAt)
Sets the length at which the text should automatically begin truncating. |
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 StyledTextBean()
public StyledTextBean(java.lang.String styleClass)
styleClass
- the CSS style class of the bean.public StyledTextBean(java.lang.String text, java.lang.String styleClass)
text
- the text of the nodestyleClass
- the CSS style class of the bean.public StyledTextBean(java.lang.String text, java.lang.String styleClass, java.lang.String destination)
text
- the text of the nodestyleClass
- the CSS style class of the bean.destination
- the URI this text should reference.protected StyledTextBean(boolean ignored, java.lang.String localName)
Method Detail |
public final ClientAction getPrimaryClientAction()
public final void setPrimaryClientAction(ClientAction primaryClientAction)
public final java.lang.String getText()
public final void setText(java.lang.String text)
public final void setTranslatableText(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 void setTextBinding(BoundValue boundValue)
boundValue
- a BoundValue implementation to be used
to retrieve the value.public final void setTextBinding(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 setTextBinding(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 getDestination()
public final void setDestination(java.lang.String destination)
public final char getAccessKey()
destination
is set, or
the 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
text
attribute of this StyledText 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().
getLabeledNodeID()
,
setLabeledNodeID(java.lang.String)
,
getText()
,
setText(java.lang.String)
,
NodeUtils.setTextAndAccessKey(oracle.cabo.ui.MutableUINode, java.lang.String)
public final void setAccessKey(char accessKey)
destination
is set, or
the 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
text
attribute of this StyledText 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().
getLabeledNodeID()
,
setLabeledNodeID(java.lang.String)
,
getText()
,
setText(java.lang.String)
,
NodeUtils.setTextAndAccessKey(oracle.cabo.ui.MutableUINode, java.lang.String)
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.BaseWebBean.getID()
,
BaseWebBean.setID(java.lang.String)
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.BaseWebBean.getID()
,
BaseWebBean.setID(java.lang.String)
public final int getTruncateAt()
public final void setTruncateAt(int truncateAt)
public final java.lang.String getDescription()
public final void setDescription(java.lang.String description)
public final void setTranslatableDescription(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 ClientAction getPrimaryClientAction(MutableUINode bean)
public static void setPrimaryClientAction(MutableUINode bean, ClientAction primaryClientAction)
public static java.lang.String getText(MutableUINode bean)
public static void setText(MutableUINode bean, java.lang.String text)
public static void setTranslatableText(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 void setTextBinding(MutableUINode bean, BoundValue boundValue)
boundValue
- a BoundValue implementation to be used
to retrieve the value.public static void setTextBinding(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 setTextBinding(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 getDestination(MutableUINode bean)
public static void setDestination(MutableUINode bean, java.lang.String destination)
public static char getAccessKey(MutableUINode bean)
destination
is set, or
the 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
text
attribute of this StyledText 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().
getLabeledNodeID()
,
setLabeledNodeID(java.lang.String)
,
getText()
,
setText(java.lang.String)
,
NodeUtils.setTextAndAccessKey(oracle.cabo.ui.MutableUINode, java.lang.String)
public static void setAccessKey(MutableUINode bean, char accessKey)
destination
is set, or
the 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
text
attribute of this StyledText 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().
getLabeledNodeID()
,
setLabeledNodeID(java.lang.String)
,
getText()
,
setText(java.lang.String)
,
NodeUtils.setTextAndAccessKey(oracle.cabo.ui.MutableUINode, java.lang.String)
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.BaseWebBean.getID()
,
BaseWebBean.setID(java.lang.String)
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.BaseWebBean.getID()
,
BaseWebBean.setID(java.lang.String)
public static int getTruncateAt(MutableUINode bean)
public static void setTruncateAt(MutableUINode bean, int truncateAt)
public static java.lang.String getDescription(MutableUINode bean)
public static void setDescription(MutableUINode bean, java.lang.String description)
public static void setTranslatableDescription(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 ResourceBundle
|
UIX 2.2.16 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |