oracle.cabo.ui.beans.layout
Class HideShowBean

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.layout.HideShowBean

All Implemented Interfaces:

MutableUINode, UIConstants, UINode

public class HideShowBean

extends MarlinBean

Overview

The HideShow provides a means of toggling a group of UINodes between being disclosed or undisclosed. A HideShow should be used to

• hide/show an entire section or a part of a section of information within the contents of a page such as:
• show more information / hide more information,
• show details / hide details,
• show "section name" / hide "section name",
• show graph/hide graph, etc.
• hide/show functionality such as:
• simple/advance search
• hide/show details of a table row

On mobile devices the hideShow renders nothing itself, but does renders its indexed children.

Appearance

If the DISCLOSED attribute on the HideShow is set to false, the icon arrow will point sideways, the prompt child will be rendered next to the arrow, and the children of the HideShow will not be rendered. If the DISCLOSED attribute on the HideShow is set to true, the icon arrow will point down, the prompt child will be rendered next to the arrow, and the children of the HideShow will be rendered.

Events

Clicking on either the icon or the text of the HideShow will send an event to the server. The value of the event's "source" parameter will be the value of the HideShow's ID attribute. The value of the event's "event" parameter will be either "hide" or "show".

Supported Children

The hideShow can have a PROMPT child. This child is rendered next to the hide or show icon. This child defaults to a link. The link's destination is the same as the destination of the hide or show icon. The link's text defaults to "Hide" and "Show", but can be set with the UNDISCLOSED_TEXT and DISCLOSED_TEXT attributes.

Supported Attributes

The ID attribute is used to specify the name which is used to identify the HideShow in client-server events.

The DISCLOSED atrribute toggles the HideShow's children between being disclosed or undisclosed. This attribute may be set to Boolean.TRUE or Boolean.FALSE. By default, this attribute will be Boolean.FALSE.

The text of the HideShow comes from the DISCLOSED_TEXT and UNDISCLOSED_TEXT attributes. In almost all cases, the DISCLOSED_TEXT should consist of the word "Hide" plus a description of the HideShow's children, and the UNDISCLOSED_TEXT should consist of the word "Show" plus a description of the children. The default values for these attributes are "Hide" and "Show".

The FORM_SUBMITTED attribute indicates whether or not to submit data through form submission. The default value is Boolean.FALSE.

The name of the form to be submitted can be specified through the FORM_NAME attribute. If no name is specified, the form to which the HideShow belongs will be used.

If the FORM_SUBMITTED attribute is Boolean.FALSE, the links generated by the HideShow will be URLs based on the DESTINATION attribute. If no destination is specified, the default URL for the page will be used.

The SELECTED attribute indicates whether or not to display the hideShow icon and prompt as selected.

Example:

An interactive hideShow

   <ctrl:content>
 
    <dataScope xmlns="http://xmlns.oracle.com/uix/ui">
      <provider>
        <data name="hideShow">
          <method class="oracle.cabo.doc.demo.HideShowData" method="getData"/>
        </data>
 
      </provider>
      <contents>
 
        <hideShow formSubmitted="true"
                  id="hideShow"
                  data:disclosed="show@hideShow">
          <contents>
            <header text="Header">
              <contents>
                <header text="SubHeader"/>
              </contents>
            </header>
          </contents>
        </hideShow>
      </contents>
     </dataScope>
   </ctrl:content>
 
    <handlers xmlns="http://xmlns.oracle.com/uix/controller">
     <event name="hide">
       <method class="oracle.cabo.doc.demo.HideShowData" method="hideEventHandler"/>
     </event>
 
     <event name="show">
       <method class="oracle.cabo.doc.demo.HideShowData" method="showEventHandler"/>
     </event>
   </handlers>

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

	HideShowBean() Construct an instance of the HideShowBean.
protected	HideShowBean(boolean ignored, java.lang.String localName) Construct an instance of the HideShowBean.
	HideShowBean(java.lang.String id) Construct an instance of the HideShowBean.
	HideShowBean(java.lang.String id, java.lang.String destination) Construct an instance of the HideShowBean.
	HideShowBean(java.lang.String id, java.lang.String disclosedText, java.lang.String undisclosedText) Construct an instance of the HideShowBean.
	HideShowBean(java.lang.String id, java.lang.String disclosedText, java.lang.String undisclosedText, java.lang.String destination) Construct an instance of the HideShowBean.

