Oracle UIX API Reference
Release 2.1.22.0.0
B12196-01

oracle.cabo.ui.beans.table
Class SortableHeaderBean

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
                                      |
                                      +--oracle.cabo.ui.beans.message.MessageStyledTextBean
                                            |
                                            +--oracle.cabo.ui.beans.table.SortableHeaderBean
All Implemented Interfaces:
MessageBean, MutableUINode, UIConstants, UINode
Direct Known Subclasses:
SortableHeaderBean

public class SortableHeaderBean
extends MessageStyledTextBean

The SortableHeaderBean is a convenience bean intended to be used as a "stamp" for column headers in a TableBean which need to allow sorting. The SortableHeaderBean allows clients to create easily TableBean column headers that implement sorting and display any desired status and messaging icons.

The SortableHeaderBean uses many of the attributes of its parent bean, the MessageStyledTextBean. Clients can use the API of that bean to set the display text or its binding, or any of the message or status icons and their bindings. However, the SortableHeaderBean uses one additional attribute in its rendering: sortable. When a TableBean renders a SortableHeaderBean, it uses the value of the "sortable" attribute to determine whether or not to render that column header as sortable and, if necessary, whether to flag the column as being sorted in ascending or descending order.

There are 4 different values which can be set against the "sortable" attribute. By default, or if no value is set for this attribute, or if the UIConstant SORTABLE_NO is returned as the value, the column header is not rendered as sortable. If the UIConstant SORTABLE_YES is returned as the value, the column header is rendered as sortable. If the SORTABLE_ASCENDING constant is returned, the column is rendered as sortable and currently sorted in ascending order. Similarly, if the SORTABLE_DESCENDING constant is returned, the column is rendered as sortable and sorted in descending order.

When specified as being sorted in ascending order, an "up" arrow will be rendered in the header to indicate that values increase when read down. When specified as being sorted in descending order, a "down" arrow will be rendered in the header to indicate that values increase when read up the column. No arrow is shown for the SORTABLE_YES value.

If a destination property is set or bound on this bean, that value will be used as the destination for the links rendered in the sortable headers. If not, the destination links generated by a sortable header make use of four properties and their established values:

  1. the "event" property, with the value "sort"
  2. the "source" property, with the value taken as the name of the table containing the SortableHeaderBean
  3. the "value" property, which will be the data bound to this bean's "value" property, or if nothing is bound, the zero-based index of the column to sort
  4. the "state" property, with the value "ascending" if this column is currently sorted in ascending order, or "descending" if this column is currenly sorted in descending order
If this SortableHeaderBean is used in a TableBean which uses form submission, those properties and values will be submitted as form values. Otherwise, those four values will be appended as URL arguments to the "destination" attribute on the TableBean.

See the TableBean and NavigationBarBean documentation for more examples of how automatically generated links are created in TableBeans.

Example:

In the following example, the table has three columns. The first is sorted in ascending order. The second is sortable, while the third is not sortable.

 <table ... >
  <columnHeaderStamp>
   <sortableHeader data:text="textKey" data:sortable="sortKey"/>
  </columnHeaderStamp>
  <columnHeaderData>
   <col textKey="Name" sortKey="ascending"/>
   <col textKey="Age" sortKey="yes"/>
   <col textKey="Phone" sortKey="no"/>
  </columnHeaderData>
  ...
 </table>

See Also:
TableBean, MessageStyledTextBean, UIConstants

