|
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.table.TotalRowBean
This bean is not supported on the following agent types: pda.
The TotalRowBean, when when used inside a TableBean,
will cause a special TableRow to be rendered which lets users see the
totals of one or more columns. To use the TotalRowBean, set it
as the columnFooter
child of the TableBean.
There are two customizations clients can make to the TotalRowBean. First,
the text of the update button can be customized. By default, the button will
display a localized version of the text "Update". If this is not satisfactory,
clients can change the button text altogether by setting the
text
property to the desired text.
The other customization is the destination of the button when clicked. By default, the destination will use either form submission or URL arguments, depending on which is turned on in the parent table. If form submission is used, the TotalRowBean will submit the table's form with an "event" form value set to "update" and a "source" form value set to the name of the table. If URL argument links are used, the same two key/value pairs will be sent as parameters. See the TableBean documentation for more details.
If the standard destinations are not suitable, clients can override the
destination by setting the destination
property
of the TotalRowBean to the desired value.
Also, to display the actual total data cells in the TotalRowBean, clients should add indexed children to this bean. If one indexed child is added to a TotalRowBean, it will be rendered under the rightmost column of its parent table. If two indexed children are added to the TotalRowBean, each one will be rendered in turn under the two rightmost columns of the parent table. The presence of grid lines and the alignment of the TotalRowBean's children is also determined by the data in the corresponding table columns.
Finally, in the rare cases where a table needs the ability to add rows and
total columns as well, clients can use both an AddTableRowBean
and TotalRowBean
together. To do this, create and configure
both beans, then add the TotalRowBean
as an indexed child
of the AddTableRowBean
. Then add the
AddTableRowBean
as the columnFooter
child as usual.
In the following example, we create a total row. The right most column how has a total row element, which is a text field with the value 42.
<table ...> <columnFooter> <totalRow> <contents> <textInput name="total" text="42"/> </contents> </totalRow> </columnFooter> </table>
UIConstants
,
TableBean
,
AddTableRowBean
Constructor Summary | |
|
TotalRowBean()
Construct an instance of the TotalRowBean. |
protected |
TotalRowBean(boolean ignored,
java.lang.String localName)
Construct an instance of the TotalRowBean. |
|
TotalRowBean(java.lang.String destination)
Construct an instance of the TotalRowBean. |
|
TotalRowBean(java.lang.String text,
java.lang.String destination)
Construct an instance of the TotalRowBean. |
Method Summary | |
java.lang.String |
getDestination()
Gets the URI this button references. |
static java.lang.String |
getDestination(MutableUINode bean)
Gets the URI this button references. |
java.lang.String |
getText()
Gets the text to display in the button. |
static java.lang.String |
getText(MutableUINode bean)
Gets the text to display in the button. |
boolean |
isReadOnly()
Gets if set to true prevents the button from being rendered. |
static boolean |
isReadOnly(MutableUINode bean)
Gets if set to true prevents the button from being rendered. |
static void |
setDestination(MutableUINode bean,
java.lang.String destination)
Sets the URI this button references. |
void |
setDestination(java.lang.String destination)
Sets the URI this button references. |
void |
setReadOnly(boolean readOnly)
Sets if set to true prevents the button from being rendered. |
static void |
setReadOnly(MutableUINode bean,
boolean readOnly)
Sets if set to true prevents the button from being rendered. |
static void |
setText(MutableUINode bean,
java.lang.String text)
Sets the text to display in the button. |
void |
setText(java.lang.String text)
Sets the text to display in the button. |
static void |
setTranslatableText(MutableUINode bean,
java.lang.String bundleName,
java.lang.String key)
Binds to a ResourceBundle the the text to display in the button. |
void |
setTranslatableText(java.lang.String bundleName,
java.lang.String key)
Binds to a ResourceBundle the the text to display in the button. |
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 TotalRowBean()
public TotalRowBean(java.lang.String text, java.lang.String destination)
text
- the text to display in the button.destination
- the URI this button references.public TotalRowBean(java.lang.String destination)
destination
- the URI this button references.protected TotalRowBean(boolean ignored, java.lang.String localName)
Method Detail |
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 boolean isReadOnly()
public final void setReadOnly(boolean readOnly)
public final java.lang.String getDestination()
public final void setDestination(java.lang.String destination)
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 boolean isReadOnly(MutableUINode bean)
public static void setReadOnly(MutableUINode bean, boolean readOnly)
public static java.lang.String getDestination(MutableUINode bean)
public static void setDestination(MutableUINode bean, java.lang.String destination)
|
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 |