Method Summary

java.lang.String	getDestination() Gets base destination for the hide/show link.
static java.lang.String	getDestination(MutableUINode bean) Gets base destination for the hide/show link.
java.lang.String	getDisclosedText() Gets the text to display when the children are shown
static java.lang.String	getDisclosedText(MutableUINode bean) Gets the text to display when the children are shown
java.lang.String	getFormName() Gets form to which HideShow events should be submitted.
static java.lang.String	getFormName(MutableUINode bean) Gets form to which HideShow events should be submitted.
java.lang.String	getPartialRenderMode() Gets
static java.lang.String	getPartialRenderMode(MutableUINode bean) Gets
java.lang.String[]	getPartialTargets() Gets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple".
static java.lang.String[]	getPartialTargets(MutableUINode bean) Gets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple".
UINode	getPrompt() Child rendered next to the hide or show icon.
static UINode	getPrompt(MutableUINode bean) Child rendered next to the hide or show icon.
java.lang.String	getUndisclosedText() Gets the text to display when the children are hidden
static java.lang.String	getUndisclosedText(MutableUINode bean) Gets the text to display when the children are hidden
boolean	isDisclosed() Gets whether or not to disclose the children This attribute is not supported on the following agent types: pda.
static boolean	isDisclosed(MutableUINode bean) Gets whether or not to disclose the children This attribute is not supported on the following agent types: pda.
boolean	isFormSubmitted() Gets whether or not to use form sumission in the Hide/Show link.
static boolean	isFormSubmitted(MutableUINode bean) Gets whether or not to use form sumission in the Hide/Show link.
boolean	isSelected() Gets whether or not the hideShow is selected.
static boolean	isSelected(MutableUINode bean) Gets whether or not the hideShow is selected.
boolean	isUnvalidated() Gets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server.
static boolean	isUnvalidated(MutableUINode bean) Gets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server.
static void	setDestination(MutableUINode bean, java.lang.String destination) Sets base destination for the hide/show link.
void	setDestination(java.lang.String destination) Sets base destination for the hide/show link.
void	setDestinationBinding(BoundValue boundValue) Binds the base destination for the hide/show link.
static void	setDestinationBinding(MutableUINode bean, BoundValue boundValue) Binds the base destination for the hide/show link.
static void	setDestinationBinding(MutableUINode bean, java.lang.Object selectKey) Binds the base destination for the hide/show link.
static void	setDestinationBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the base destination for the hide/show link.
void	setDestinationBinding(java.lang.Object selectKey) Binds the base destination for the hide/show link.
void	setDestinationBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the base destination for the hide/show link.
void	setDisclosed(boolean disclosed) Sets whether or not to disclose the children This attribute is not supported on the following agent types: pda.
static void	setDisclosed(MutableUINode bean, boolean disclosed) Sets whether or not to disclose the children This attribute is not supported on the following agent types: pda.
static void	setDisclosedText(MutableUINode bean, java.lang.String disclosedText) Sets the text to display when the children are shown
void	setDisclosedText(java.lang.String disclosedText) Sets the text to display when the children are shown
static void	setFormName(MutableUINode bean, java.lang.String formName) Sets form to which HideShow events should be submitted.
void	setFormName(java.lang.String formName) Sets form to which HideShow events should be submitted.
void	setFormSubmitted(boolean formSubmitted) Sets whether or not to use form sumission in the Hide/Show link.
static void	setFormSubmitted(MutableUINode bean, boolean formSubmitted) Sets whether or not to use form sumission in the Hide/Show link.
static void	setPartialRenderMode(MutableUINode bean, java.lang.String partialRenderMode) Sets
void	setPartialRenderMode(java.lang.String partialRenderMode) Sets
static void	setPartialTargets(MutableUINode bean, java.lang.String[] partialTargets) Sets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple".
void	setPartialTargets(java.lang.String[] partialTargets) Sets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple".
static void	setPrompt(MutableUINode bean, UINode promptNode) Child rendered next to the hide or show icon.
void	setPrompt(UINode promptNode) Child rendered next to the hide or show icon.
void	setSelected(boolean selected) Sets whether or not the hideShow is selected.
static void	setSelected(MutableUINode bean, boolean selected) Sets whether or not the hideShow is selected.
static void	setTranslatableDisclosedText(MutableUINode bean, java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the text to display when the children are shown
void	setTranslatableDisclosedText(java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the text to display when the children are shown
static void	setTranslatableUndisclosedText(MutableUINode bean, java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the text to display when the children are hidden
void	setTranslatableUndisclosedText(java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the text to display when the children are hidden
static void	setUndisclosedText(MutableUINode bean, java.lang.String undisclosedText) Sets the text to display when the children are hidden
void	setUndisclosedText(java.lang.String undisclosedText) Sets the text to display when the children are hidden
void	setUnvalidated(boolean unvalidated) Sets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server.
static void	setUnvalidated(MutableUINode bean, boolean unvalidated) Sets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server.

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

getAttributeNames, getAttributeValue, getAttributeValue, getChildNames, getChildNames, getIndexedChild, getIndexedChild, getIndexedChildCount, getLocalName, getNamedChild, getNamedChild, getNamespaceURI, getNodeID, getNodeRole, getRawAttributeValue, render, render

Constructor Detail

HideShowBean

public HideShowBean()

Construct an instance of the HideShowBean.

HideShowBean

public HideShowBean(java.lang.String id)

Construct an instance of the HideShowBean.

Parameters:

id - the page-wide unique client ID of this node.

HideShowBean

public HideShowBean(java.lang.String id,
                    java.lang.String disclosedText,
                    java.lang.String undisclosedText)

Construct an instance of the HideShowBean.

Parameters:

id - the page-wide unique client ID of this node.

disclosedText - the text to display when the children are shown

undisclosedText - the text to display when the children are hidden

HideShowBean

public HideShowBean(java.lang.String id,
                    java.lang.String destination)

Construct an instance of the HideShowBean.

Parameters:

id - the page-wide unique client ID of this node.

destination - base destination for the hide/show link.

HideShowBean

public HideShowBean(java.lang.String id,
                    java.lang.String disclosedText,
                    java.lang.String undisclosedText,
                    java.lang.String destination)

Construct an instance of the HideShowBean.

Parameters:

id - the page-wide unique client ID of this node.

disclosedText - the text to display when the children are shown

undisclosedText - the text to display when the children are hidden

destination - base destination for the hide/show link.

HideShowBean

protected HideShowBean(boolean ignored,
                       java.lang.String localName)

Construct an instance of the HideShowBean. Provided for subclasses that need distinct local names..

Method Detail

getPrompt

public final UINode getPrompt()

Child rendered next to the hide or show icon. This child is not supported on the following agent types: pda.

setPrompt

public final void setPrompt(UINode promptNode)

Child rendered next to the hide or show icon. This child is not supported on the following agent types: pda.

isSelected

public final boolean isSelected()

Gets whether or not the hideShow is selected.

setSelected

public final void setSelected(boolean selected)

Sets whether or not the hideShow is selected.

isDisclosed

public final boolean isDisclosed()

Gets whether or not to disclose the children This attribute is not supported on the following agent types: pda.

setDisclosed

public final void setDisclosed(boolean disclosed)

Sets whether or not to disclose the children This attribute is not supported on the following agent types: pda.

getDisclosedText

public final java.lang.String getDisclosedText()

Gets the text to display when the children are shown

setDisclosedText

public final void setDisclosedText(java.lang.String disclosedText)

Sets the text to display when the children are shown

setTranslatableDisclosedText

public final void setTranslatableDisclosedText(java.lang.String bundleName,
                                               java.lang.String key)

Binds to a ResourceBundle the the text to display when the children are shown

Parameters:

bundleName - the name of the ResourceBundle

key - the key of the string to retrieve from the ResourceBundle

getUndisclosedText

public final java.lang.String getUndisclosedText()

Gets the text to display when the children are hidden

setUndisclosedText

public final void setUndisclosedText(java.lang.String undisclosedText)

Sets the text to display when the children are hidden

setTranslatableUndisclosedText

public final void setTranslatableUndisclosedText(java.lang.String bundleName,
                                                 java.lang.String key)

Binds to a ResourceBundle the the text to display when the children are hidden

Parameters:

bundleName - the name of the ResourceBundle

key - the key of the string to retrieve from the ResourceBundle

getDestination

public final java.lang.String getDestination()

Gets base destination for the hide/show link. Ignored if formSubmitted is true.

setDestination

public final void setDestination(java.lang.String destination)

Sets base destination for the hide/show link. Ignored if formSubmitted is true.

setDestinationBinding

public final void setDestinationBinding(BoundValue boundValue)

Binds the base destination for the hide/show link. Ignored if formSubmitted is true.

Parameters:

boundValue - a BoundValue implementation to be used to retrieve the value.

setDestinationBinding

public final void setDestinationBinding(java.lang.Object selectKey)

Binds the base destination for the hide/show link. Ignored if formSubmitted is true.

Parameters:

selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setDestinationBinding

public final void setDestinationBinding(java.lang.String dataNamespace,
                                        java.lang.String dataName,
                                        java.lang.Object selectKey)

Binds the base destination for the hide/show link. Ignored if formSubmitted is true.

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.

isFormSubmitted

public final boolean isFormSubmitted()

Gets whether or not to use form sumission in the Hide/Show link. Defaults to false.

setFormSubmitted

public final void setFormSubmitted(boolean formSubmitted)

Sets whether or not to use form sumission in the Hide/Show link. Defaults to false.

isUnvalidated

public final boolean isUnvalidated()

Gets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server. This attribute allows this validation to be disabled.

setUnvalidated

public final void setUnvalidated(boolean unvalidated)

Sets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server. This attribute allows this validation to be disabled.

getFormName

public final java.lang.String getFormName()

Gets form to which HideShow events should be submitted. Defaults to parent form.

setFormName

public final void setFormName(java.lang.String formName)

Sets form to which HideShow events should be submitted. Defaults to parent form.

getPartialRenderMode

public final java.lang.String getPartialRenderMode()

Gets

The partialRenderMode attribute is used to control the hideShow component's partial page rendering behavior. partialRenderMode defaults to "none", in which case full page rendering is used to hide/show the contents of the hideShow component. When partialRenderMode is set to "self" or "multiple", partial page rendering is used to re-render the hideShow component's contents as they are hidden/shown.

In order to enable partial page rendering, the hideShow component's id attribute must be set, the hideShow component must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the hideShow component will use the paritial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, full page rendering will be performed.

setPartialRenderMode

public final void setPartialRenderMode(java.lang.String partialRenderMode)

Sets

The partialRenderMode attribute is used to control the hideShow component's partial page rendering behavior. partialRenderMode defaults to "none", in which case full page rendering is used to hide/show the contents of the hideShow component. When partialRenderMode is set to "self" or "multiple", partial page rendering is used to re-render the hideShow component's contents as they are hidden/shown.

In order to enable partial page rendering, the hideShow component's id attribute must be set, the hideShow component must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the hideShow component will use the paritial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, full page rendering will be performed.

getPartialTargets

public final java.lang.String[] getPartialTargets()

Gets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". The ID of the hideShow is automatically included in the set of partial targets and as such should not be specified explicitly in the partialTargets list.

setPartialTargets

public final void setPartialTargets(java.lang.String[] partialTargets)

Sets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". The ID of the hideShow is automatically included in the set of partial targets and as such should not be specified explicitly in the partialTargets list.

getPrompt

public static UINode getPrompt(MutableUINode bean)

Child rendered next to the hide or show icon. This child is not supported on the following agent types: pda.

setPrompt

public static void setPrompt(MutableUINode bean,
                             UINode promptNode)

Child rendered next to the hide or show icon. This child is not supported on the following agent types: pda.

isSelected

public static boolean isSelected(MutableUINode bean)

Gets whether or not the hideShow is selected.

setSelected

public static void setSelected(MutableUINode bean,
                               boolean selected)

Sets whether or not the hideShow is selected.

isDisclosed

public static boolean isDisclosed(MutableUINode bean)

Gets whether or not to disclose the children This attribute is not supported on the following agent types: pda.

setDisclosed

public static void setDisclosed(MutableUINode bean,
                                boolean disclosed)

Sets whether or not to disclose the children This attribute is not supported on the following agent types: pda.

getDisclosedText

public static java.lang.String getDisclosedText(MutableUINode bean)

Gets the text to display when the children are shown

setDisclosedText

public static void setDisclosedText(MutableUINode bean,
                                    java.lang.String disclosedText)

Sets the text to display when the children are shown

setTranslatableDisclosedText

public static void setTranslatableDisclosedText(MutableUINode bean,
                                                java.lang.String bundleName,
                                                java.lang.String key)

Binds to a ResourceBundle the the text to display when the children are shown

Parameters:

bundleName - the name of the ResourceBundle

key - the key of the string to retrieve from the ResourceBundle

getUndisclosedText

public static java.lang.String getUndisclosedText(MutableUINode bean)

Gets the text to display when the children are hidden

setUndisclosedText

public static void setUndisclosedText(MutableUINode bean,
                                      java.lang.String undisclosedText)

Sets the text to display when the children are hidden

setTranslatableUndisclosedText

public static void setTranslatableUndisclosedText(MutableUINode bean,
                                                  java.lang.String bundleName,
                                                  java.lang.String key)

Binds to a ResourceBundle the the text to display when the children are hidden

Parameters:

bundleName - the name of the ResourceBundle

key - the key of the string to retrieve from the ResourceBundle

getDestination

public static java.lang.String getDestination(MutableUINode bean)

Gets base destination for the hide/show link. Ignored if formSubmitted is true.

setDestination

public static void setDestination(MutableUINode bean,
                                  java.lang.String destination)

Sets base destination for the hide/show link. Ignored if formSubmitted is true.

setDestinationBinding

public static void setDestinationBinding(MutableUINode bean,
                                         BoundValue boundValue)

Binds the base destination for the hide/show link. Ignored if formSubmitted is true.

Parameters:

boundValue - a BoundValue implementation to be used to retrieve the value.

setDestinationBinding

public static void setDestinationBinding(MutableUINode bean,
                                         java.lang.Object selectKey)

Binds the base destination for the hide/show link. Ignored if formSubmitted is true.

Parameters:

selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setDestinationBinding

public static void setDestinationBinding(MutableUINode bean,
                                         java.lang.String dataNamespace,
                                         java.lang.String dataName,
                                         java.lang.Object selectKey)

Binds the base destination for the hide/show link. Ignored if formSubmitted is true.

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.

isFormSubmitted

public static boolean isFormSubmitted(MutableUINode bean)

Gets whether or not to use form sumission in the Hide/Show link. Defaults to false.

setFormSubmitted

public static void setFormSubmitted(MutableUINode bean,
                                    boolean formSubmitted)

Sets whether or not to use form sumission in the Hide/Show link. Defaults to false.

isUnvalidated

public static boolean isUnvalidated(MutableUINode bean)

Gets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server. This attribute allows this validation to be disabled.

setUnvalidated

public static void setUnvalidated(MutableUINode bean,
                                  boolean unvalidated)

Sets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server. This attribute allows this validation to be disabled.

getFormName

public static java.lang.String getFormName(MutableUINode bean)

Gets form to which HideShow events should be submitted. Defaults to parent form.

setFormName

public static void setFormName(MutableUINode bean,
                               java.lang.String formName)

Sets form to which HideShow events should be submitted. Defaults to parent form.

getPartialRenderMode

public static java.lang.String getPartialRenderMode(MutableUINode bean)

Gets

The partialRenderMode attribute is used to control the hideShow component's partial page rendering behavior. partialRenderMode defaults to "none", in which case full page rendering is used to hide/show the contents of the hideShow component. When partialRenderMode is set to "self" or "multiple", partial page rendering is used to re-render the hideShow component's contents as they are hidden/shown.

In order to enable partial page rendering, the hideShow component's id attribute must be set, the hideShow component must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the hideShow component will use the paritial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, full page rendering will be performed.

setPartialRenderMode

public static void setPartialRenderMode(MutableUINode bean,
                                        java.lang.String partialRenderMode)

Sets

The partialRenderMode attribute is used to control the hideShow component's partial page rendering behavior. partialRenderMode defaults to "none", in which case full page rendering is used to hide/show the contents of the hideShow component. When partialRenderMode is set to "self" or "multiple", partial page rendering is used to re-render the hideShow component's contents as they are hidden/shown.

In order to enable partial page rendering, the hideShow component's id attribute must be set, the hideShow component must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the hideShow component will use the paritial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, full page rendering will be performed.

getPartialTargets

public static java.lang.String[] getPartialTargets(MutableUINode bean)

Gets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". The ID of the hideShow is automatically included in the set of partial targets and as such should not be specified explicitly in the partialTargets list.

setPartialTargets

public static void setPartialTargets(MutableUINode bean,
                                     java.lang.String[] partialTargets)

Sets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". The ID of the hideShow is automatically included in the set of partial targets and as such should not be specified explicitly in the partialTargets list.