Fields inherited from interface oracle.cabo.ui.UIConstants
ABOUT_CHILD, ACCESS_KEY_ATTR, ADD_NAME, ADD_ROWS_EVENT, ADD_TABLE_ROW_NAME, AGENT_NAME, ALL_DETAILS_ENABLED_ATTR, ALTERNATE_CONTENT_CHILD, ALTERNATE_TEXT_ATTR, ANCESTOR_ATTRIBUTE_NAME, ANCESTOR_ID_ATTR, ANCESTOR_PATH_ATTR, ANCHOR_ATTR, AND_NAME, APPLICATION_SWITCHER_NAME, ARRAY_NODE_LIST_NAME, ATTRIBUTE_MAP_NAME, AUTOFLIP_ATTR, AUTOMATIC_ATTR, AUTOSTART_ATTR, BACKGROUND_ATTR, BACKGROUND_DARK, BACKGROUND_LIGHT, BACKGROUND_MEDIUM, BANDING_INTERVAL_KEY, BANDING_SHADE_DARK, BANDING_SHADE_KEY, BANDING_SHADE_LIGHT, BEAN_NAME, BETWEEN_TEXT_ATTR, BLOCK_SIZE_ATTR, BODY_NAME, BORDER_LAYOUT_NAME, BORDER_WIDTH_ATTR, BOTTOM_CHILD, BOUND_ATTRIBUTE_NAME, BOUND_MESSAGE_NAME, BOUND_TEXT_NAME, BOUND_VALUE_PROVIDER_NAME, BREAD_CRUMBS_NAME, BROWSE_EVENT, BROWSE_MENU_NAME, BULLETED_LIST_NAME, BUNDLE_NAME, BUTTON_NAME, BYTE_LENGTH_NAME, CALENDAR_NAME, CANCEL_EVENT, CASE_NAME, CATCH_CHILD, CATEGORIES_CHILD, CATEGORY_TITLE_ATTR, CELL_FORMAT_NAME, CELL_NO_WRAP_FORMAT_KEY, CELL_PADDING_ATTR, CELL_SPACING_ATTR, CENTER_CHILD, CHECK_BOX_NAME, CHECKED_ATTR, CHILD_DATA_ATTR, CHILD_LIST_NAME, CHILD_MAP_NAME, CHILD_NAME_ATTR, CHOICE_NAME, COBRANDING_CHILD, COLLAPSE_ALL_EVENT, COLLAPSE_DESTINATION_KEY, COLUMN_BANDING, COLUMN_DATA_FORMAT_KEY, COLUMN_FOOTER_CHILD, COLUMN_FORMAT_ATTR, COLUMN_FORMATS_ATTR, COLUMN_GROUP_NAME, COLUMN_HEADER_CHILD, COLUMN_HEADER_DATA_ATTR, COLUMN_HEADER_FORMAT_ATTR, COLUMN_HEADER_FORMATS_ATTR, COLUMN_HEADER_STAMP_CHILD, COLUMN_NAME, COLUMN_SPAN_ATTR, COLUMNS_ATTR, COMPARISON_NAME, COMPARISON_TYPE_EQUALS, COMPARISON_TYPE_GREATER_THAN, COMPARISON_TYPE_GREATER_THAN_OR_EQUALS, COMPARISON_TYPE_LESS_THAN, COMPARISON_TYPE_LESS_THAN_OR_EQUALS, COMPARISON_TYPE_NOT_EQUALS, COMPOSITE_ROLE, CONCAT_NAME, CONCISE_MESSAGE_CHILD, CONSUMER_NAME, CONTENT_CONTAINER_NAME, CONTENT_FOOTER_CHILD, CONTENT_FOOTER_NAME, CONTENT_FORM_CHILD, CONTENT_LINK_CHILD, CONTENT_STYLE_CLASS_ATTR, CONTENT_TYPE_ATTR, CONTENTS_NAME, CONTEXT_POPPING_NAME, CONTEXT_PROPERTY_NAME, CONTEXT_SWITCHER_CHILD, CONTROLS_ALL, CONTROLS_ATTR, CONTROLS_MINIMAL, CONTROLS_NONE, CONTROLS_NONE_VISIBLE, CONTROLS_TYPICAL, COPYRIGHT_CHILD, CORPORATE_BRANDING_CHILD, CURRENT_DATA_ATTR, CURRENT_THROWABLE_PROPERTY, DATA_KEY, DATA_NAME, DATA_NAME_ATTR, DATA_NAMESPACE_ATTR, DATA_OBJECT_NAME, DATA_SCOPE_NAME, DATE_BUTTON_NAME, DATE_EVENT, DATE_FIELD_NAME, DATE_FORMAT_NAME, DATE_NAME, DECIMAL_NAME, DEFAULT_CASE_ATTR, DEFAULT_CONTENTS_ATTR, DEFAULT_NAME, DEFAULTING_NAME, DESCRIPTION_KEY, DESTINATION_ATTR, DESTINATION_KEY, DESTINATION_TEXT_KEY, DETAIL_CHILD, DETAIL_DISCLOSURE_ATTR, DETAIL_SELECTOR_NAME, DETAILED_MESSAGE_CHILD, DIRECTION_ATTR, DIRTY_ATTR, DISABLED_ATTR, DISCLOSED_ATTR, DISCLOSED_KEY, DISCLOSED_TEXT_ATTR, DISPLAY_EXCEPTION_NAME, DISPLAY_GRID_KEY, DOCUMENT_NAME, ENCODED_PARAMETER_NAME, END_CHILD, EVENT_PARAM, EXCEPTIONS_CAUGHT_PROPERTY, EXPAND_ALL_EVENT, EXPAND_DESTINATION_KEY, EXPAND_EVENT, EXPANDABLE_COLLAPSED, EXPANDABLE_EXPANDED, EXPANDABLE_KEY, EXPANDABLE_NO, FACET_DEFAULT, FACET_EMAIL, FACET_PORTLET, FACET_PRINTABLE, FIELD_WIDTH_ATTR, FILE_UPLOAD_NAME, FILTER_CHILD, FILTER_CHOICE_CHILD, FIXED_NAME, FLOW_LAYOUT_NAME, FOCUS_EVENT, FOOTER_NAME, FOOTNOTE_CHILD, FORM_DATA_ATTR, FORM_NAME, FORM_NAME_ATTR, FORM_NAME_PROPERTY, FORM_PARAMETER_NAME, FORM_SUBMITTED_ATTR, FORM_VALUE_NAME, FORMAT_NAME, FORMATTED_TEXT_NAME, FRAME_BORDER_LAYOUT_NAME, FRAME_NAME, GENERATES_CONTENT_ATTR, GLOBAL_BUTTON_BAR_NAME, GLOBAL_BUTTON_NAME, GLOBAL_BUTTONS_CHILD, GLOBAL_HEADER_NAME, GOTO_EVENT, H_ALIGN_ATTR, H_ALIGN_CENTER, H_ALIGN_END, H_ALIGN_LEFT, H_ALIGN_RIGHT, H_ALIGN_START, H_GRID_NAME, HARD_WRAP, HEAD_NAME, HEADER_INSTRUCTIONS_CHILD, HEADER_NAME, HEADERS_ATTR, HEIGHT_ATTR, HIDE_EVENT, HIDE_SHOW_HEADER_NAME, HIDE_SHOW_NAME, ICON_ATTR, ICON_BUTTON_FORMAT, ICON_KEY, ID_ATTR, IF_NAME, IMAGE_ATTR, IMAGE_MAP_TYPE_ATTR, IMAGE_MAP_TYPE_NONE, IMAGE_MAP_TYPE_SERVER, IMAGE_NAME, IMPORT_SCRIPT_NAME, INCLUDE_NAME, INLINE_MESSAGE_NAME, INLINE_NAME, INLINE_STYLE_ATTR, INNER_BOTTOM_CHILD, INNER_END_CHILD, INNER_HEIGHT_ATTR, INNER_LEFT_CHILD, INNER_RIGHT_CHILD, INNER_START_CHILD, INNER_TOP_CHILD, INNER_WIDTH_ATTR, INSERTED_NODE_LIST_NAME, INSTANCE_NAME, ITEM_TITLE_ATTR, ITEMS_CHILD, LABEL_CHILD, LABEL_WIDTH_ATTR, LABELED_FIELD_LAYOUT_NAME, LABELED_NODE_ID_ATTR, LANGUAGE_ATTR, LARGE_ADVERTISEMENT_CHILD, LEADING_CHILD, LEADING_DESC_SHOWN_ATTR, LEADING_FOOTER_CHILD, LEADING_HEADER_ATTR, LEFT_CHILD, LINK_NAME, LIST_NAME, LIST_OF_VALUES_NAME, LIST_STYLE_ATTR, LIST_STYLE_CIRCLE, LIST_STYLE_DECIMAL, LIST_STYLE_DISC, LIST_STYLE_LOWER_ALPHA, LIST_STYLE_NONE, LIST_STYLE_SQUARE, LIST_STYLE_UPPER_ALPHA, LOCATION_CHILD, LOCATION_PARAM, LONG_DESC_ATTR, LONG_DESC_URL_ATTR, LOV_EVENT, LOV_FIELD_NAME, LOV_FILTER_EVENT, LOV_INPUT_NAME, LOV_LIBRARY_NAME, LOV_SEARCH_TEXT, MAILTO_NAME, MARLIN_NAMESPACE, MAX_VALUE_ATTR, MAX_VALUE_UNKNOWN, MAX_VISITED_ATTR, MAXIMUM_LENGTH_ATTR, MEDIA_NAME, MEDIUM_ADVERTISEMENT_CHILD, MESSAGE_ATTR, MESSAGE_BOX_NAME, MESSAGE_CHECK_BOX_NAME, MESSAGE_CHOICE_NAME, MESSAGE_DATE_FIELD_NAME, MESSAGE_FILE_UPLOAD_NAME, MESSAGE_FORMAT_NAME, MESSAGE_LIST_NAME, MESSAGE_LOV_FIELD_NAME, MESSAGE_LOV_INPUT_NAME, MESSAGE_PROMPT_NAME, MESSAGE_RADIO_BUTTON_NAME, MESSAGE_RADIO_GROUP_NAME, MESSAGE_STYLED_TEXT_NAME, MESSAGE_TEXT_INPUT_NAME, MESSAGE_TEXT_NAME, MESSAGE_TYPE_ATTR, MESSAGE_TYPE_CONFIRMATION, MESSAGE_TYPE_ERROR, MESSAGE_TYPE_INFO, MESSAGE_TYPE_NONE, MESSAGE_TYPE_PROCESSING, MESSAGE_TYPE_WARNING, MESSAGES_CHILD, META_CONTAINER_CHILD, METHOD_ATTR, METHOD_NAME, MIN_VALUE_ATTR, MINIMUM_WIDTH_ATTR, MULTIPLE_ATTR, MULTIPLE_SELECTION_NAME, NAME_ATTR, NAME_TRANSFORMED_ATTR, NAME_VALUES_ATTR, NAMED_SOURCE_ATTR, NAMES_ATTR, NAVIGATE_EVENT, NAVIGATION_BAR_NAME, NAVIGATION_FORM_NAME_ATTR, NO_BANDING, NODE_ATTR, NODE_PARAM, NODE_STAMP_CHILD, NODES_ATTR, NODES_KEY, NOT_NAME, NUMBER_FORMAT, ON_BLUR_ATTR, ON_BLUR_VALIDATER_ATTR, ON_CHANGE_ATTR, ON_CLICK_ATTR, ON_CLICK_KEY, ON_DOUBLE_CLICK_ATTR, ON_FOCUS_ATTR, ON_KEY_DOWN_ATTR, ON_KEY_PRESS_ATTR, ON_KEY_UP_ATTR, ON_LOAD_ATTR, ON_LOV_INIT_ATTR, ON_LOV_SELECT_ATTR, ON_LOV_VALIDATE_ATTR, ON_MOUSE_DOWN_ATTR, ON_MOUSE_MOVE_ATTR, ON_MOUSE_OUT_ATTR, ON_MOUSE_OVER_ATTR, ON_MOUSE_UP_ATTR, ON_NAVIGATE_ATTR, ON_SELECT_ATTR, ON_SUBMIT_ATTR, ON_SUBMIT_VALIDATER_ATTR, ON_SWITCH_APP_ATTR, ON_UNLOAD_ATTR, OPTION_NAME, OR_NAME, ORIENTATION_ATTR, ORIENTATION_BOTTOM, ORIENTATION_DEFAULT, ORIENTATION_HORIZONTAL, ORIENTATION_TOP, ORIENTATION_VERTICAL, PAGE_BUTTON_BAR_NAME, PAGE_BUTTONS_CHILD, PAGE_HEADER_CHILD, PAGE_HEADER_LAYOUT_NAME, PAGE_LAYOUT_NAME, PAGE_STATUS_CHILD, PARSE_NAME, PARTIAL_CONTENT_NAME, PARTIAL_LINK_NAME, PARTIAL_NODE_ID_ATTR, PARTIAL_PAGE_CONTEXT_PROPERTY, PARTIAL_PARAM, PARTIAL_RENDER_ENABLED_ATTR, PARTIAL_RENDER_MODE_ATTR, PARTIAL_RENDER_MODE_MULTIPLE, PARTIAL_RENDER_MODE_NONE, PARTIAL_RENDER_MODE_SELF, PARTIAL_ROOT_NAME, PARTIAL_SUBMIT_BUTTON_NAME, PARTIAL_TARGET_IDS_ATTR, PARTIAL_TARGETS_ATTR, PARTIAL_TARGETS_PARAM, PERCENT_COMPLETE_ATTR, PERCENT_UNKNOWN, PLAY_COUNT_ATTR, PLAYER_ATTR, PLAYER_LINK, PLAYER_QUICKTIME, PLAYER_REAL, PLAYER_WINDOWS, PORTLET_NAME, POST_TEXT_ATTR, PRE_TEXT_ATTR, PRIMARY_CLIENT_ACTION_ATTR, PRIVACY_CHILD, PROCESS_STEPS_NAME, PROCESSING_LAYOUT_NAME, PROCESSING_NAME, PRODUCT_BRANDING_CHILD, PRODUCT_BRANDING_NAME, PROMPT_ATTR, PROMPT_CHILD, PROVIDER_ATTR, PROXIED_ATTR, PROXY_ATTR, QUICK_LINKS_NAME, QUICK_LINKS_SHOWN_ATTR, QUICK_SEARCH_CHILD, RADIO_BUTTON_NAME, RADIO_GROUP_NAME, RADIO_GROUP_TYPE_CHOICE, RADIO_GROUP_TYPE_RADIO, RADIO_OPTION_NAME, RADIO_SET_NAME, RAW_TEXT_NAME, READ_ONLY_ATTR, REFRESH_EVENT, REG_EXP_NAME, RENDERED_ATTR, REORDERABLE_ATTR, REQUIRED_ATTR, REQUIRED_NO, REQUIRED_UI_ONLY, REQUIRED_VALIDATER_ONLY, REQUIRED_YES, RESET_BUTTON_NAME, RETURN_NAVIGATION_CHILD, RIGHT_CHILD, ROOT_ATTRIBUTE_MAP_NAME, ROOT_CHILD_EXISTS_NAME, ROOT_CHILD_LIST_NAME, ROOT_CHILD_MAP_NAME, ROOT_CHILD_NAME, ROOT_PARAM, ROW_BANDING, ROW_FORMATS_ATTR, ROW_HEADER_DATA_ATTR, ROW_HEADER_FORMATS_ATTR, ROW_HEADER_STAMP_CHILD, ROW_LAYOUT_NAME, ROW_SPAN_ATTR, ROWS_ATTR, SAMPLE_NAME, SCRIPT_NAME, SCROLLED_VALUE_ATTR, SCROLLING_ATTR, SCROLLING_AUTO, SCROLLING_NO, SCROLLING_YES, SEARCH_INSTRUCTIONS_CHILD, SEARCH_TEXT_ATTR, SECRET_ATTR, SELECT_ATTR, SELECTED_ATTR, SELECTED_INDEX_ATTR, SELECTED_KEY, SELECTED_VALUE_ATTR, SELECTION_ATTR, SELECTION_PARAM, SEPARATOR_CHILD, SEPARATOR_NAME, SERVER_VALIDATER_ATTR, SERVLET_INCLUDE_NAME, SHORT_DESC_ATTR, SHORT_TEXT_ATTR, SHOW_ALL_ACTIVE, SHOW_ALL_ATTR, SHOW_ALL_NO, SHOW_ALL_YES, SHOW_EVENT, SHOW_WINDOW_ATTR, SHUTTLE_NAME, SIDE_BAR_NAME, SIDE_NAV_NAME, SINGLE_SELECTION_NAME, SINGLE_STEP, SIZE_ATTR, SIZE_PARAM, SLIM_ATTR, SOFT_WRAP, SORT_EVENT, SORT_STATE_ASCENDING, SORT_STATE_DESCENDING, SORTABLE_ASCENDING, SORTABLE_ATTR, SORTABLE_DESCENDING, SORTABLE_HEADER_NAME, SORTABLE_NO, SORTABLE_YES, SOURCE_ATTR, SOURCE_PARAM, SPACER_NAME, STACK_LAYOUT_NAME, STANDBY_TEXT_ATTR, START_CHILD, STATE_PARAM, STATE_ROLE, STEPS_COMPLETE_ATTR, STRUCTURAL_ROLE, STYLE_CLASS_ATTR, STYLE_SHEET_NAME, STYLED_ITEM_NAME, STYLED_LIST_NAME, STYLED_TEXT_NAME, SUB_TAB_BAR_NAME, SUB_TAB_LAYOUT_NAME, SUB_TABS_CHILD, SUBMIT_BUTTON_NAME, SUMMARY_ATTR, SWITCH_APP_EVENT, SWITCH_APP_TYPE_BACK, SWITCH_APP_TYPE_GOTO, SWITCHER_NAME, TAB_BAR_NAME, TABLE_BANDING_KEY, TABLE_DATA_ATTR, TABLE_FILTER_CHILD, TABLE_FORMAT_ATTR, TABLE_LAYOUT_NAME, TABLE_NAME, TABLE_NAME_ATTR, TABLE_SELECTION_CHILD, TABS_CHILD, TARGET_FRAME_ATTR, TARGET_FRAME_KEY, TEMPLATE_DEFINITION_NAME, TEMPLATE_IMPORT_NAME, TEMPLATE_LIBRARY_NAME, TEMPLATES_NAME, TEXT_ATTR, TEXT_FORMAT, TEXT_INPUT_NAME, TEXT_KEY, TEXT_NAME, THREADED_ATTR, THREADED_LAYOUT_NAME, TIME_INTERVAL_ATTR, TIP_ATTR, TIP_NAME, TITLE_ATTR, TOP_CHILD, TOTAL_ROW_NAME, TRAILING_CHILD, TRAILING_DESC_SHOWN_ATTR, TRAILING_FOOTER_CHILD, TRAILING_HEADER_ATTR, TRAIN_NAME, TREE_DATA_ATTR, TREE_NAME, TRY_NAME, TYPE_ATTR, TYPE_PARAM, TYPE_POST, TYPE_PRE, TYPE_TEXT_ATTR, UNDISCLOSED_TEXT_ATTR, UNKNOWN_ROLE, UNVALIDATED_ATTR, UPDATE_EVENT, URI_PARAM, URL_INCLUDE_NAME, USER_INFO_CHILD, USER_INVISIBLE_ROLE, USES_UPLOAD_ATTR, UTF8_LENGTH_NAME, V_ALIGN_ABSMIDDLE, V_ALIGN_ATTR, V_ALIGN_BOTTOM, V_ALIGN_MIDDLE, V_ALIGN_TOP, VALID_ATTR, VALIDATE_BLANKS_ATTR, VALUE_ATTR, VALUE_COLUMNS_ATTR, VALUE_PARAM, VALUE_SHOW_ALL, WIDTH_ATTR, WIDTH_KEY, WML_NAME, WRAP_ATTR, WRAPPING_DISABLED_ATTR
 
