oracle.cabo.ui.beans.nav
Class NavigationBarBean

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.nav.NavigationBarBean

All Implemented Interfaces:

MutableUINode, UIConstants, UINode

public class NavigationBarBean

extends MarlinBean

The NavigationBarBean is used to display to the user the current position among a larger set of steps or records. It allows the user to navigate back and forth through these steps or records through generated links.

There are two distinct types of NavigationBar: single- and multi-step. The default single-step bar shows the progress through a sequence of known steps, such as those in a wizard. Its text is generated in the form "Step 3 of 6".

The multi-step NavigationBar is used within tables with large sets of records, and it takes a different appearance including text of the form "10-19 of 100". The TableBean itself creates multi-step NavigationBars as part of its own rendering, and clients should rely on the TableBean to do so.

Properties of the NavigationBar

The type of NavigationBar to display is determined by the blockSize property. It defaults to the UIConstant SINGLE_STEP, which causes a single- step NavigationBar to be rendered. Setting it to any other value causes the NavigationBar to render as a multi-step control with the specified number of records as the currently viewed block size.

Setting the blockSize to the special value of zero will cause a NavigationBar which has no range and disabled links to be rendered.

The minValue and maxValue properties determine the boundaries of records or steps through which navigation can occur. For instance, if the navigation occurs through steps 1 through 10, minValue should be set to 1 and maxValue to 10. Navigation occurring through employee numbers which range from 1000 to 100000 should use 1000 as the minValue and 100000 as the maxValue. The minValue property defaults to a value of 1, while the maxValue property defaults to the special UIConstant value MAX_VALUE_UNKNOWN, which causes changes in the rendering to reflect that the range of navigation is unknown.

The value property determines the current step in a single-step navigation or the first record currently displayed in a multi-step navigation.

Navigation links

The NavigationBar can render its links either as URLs with standard arguments or as well-known values in a submitted form.

By default, the NavigationBar generates URL links based on two of its properties: destination and name. The destination property determines the base URL to which all generated links point. The name property is transformed into a "source" parameter to indicate the source of the event. The parameters of the URL contain the "goto" event ID, the name property of the NavigationBar as the source parameter, and the requested values or steps to view. Note that if the NavigationBar is created and rendered by a TableBean, the NavigationBar inherits the name of the table which is rendering it as its source.

For example, if a single-step NavigationBar had a destination property with a value of "http://bali.com/navigate.jsp" and a name property of "testNav" on step 3 of 6 of navigation, it would generate a "back" link with destination:

               "http://bali.com/navigate.jsp?event=goto&source=testNav&value=2"
             

and a "next" link with destination:

               "http://bali.com/navigate.jsp?event=goto&source=testNav&value=4"
             

If a TableBean named "testTable" created a multi-step NavigationBar displaying "10-19 of 100", it would generate a "Previous 10" link with destination:

               "http://bali.com/navigate.jsp?event=goto&source=testTable&value=1&size=10"
             

and a "Next 10" link with destination:

               "http://bali.com/navigate.jsp?event=goto&source=testTable&value=20&size=10"
             

The NavigationBar can also render links that trigger a form submission using Javascript. This is useful for NavigationBars which are rendered by TableBeans containing editable form controls, as it submits the form values along with special hidden values indicating the user's requested navigation.

To have a NavigationBar render form-based URLs, simply set the formSubmitted property on the NavigationBarBean, or on the TableBean which creates the NavigationBarBean, to true. As a result, hidden fields with the names:

• event
• source
• value
• size

will be rendered into the page. If the form is submitted as a result of the user selecting a NavigationBar link, the "event" field will be set to the special value "goto", the "source" field will be set to the name of the NavigationBar or Table generating the event, the "value" field will be set to the navigation target value, and the "size" field will be set to the number of records to display. The "size" field will not be rendered for single-step NavigationBars. When "Show All" support has been explicitly enabled (see below), the "value" field may not be a number, but instead will be the string UIConstants.VALUE_SHOW_ALL (and the "size" field will also not be delivered in this case). Developers should respond to such events by explicitly showing all rows.

On the server, the values of these hidden fields can be retrieved as parameters directly from a ServletRequest. If the form was not submitted as part of a navigation event, these parameters will have no values.

Example:

In the following example, a single step navigation bar is created. It has five steps and we are currently on step 3.

 <navigationBar minValue="1" maxValue="5" value="3"/>

In the following example, a record navigator is created. The records are viewed in blocks of 25, and the current view is on record 34 (out of 100)

 <navigationBar minValue="1" maxValue="100" value="34" blockSize="25"/>