Constructor Summary
  SortableHeaderBean()
          Construct an instance of the SortableHeaderBean.
protected SortableHeaderBean(boolean ignored, java.lang.String localName)
          Construct an instance of the SortableHeaderBean.
 
Method Summary
 java.lang.String getSortable()
          Gets the UIConstant indicating if this column header is rendered as sortable.
static java.lang.String getSortable(MutableUINode bean)
          Gets the UIConstant indicating if this column header is rendered as sortable.
 java.lang.String getValue()
          Gets the value submitted when this column is sorted.
static java.lang.String getValue(MutableUINode bean)
          Gets the value submitted when this column is sorted.
static void setSortable(MutableUINode bean, java.lang.String sortable)
          Sets the UIConstant indicating if this column header is rendered as sortable.
 void setSortable(java.lang.String sortable)
          Sets the UIConstant indicating if this column header is rendered as sortable.
 void setSortableBinding(BoundValue boundValue)
          Binds the the UIConstant indicating if this column header is rendered as sortable.
static void setSortableBinding(MutableUINode bean, BoundValue boundValue)
          Binds the the UIConstant indicating if this column header is rendered as sortable.
static void setSortableBinding(MutableUINode bean, java.lang.Object selectKey)
          Binds the the UIConstant indicating if this column header is rendered as sortable.
static void setSortableBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
          Binds the the UIConstant indicating if this column header is rendered as sortable.
 void setSortableBinding(java.lang.Object selectKey)
          Binds the the UIConstant indicating if this column header is rendered as sortable.
 void setSortableBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
          Binds the the UIConstant indicating if this column header is rendered as sortable.
static void setValue(MutableUINode bean, java.lang.String value)
          Sets the value submitted when this column is sorted.
 void setValue(java.lang.String value)
          Sets the value submitted when this column is sorted.
 void setValueBinding(BoundValue boundValue)
          Binds the the value submitted when this column is sorted.
static void setValueBinding(MutableUINode bean, BoundValue boundValue)
          Binds the the value submitted when this column is sorted.
static void setValueBinding(MutableUINode bean, java.lang.Object selectKey)
          Binds the the value submitted when this column is sorted.
static void setValueBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
          Binds the the value submitted when this column is sorted.
 void setValueBinding(java.lang.Object selectKey)
          Binds the the value submitted when this column is sorted.
 void setValueBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
          Binds the the value submitted when this column is sorted.
 
Methods inherited from class oracle.cabo.ui.beans.message.MessageStyledTextBean
getAnchor, getAnchor, getContentStyleClass, getContentStyleClass, getEnd, getEnd, getLongDescURL, getLongDescURL, getMessage, getMessage, getMessageType, getMessageType, getPrompt, getPrompt, getRequired, getRequired, getTargetFrame, getTargetFrame, getTip, getTip, getVAlign, getVAlign, setAnchor, setAnchor, setContentStyleClass, setContentStyleClass, setEnd, setEnd, setLongDescURL, setLongDescURL, setLongDescURLBinding, setLongDescURLBinding, setLongDescURLBinding, setLongDescURLBinding, setLongDescURLBinding, setLongDescURLBinding, setMessage, setMessage, setMessageBinding, setMessageBinding, setMessageBinding, setMessageBinding, setMessageBinding, setMessageBinding, setMessageType, setMessageType, setMessageTypeBinding, setMessageTypeBinding, setMessageTypeBinding, setMessageTypeBinding, setMessageTypeBinding, setMessageTypeBinding, setPrompt, setPrompt, setRequired, setRequired, setTargetFrame, setTargetFrame, setTip, setTip, setTranslatablePrompt, setTranslatablePrompt, setTranslatableTip, setTranslatableTip, setVAlign, setVAlign
 