See Also:

TableBean, 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

	NavigationBarBean() Construct an instance of the NavigationBarBean.
protected	NavigationBarBean(boolean ignored, java.lang.String localName) Construct an instance of the NavigationBarBean.
	NavigationBarBean(java.lang.String name, int blockSize, int value, int minValue, int maxValue, java.lang.String destination) Construct an instance of the NavigationBarBean.

Method Summary

int	getBlockSize() Gets the number of records currently displayed in the navigation bar.
static int	getBlockSize(MutableUINode bean) Gets the number of records currently displayed in the navigation bar.
java.lang.String	getDestination() Gets the base destination for all links generated by the navigation bar.
static java.lang.String	getDestination(MutableUINode bean) Gets the base destination for all links generated by the navigation bar.
java.lang.String	getFormName() Gets the name of the form to submit.
static java.lang.String	getFormName(MutableUINode bean) Gets the name of the form to submit.
int	getMaxValue() Gets the last possible record in a navigation bar.
static int	getMaxValue(MutableUINode bean) Gets the last possible record in a navigation bar.
int	getMinValue() Gets the first possible record in a multi-step navigation bar.
static int	getMinValue(MutableUINode bean) Gets the first possible record in a multi-step navigation bar.
java.lang.String	getName() Gets the name of the navigation bar, which is used to generate links.
static java.lang.String	getName(MutableUINode bean) Gets the name of the navigation bar, which is used to generate links.
java.lang.String	getShowAll() Gets whether a "Show All" option should be displayed.
static java.lang.String	getShowAll(MutableUINode bean) Gets whether a "Show All" option should be displayed.
java.lang.String	getTypeText() Gets the text description of items being navigated.
static java.lang.String	getTypeText(MutableUINode bean) Gets the text description of items being navigated.
int	getValue() Gets the current step in a single-step navigation bar, or the first currently viewed element in a multi-step navigation bar.
static int	getValue(MutableUINode bean) Gets the current step in a single-step navigation bar, or the first currently viewed element in a multi-step navigation bar.
boolean	isFormSubmitted() Gets whether to submit the form.
static boolean	isFormSubmitted(MutableUINode bean) Gets whether to submit the form.
boolean	isUnvalidated() Gets whether onSubmit validation is fired before navigating the the next page.
static boolean	isUnvalidated(MutableUINode bean) Gets whether onSubmit validation is fired before navigating the the next page.
void	setBlockSize(int blockSize) Sets the number of records currently displayed in the navigation bar.
static void	setBlockSize(MutableUINode bean, int blockSize) Sets the number of records currently displayed in the navigation bar.
static void	setDestination(MutableUINode bean, java.lang.String destination) Sets the base destination for all links generated by the navigation bar.
void	setDestination(java.lang.String destination) Sets the base destination for all links generated by the navigation bar.
static void	setFormName(MutableUINode bean, java.lang.String formName) Sets the name of the form to submit.
void	setFormName(java.lang.String formName) Sets the name of the form to submit.
void	setFormSubmitted(boolean formSubmitted) Sets whether to submit the form.
static void	setFormSubmitted(MutableUINode bean, boolean formSubmitted) Sets whether to submit the form.
void	setMaxValue(int maxValue) Sets the last possible record in a navigation bar.
void	setMaxValue(long maxValue) Sets the last possible record in a navigation bar.
static void	setMaxValue(MutableUINode bean, int maxValue) Sets the last possible record in a navigation bar.
static void	setMaxValue(MutableUINode bean, long maxValue) Sets the last possible record in a navigation bar.
void	setMinValue(int minValue) Sets the first possible record in a multi-step navigation bar.
void	setMinValue(long minValue) Sets the first possible record in a multi-step navigation bar.
static void	setMinValue(MutableUINode bean, int minValue) Sets the first possible record in a multi-step navigation bar.
static void	setMinValue(MutableUINode bean, long minValue) Sets the first possible record in a multi-step navigation bar.
static void	setName(MutableUINode bean, java.lang.String name) Sets the name of the navigation bar, which is used to generate links.
void	setName(java.lang.String name) Sets the name of the navigation bar, which is used to generate links.
static void	setShowAll(MutableUINode bean, java.lang.String showAll) Sets whether a "Show All" option should be displayed.
void	setShowAll(java.lang.String showAll) Sets whether a "Show All" option should be displayed.
static void	setTranslatableTypeText(MutableUINode bean, java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the text description of items being navigated.
void	setTranslatableTypeText(java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the text description of items being navigated.
static void	setTypeText(MutableUINode bean, java.lang.String typeText) Sets the text description of items being navigated.
void	setTypeText(java.lang.String typeText) Sets the text description of items being navigated.
void	setUnvalidated(boolean unvalidated) Sets whether onSubmit validation is fired before navigating the the next page.
static void	setUnvalidated(MutableUINode bean, boolean unvalidated) Sets whether onSubmit validation is fired before navigating the the next page.
void	setValue(int value) Sets the current step in a single-step navigation bar, or the first currently viewed element in a multi-step navigation bar.
void	setValue(long value) Sets the current step in a single-step navigation bar, or the first currently viewed element in a multi-step navigation bar.
static void	setValue(MutableUINode bean, int value) Sets the current step in a single-step navigation bar, or the first currently viewed element in a multi-step navigation bar.
static void	setValue(MutableUINode bean, long value) Sets the current step in a single-step navigation bar, or the first currently viewed element in a multi-step navigation bar.

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

NavigationBarBean

public NavigationBarBean()

Construct an instance of the NavigationBarBean.

NavigationBarBean

public NavigationBarBean(java.lang.String name,
                         int blockSize,
                         int value,
                         int minValue,
                         int maxValue,
                         java.lang.String destination)

Construct an instance of the NavigationBarBean.

Parameters:

name - the name of the navigation bar, which is used to generate links.

blockSize - the number of records currently displayed in the navigation bar.

value - the current step in a single-step navigation bar, or the first currently viewed element in a multi-step navigation bar.

minValue - the first possible record in a multi-step navigation bar.

maxValue - the last possible record in a navigation bar.

destination - the base destination for all links generated by the navigation bar.

NavigationBarBean

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

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

Method Detail

getBlockSize

public final int getBlockSize()

Gets the number of records currently displayed in the navigation bar. It defaults to SINGLE_STEP.

setBlockSize

public final void setBlockSize(int blockSize)

Sets the number of records currently displayed in the navigation bar. It defaults to SINGLE_STEP.

getValue

public final int getValue()

Gets the current step in a single-step navigation bar, or the first currently viewed element in a multi-step navigation bar. It defaults to "1".

setValue

public final void setValue(int value)

Sets the current step in a single-step navigation bar, or the first currently viewed element in a multi-step navigation bar. It defaults to "1".

setValue

public final void setValue(long value)

Sets the current step in a single-step navigation bar, or the first currently viewed element in a multi-step navigation bar. It defaults to "1".

getMinValue

public final int getMinValue()

Gets the first possible record in a multi-step navigation bar. This value is ignored in a single-step navigation bar. It defaults to "1".

setMinValue

public final void setMinValue(int minValue)

Sets the first possible record in a multi-step navigation bar. This value is ignored in a single-step navigation bar. It defaults to "1".

setMinValue

public final void setMinValue(long minValue)

Sets the first possible record in a multi-step navigation bar. This value is ignored in a single-step navigation bar. It defaults to "1".

getMaxValue

public final int getMaxValue()

Gets the last possible record in a navigation bar. If this value is not known, it should be set to MAX_VALUE_UNKNOWN, which is also the default value.

setMaxValue

public final void setMaxValue(int maxValue)

Sets the last possible record in a navigation bar. If this value is not known, it should be set to MAX_VALUE_UNKNOWN, which is also the default value.

setMaxValue

public final void setMaxValue(long maxValue)

Sets the last possible record in a navigation bar. If this value is not known, it should be set to MAX_VALUE_UNKNOWN, which is also the default value.

getName

public final java.lang.String getName()

Gets the name of the navigation bar, which is used to generate links.

setName

public final void setName(java.lang.String name)

Sets the name of the navigation bar, which is used to generate links.

getDestination

public final java.lang.String getDestination()

Gets the base destination for all links generated by the navigation bar.

setDestination

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

Sets the base destination for all links generated by the navigation bar.

getTypeText

public final java.lang.String getTypeText()

Gets the text description of items being navigated. This will be used in the generated range string for single-step navigation bars, and the default is "Step".

setTypeText

public final void setTypeText(java.lang.String typeText)

Sets the text description of items being navigated. This will be used in the generated range string for single-step navigation bars, and the default is "Step".

setTranslatableTypeText

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

Binds to a ResourceBundle the the text description of items being navigated. This will be used in the generated range string for single-step navigation bars, and the default is "Step".

Parameters:

bundleName - the name of the ResourceBundle

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

isFormSubmitted

public final boolean isFormSubmitted()

Gets whether to submit the form. Setting this property causes NavigationBar links to use Javascript form submission. If no formName is specified, the parent form is used.

setFormSubmitted

public final void setFormSubmitted(boolean formSubmitted)

Sets whether to submit the form. Setting this property causes NavigationBar links to use Javascript form submission. If no formName is specified, the parent form is used.

getShowAll

public final java.lang.String getShowAll()

Gets whether a "Show All" option should be displayed. This defaults to "no", and is only meaningful for multi-step navigation bars. It is also only used if the numbers of rows is known ("maxValue" is set), and may also be ignored for very large sets. When this is in effect, event handlers must handle the "value" field of navigation events being set to the string UIConstants.VALUE_SHOW_ALL (instead of a number). The supported values are:

• UIConstants.SHOW_ALL_NO: "Show All" should not be supported.
• UIConstants.SHOW_ALL_YES: "Show All" should be supported.
• UIConstants.SHOW_ALL_ACTIVE: "Show All" should be supported and is currently active.

This attribute is not supported on the following agent types: pda.

setShowAll

public final void setShowAll(java.lang.String showAll)

Sets whether a "Show All" option should be displayed. This defaults to "no", and is only meaningful for multi-step navigation bars. It is also only used if the numbers of rows is known ("maxValue" is set), and may also be ignored for very large sets. When this is in effect, event handlers must handle the "value" field of navigation events being set to the string UIConstants.VALUE_SHOW_ALL (instead of a number). The supported values are:

• UIConstants.SHOW_ALL_NO: "Show All" should not be supported.
• UIConstants.SHOW_ALL_YES: "Show All" should be supported.
• UIConstants.SHOW_ALL_ACTIVE: "Show All" should be supported and is currently active.

This attribute is not supported on the following agent types: pda.

getFormName

public final java.lang.String getFormName()

Gets the name of the form to submit. Setting this property causes NavigationBar links to use Javascript form submission.

setFormName

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

Sets the name of the form to submit. Setting this property causes NavigationBar links to use Javascript form submission.

isUnvalidated

public final boolean isUnvalidated()

Gets whether onSubmit validation is fired before navigating the the next page. By default, validation is fired when the next button is pressed, and the submission only occurs if the validation succeeds. In some cases, the programmer would like the form to be submitted, but doesn't want the values to be validated. Not validating the input allows the values to be remembered without annoying the user by forcing him to correct any mistakes he made before moving back. For these cases, the value of unvalidated should be set to true so that no validation occurs.

setUnvalidated

public final void setUnvalidated(boolean unvalidated)

Sets whether onSubmit validation is fired before navigating the the next page. By default, validation is fired when the next button is pressed, and the submission only occurs if the validation succeeds. In some cases, the programmer would like the form to be submitted, but doesn't want the values to be validated. Not validating the input allows the values to be remembered without annoying the user by forcing him to correct any mistakes he made before moving back. For these cases, the value of unvalidated should be set to true so that no validation occurs.

getBlockSize

public static int getBlockSize(MutableUINode bean)

Gets the number of records currently displayed in the navigation bar. It defaults to SINGLE_STEP.

setBlockSize

public static void setBlockSize(MutableUINode bean,
                                int blockSize)

Sets the number of records currently displayed in the navigation bar. It defaults to SINGLE_STEP.

getValue

public static int getValue(MutableUINode bean)

Gets the current step in a single-step navigation bar, or the first currently viewed element in a multi-step navigation bar. It defaults to "1".

setValue

public static void setValue(MutableUINode bean,
                            int value)

Sets the current step in a single-step navigation bar, or the first currently viewed element in a multi-step navigation bar. It defaults to "1".

setValue

public static void setValue(MutableUINode bean,
                            long value)

Sets the current step in a single-step navigation bar, or the first currently viewed element in a multi-step navigation bar. It defaults to "1".

getMinValue

public static int getMinValue(MutableUINode bean)

Gets the first possible record in a multi-step navigation bar. This value is ignored in a single-step navigation bar. It defaults to "1".

setMinValue

public static void setMinValue(MutableUINode bean,
                               int minValue)

Sets the first possible record in a multi-step navigation bar. This value is ignored in a single-step navigation bar. It defaults to "1".

setMinValue

public static void setMinValue(MutableUINode bean,
                               long minValue)

Sets the first possible record in a multi-step navigation bar. This value is ignored in a single-step navigation bar. It defaults to "1".

getMaxValue

public static int getMaxValue(MutableUINode bean)

Gets the last possible record in a navigation bar. If this value is not known, it should be set to MAX_VALUE_UNKNOWN, which is also the default value.

setMaxValue

public static void setMaxValue(MutableUINode bean,
                               int maxValue)

Sets the last possible record in a navigation bar. If this value is not known, it should be set to MAX_VALUE_UNKNOWN, which is also the default value.

setMaxValue

public static void setMaxValue(MutableUINode bean,
                               long maxValue)

Sets the last possible record in a navigation bar. If this value is not known, it should be set to MAX_VALUE_UNKNOWN, which is also the default value.

getName

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

Gets the name of the navigation bar, which is used to generate links.

setName

public static void setName(MutableUINode bean,
                           java.lang.String name)

Sets the name of the navigation bar, which is used to generate links.

getDestination

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

Gets the base destination for all links generated by the navigation bar.

setDestination

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

Sets the base destination for all links generated by the navigation bar.

getTypeText

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

Gets the text description of items being navigated. This will be used in the generated range string for single-step navigation bars, and the default is "Step".

setTypeText

public static void setTypeText(MutableUINode bean,
                               java.lang.String typeText)

Sets the text description of items being navigated. This will be used in the generated range string for single-step navigation bars, and the default is "Step".

setTranslatableTypeText

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

Binds to a ResourceBundle the the text description of items being navigated. This will be used in the generated range string for single-step navigation bars, and the default is "Step".

Parameters:

bundleName - the name of the ResourceBundle

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

isFormSubmitted

public static boolean isFormSubmitted(MutableUINode bean)

Gets whether to submit the form. Setting this property causes NavigationBar links to use Javascript form submission. If no formName is specified, the parent form is used.

setFormSubmitted

public static void setFormSubmitted(MutableUINode bean,
                                    boolean formSubmitted)

Sets whether to submit the form. Setting this property causes NavigationBar links to use Javascript form submission. If no formName is specified, the parent form is used.

getShowAll

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

Gets whether a "Show All" option should be displayed. This defaults to "no", and is only meaningful for multi-step navigation bars. It is also only used if the numbers of rows is known ("maxValue" is set), and may also be ignored for very large sets. When this is in effect, event handlers must handle the "value" field of navigation events being set to the string UIConstants.VALUE_SHOW_ALL (instead of a number). The supported values are:

• UIConstants.SHOW_ALL_NO: "Show All" should not be supported.
• UIConstants.SHOW_ALL_YES: "Show All" should be supported.
• UIConstants.SHOW_ALL_ACTIVE: "Show All" should be supported and is currently active.

This attribute is not supported on the following agent types: pda.

setShowAll

public static void setShowAll(MutableUINode bean,
                              java.lang.String showAll)

Sets whether a "Show All" option should be displayed. This defaults to "no", and is only meaningful for multi-step navigation bars. It is also only used if the numbers of rows is known ("maxValue" is set), and may also be ignored for very large sets. When this is in effect, event handlers must handle the "value" field of navigation events being set to the string UIConstants.VALUE_SHOW_ALL (instead of a number). The supported values are:

• UIConstants.SHOW_ALL_NO: "Show All" should not be supported.
• UIConstants.SHOW_ALL_YES: "Show All" should be supported.
• UIConstants.SHOW_ALL_ACTIVE: "Show All" should be supported and is currently active.

This attribute is not supported on the following agent types: pda.

getFormName

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

Gets the name of the form to submit. Setting this property causes NavigationBar links to use Javascript form submission.

setFormName

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

Sets the name of the form to submit. Setting this property causes NavigationBar links to use Javascript form submission.

isUnvalidated

public static boolean isUnvalidated(MutableUINode bean)

Gets whether onSubmit validation is fired before navigating the the next page. By default, validation is fired when the next button is pressed, and the submission only occurs if the validation succeeds. In some cases, the programmer would like the form to be submitted, but doesn't want the values to be validated. Not validating the input allows the values to be remembered without annoying the user by forcing him to correct any mistakes he made before moving back. For these cases, the value of unvalidated should be set to true so that no validation occurs.

setUnvalidated

public static void setUnvalidated(MutableUINode bean,
                                  boolean unvalidated)

Sets whether onSubmit validation is fired before navigating the the next page. By default, validation is fired when the next button is pressed, and the submission only occurs if the validation succeeds. In some cases, the programmer would like the form to be submitted, but doesn't want the values to be validated. Not validating the input allows the values to be remembered without annoying the user by forcing him to correct any mistakes he made before moving back. For these cases, the value of unvalidated should be set to true so that no validation occurs.