Methods inherited from class oracle.cabo.ui.beans.StyledTextBean
getAccessKey, getAccessKey, getDestination, getDestination, getLabeledNodeID, getLabeledNodeID, getText, getText, setAccessKey, setAccessKey, setDestination, setDestination, setLabeledNodeID, setLabeledNodeID, setText, setText, setTextBinding, setTextBinding, setTextBinding, setTextBinding, setTextBinding, setTextBinding, setTranslatableText, setTranslatableText
 
Methods inherited from class oracle.cabo.ui.beans.MarlinBean
isEqualMarlinName
 
Methods inherited from class oracle.cabo.ui.beans.BaseWebBean
getDirection, getID, getID, getInlineStyle, getInlineStyle, getLanguage, getOnClick, getOnClick, getOnDoubleClick, getOnDoubleClick, getOnKeyDown, getOnKeyDown, getOnKeyPress, getOnKeyPress, getOnKeyUp, getOnKeyUp, getOnMouseDown, getOnMouseDown, getOnMouseMove, getOnMouseMove, getOnMouseOut, getOnMouseOut, getOnMouseOver, getOnMouseOver, getOnMouseUp, getOnMouseUp, getShortDesc, getShortDesc, getStyleClass, getStyleClass, isRendered, isRendered, resolveBoolean, resolveBoolean, resolveBoolean, resolveBoolean, resolveCharacter, resolveCharacter, resolveInteger, resolveInteger, resolveInteger, resolveInteger, resolveLong, resolveLong, resolveLong, resolveLong, resolveObject, resolveString, resolveString, setDirection, setID, setID, setInlineStyle, setInlineStyle, setLanguage, setOnClick, setOnClick, setOnDoubleClick, setOnDoubleClick, setOnKeyDown, setOnKeyDown, setOnKeyPress, setOnKeyPress, setOnKeyUp, setOnKeyUp, setOnMouseDown, setOnMouseDown, setOnMouseMove, setOnMouseMove, setOnMouseOut, setOnMouseOut, setOnMouseOver, setOnMouseOver, setOnMouseUp, setOnMouseUp, setRendered, setRendered, setShortDesc, setShortDesc, setStyleClass, setStyleClass
 
Methods inherited from class oracle.cabo.ui.BaseMutableUINode
addIndexedChild, addIndexedChild, addIndexedChild, addIndexedChildren, addIndexedChildren, clearIndexedChildren, createAttributeMap, createIndexedNodeList, createNamedChildMap, getAttributeMap, getAttributeMap, getAttributeValue, getAttributeValue, getIndexedChildCount, getIndexedNodeList, getIndexedNodeList, getNamedChildMap, getNamedChildMap, removeIndexedChild, replaceIndexedChild, setAttributeDictionary, setAttributeMap, setAttributeValue, setAttributeValue, setAttributeValue, setIndexedNodeList, setNamedChild, setNamedChildMap, setNodeID
 
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.MutableUINode
addIndexedChild, addIndexedChild, clearIndexedChildren, getAttributeValue, removeIndexedChild, replaceIndexedChild, setAttributeValue, setAttributeValue, setAttributeValue, setID, setNamedChild, setNodeID
 
Methods inherited from interface oracle.cabo.ui.UINode
getAttributeNames, getAttributeValue, getAttributeValue, getChildNames, getChildNames, getID, getIndexedChild, getIndexedChild, getIndexedChildCount, getIndexedChildCount, getLocalName, getNamedChild, getNamedChild, getNamespaceURI, getNodeID, getNodeRole, getRawAttributeValue, render, render
 

Constructor Detail

SortableHeaderBean

public SortableHeaderBean()
Construct an instance of the SortableHeaderBean.

SortableHeaderBean

protected SortableHeaderBean(boolean ignored,
                             java.lang.String localName)
Construct an instance of the SortableHeaderBean. Provided for subclasses that need distinct local names..
Method Detail

getSortable

public final java.lang.String getSortable()
Gets the UIConstant indicating if this column header is rendered as sortable.

setSortable

public final void setSortable(java.lang.String sortable)
Sets the UIConstant indicating if this column header is rendered as sortable.

setSortableBinding

public final void setSortableBinding(BoundValue boundValue)
Binds the the UIConstant indicating if this column header is rendered as sortable.
Parameters:
boundValue - a BoundValue implementation to be used to retrieve the value.

setSortableBinding

public final void setSortableBinding(java.lang.Object selectKey)
Binds the the UIConstant indicating if this column header is rendered as sortable.
Parameters:
selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setSortableBinding

public final void setSortableBinding(java.lang.String dataNamespace,
                                     java.lang.String dataName,
                                     java.lang.Object selectKey)
Binds the the UIConstant indicating if this column header is rendered as sortable.
Parameters:
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.

getValue

public final java.lang.String getValue()
Gets the value submitted when this column is sorted.

setValue

public final void setValue(java.lang.String value)
Sets the value submitted when this column is sorted.

setValueBinding

public final void setValueBinding(BoundValue boundValue)
Binds the the value submitted when this column is sorted.
Parameters:
boundValue - a BoundValue implementation to be used to retrieve the value.

setValueBinding

public final void setValueBinding(java.lang.Object selectKey)
Binds the the value submitted when this column is sorted.
Parameters:
selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setValueBinding

public final void setValueBinding(java.lang.String dataNamespace,
                                  java.lang.String dataName,
                                  java.lang.Object selectKey)
Binds the the value submitted when this column is sorted.
Parameters:
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.

getSortable

public static java.lang.String getSortable(MutableUINode bean)
Gets the UIConstant indicating if this column header is rendered as sortable.

setSortable

public static void setSortable(MutableUINode bean,
                               java.lang.String sortable)
Sets the UIConstant indicating if this column header is rendered as sortable.

setSortableBinding

public static void setSortableBinding(MutableUINode bean,
                                      BoundValue boundValue)
Binds the the UIConstant indicating if this column header is rendered as sortable.
Parameters:
boundValue - a BoundValue implementation to be used to retrieve the value.

setSortableBinding

public static void setSortableBinding(MutableUINode bean,
                                      java.lang.Object selectKey)
Binds the the UIConstant indicating if this column header is rendered as sortable.
Parameters:
selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setSortableBinding

public static void setSortableBinding(MutableUINode bean,
                                      java.lang.String dataNamespace,
                                      java.lang.String dataName,
                                      java.lang.Object selectKey)
Binds the the UIConstant indicating if this column header is rendered as sortable.
Parameters:
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.

getValue

public static java.lang.String getValue(MutableUINode bean)
Gets the value submitted when this column is sorted.

setValue

public static void setValue(MutableUINode bean,
                            java.lang.String value)
Sets the value submitted when this column is sorted.

setValueBinding

public static void setValueBinding(MutableUINode bean,
                                   BoundValue boundValue)
Binds the the value submitted when this column is sorted.
Parameters:
boundValue - a BoundValue implementation to be used to retrieve the value.

setValueBinding

public static void setValueBinding(MutableUINode bean,
                                   java.lang.Object selectKey)
Binds the the value submitted when this column is sorted.
Parameters:
selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setValueBinding

public static void setValueBinding(MutableUINode bean,
                                   java.lang.String dataNamespace,
                                   java.lang.String dataName,
                                   java.lang.Object selectKey)
Binds the the value submitted when this column is sorted.
Parameters:
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.

Oracle UIX API Reference
Release 2.1.22.0.0
B12196-01

Copyright © 2002,2003, Oracle. All Rights Reserved.