oracle.cabo.ui.beans.layout
Class PageLayoutBean

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

All Implemented Interfaces:

MutableUINode, UIConstants, UINode

public class PageLayoutBean

extends MarlinBean

PageLayout is a high-level layout element that acts as a template for the entire page. It supports several navigation and content areas for the creation of pages.

PageLayout and "Quick Links"

While UIX supports an explicit quickLinks element, pageLayout includes built-in quick links functionality that is vastly simpler to use - and makes it much easier to get the correct look-and-feel. This functionality uses two attributes: "quickLinksShown" and "title".

When "quickLinksShown" is set to true, the pageLayout will automatically search for HeaderBeans inside its contents. One quicklink will be added to each - minus the first header, and minus any headers inside other headers (a.k.a. "subheaders").

In addition, pageLayout will automatically add a top-level header if the "title" attribute is set. This header is skipped over when looking for quicklinks.

Example:

 <dataScope>
   <contents>
     <form name="pageLayout">
      <contents>
     <verbose>
       <contents>
 
 
         <pageLayout quickLinksShown="true"
                     title="Title">
           <quickSearch>
            <messageTextInput prompt="Search" name="QSearch" text="Cabo">
             <end>
              <submitButton text="Go" ctrl:event="search" />
             </end>
            </messageTextInput>
           </quickSearch>
 
           <tabs>
             <tabBar selectedIndex="1">
               <contents data:childData="link@dat1">
                 <link data:text="text"
                       data:destination="destination"
                       data:disabled="disabled"/>
               </contents>
             </tabBar>
           </tabs>
 
           <pageHeader>
             <globalHeader selectedIndex="1">
               <contents data:childData="link@dat1">
                 <link data:text="text"
                       data:destination="destination"
                       data:disabled="disabled"/>
               </contents>
             </globalHeader>
           </pageHeader>
 
           <start>
             <sideNav selectedIndex="1">
               <contents data:childData="link@dat1">
                 <link data:text="text"
                       data:destination="destination"
                       data:disabled="disabled"/>
               </contents>
             </sideNav>
           </start>
 
           <globalButtons>
             <globalButtonBar>
               <contents data:childData="link@dat1">
                 <globalButton icon="images/globalhelp.gif"
                               data:selected="selected"
                               data:disabled="disabled"
                               data:text="text"
                               data:destination="destination"/>
               </contents>
             </globalButtonBar>
           </globalButtons>
 
           <location>
             <train selectedIndex="1">
               <contents data:childData="link@dat1">
                 <link data:text="text" data:destination="destination"/>
               </contents>
             </train>
           </location>
 
           <copyright>
             <flowLayout>
               <contents>
                 <image source="images/info.gif"/>
 
           This is the
 
                 <link text=" copyright statement"
                       destination="http://www.oracle.com"/>
               </contents>
             </flowLayout>
           </copyright>
 
           <privacy>
             <flowLayout>
               <contents>
                 <image source="images/info.gif"/>
 
           This is the
 
                 <link text=" privacy statement"
                       destination="http://www.oracle.com"/>
               </contents>
             </flowLayout>
           </privacy>
 
           <pageButtons>
             <pageButtonBar>
               <contents>
                 <image source="images/info.gif"/>
 
                 <link text=" content footer"
                       destination="http://www.oracle.com"/>
               </contents>
             </pageButtonBar>
           </pageButtons>
 
           <end>
             <contentContainer id="1"
                               text="Header"
                               background="medium"
                               icon="images/info.gif">
               <contents>
                 <link text="link" destination="http://www.oracle.com"/>
               </contents>
             </contentContainer>
           </end>
 
           <contents>
             <header text="Header 1"/>
 
             <header text="Header 2"/>
 
             <header text="Header 3"/>
 
             <header text="Header 4"/>
           </contents>
         </pageLayout>
       </contents>
     </verbose>
      </contents>
     </form>
   </contents>
 
   <provider>
     <data name="dat1">
       <inline>
         <link text="UIX Components"
               destination="http://www.oracle.com"/>
         <link text="UIX Controller"
               destination="http://www.oracle.com"
               selected="true"/>
         <link text="Architecture"
               destination="http://www.oracle.com"/>
         <link text="Release"
               destination="http://www.oracle.com"/>
         <link text="Detonate" disabled="true"/>
       </inline>
     </data>
   </provider>
 </dataScope>

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

	PageLayoutBean() Construct an instance of the PageLayoutBean.
protected	PageLayoutBean(boolean ignored, java.lang.String localName) Construct an instance of the PageLayoutBean.

Method Summary

UINode	getAbout() Area to put a link to more information about the application.
static UINode	getAbout(MutableUINode bean) Area to put a link to more information about the application.
UINode	getCobranding() The associated cobranding region of the page.
static UINode	getCobranding(MutableUINode bean) The associated cobranding region of the page.
UINode	getContentFooter() DEPRECATED.
static UINode	getContentFooter(MutableUINode bean) DEPRECATED.
UINode	getContextSwitcher() The context switcher of a page.
static UINode	getContextSwitcher(MutableUINode bean) The context switcher of a page.
UINode	getCopyright() The copyright region of the page.
static UINode	getCopyright(MutableUINode bean) The copyright region of the page.
UINode	getCorporateBranding() The corporate branding region of the page.
static UINode	getCorporateBranding(MutableUINode bean) The corporate branding region of the page.
UINode	getEnd() The end column region.
static UINode	getEnd(MutableUINode bean) The end column region.
UINode	getFootnote() The footnote region.
static UINode	getFootnote(MutableUINode bean) The footnote region.
UINode	getGlobalButtons() The global button region of the page.
static UINode	getGlobalButtons(MutableUINode bean) The global button region of the page.
UINode	getLargeAdvertisement() The large advertisement region of the page.
static UINode	getLargeAdvertisement(MutableUINode bean) The large advertisement region of the page.
UINode	getLocation() The locator region of the page.
static UINode	getLocation(MutableUINode bean) The locator region of the page.
UINode	getMediumAdvertisement() The medium advertisement region of the page.
static UINode	getMediumAdvertisement(MutableUINode bean) The medium advertisement region of the page.
UINode	getMessages() The node to display messages.
static UINode	getMessages(MutableUINode bean) The node to display messages.
java.lang.String	getMessageType() Gets whether page is a messaging dialog.
static java.lang.String	getMessageType(MutableUINode bean) Gets whether page is a messaging dialog.
UINode	getPageButtons() The page-level navigation of the page.
static UINode	getPageButtons(MutableUINode bean) The page-level navigation of the page.
UINode	getPageHeader() The header region of the page.
static UINode	getPageHeader(MutableUINode bean) The header region of the page.
UINode	getPageStatus() The page-level status and/or key notation region.
static UINode	getPageStatus(MutableUINode bean) The page-level status and/or key notation region.
UINode	getPrivacy() The privacy region of the page.
static UINode	getPrivacy(MutableUINode bean) The privacy region of the page.
UINode	getProductBranding() The product branding region of the page.
static UINode	getProductBranding(MutableUINode bean) The product branding region of the page.
UINode	getQuickSearch() The quick search region of the page.
static UINode	getQuickSearch(MutableUINode bean) The quick search region of the page.
UINode	getReturnNavigation() The "return to [X]" link at the bottom of the page.
static UINode	getReturnNavigation(MutableUINode bean) The "return to [X]" link at the bottom of the page.
UINode	getStart() The start column region of the page.
static UINode	getStart(MutableUINode bean) The start column region of the page.
UINode	getTabs() The Tab region of the page.
static UINode	getTabs(MutableUINode bean) The Tab region of the page.
java.lang.String	getTitle() Gets The title to display for this page.
static java.lang.String	getTitle(MutableUINode bean) Gets The title to display for this page.
UINode	getUserInfo() The user information region.
static UINode	getUserInfo(MutableUINode bean) The user information region.
boolean	isQuickLinksShown() Gets if links to the top-level headers should be shown on this page.
static boolean	isQuickLinksShown(MutableUINode bean) Gets if links to the top-level headers should be shown on this page.
static void	setAbout(MutableUINode bean, UINode aboutNode) Area to put a link to more information about the application.
void	setAbout(UINode aboutNode) Area to put a link to more information about the application.
static void	setCobranding(MutableUINode bean, UINode cobrandingNode) The associated cobranding region of the page.
void	setCobranding(UINode cobrandingNode) The associated cobranding region of the page.
void	setCobrandingImage(java.lang.String imageURL, java.lang.String titleText) Deprecated. Use setCobranding instead
static void	setContentFooter(MutableUINode bean, UINode contentFooterNode) DEPRECATED.
void	setContentFooter(UINode contentFooterNode) DEPRECATED.
static void	setContextSwitcher(MutableUINode bean, UINode contextSwitcherNode) The context switcher of a page.
void	setContextSwitcher(UINode contextSwitcherNode) The context switcher of a page.
static void	setCopyright(MutableUINode bean, UINode copyrightNode) The copyright region of the page.
void	setCopyright(UINode copyrightNode) The copyright region of the page.
static void	setCorporateBranding(MutableUINode bean, UINode corporateBrandingNode) The corporate branding region of the page.
void	setCorporateBranding(UINode corporateBrandingNode) The corporate branding region of the page.
void	setCorporateBrandingImage(java.lang.String imageURL, java.lang.String titleText) Deprecated. Use setCorporateBranding instead
static void	setEnd(MutableUINode bean, UINode endNode) The end column region.
void	setEnd(UINode endNode) The end column region.
void	setFooterCopyright(java.lang.String copyrightText) Deprecated. Use setCopyright instead
static void	setFootnote(MutableUINode bean, UINode footnoteNode) The footnote region.
void	setFootnote(UINode footnoteNode) The footnote region.
static void	setGlobalButtons(MutableUINode bean, UINode globalButtonsNode) The global button region of the page.
void	setGlobalButtons(UINode globalButtonsNode) The global button region of the page.
static void	setLargeAdvertisement(MutableUINode bean, UINode largeAdvertisementNode) The large advertisement region of the page.
void	setLargeAdvertisement(UINode largeAdvertisementNode) The large advertisement region of the page.
static void	setLocation(MutableUINode bean, UINode locationNode) The locator region of the page.
void	setLocation(UINode locationNode) The locator region of the page.
static void	setMediumAdvertisement(MutableUINode bean, UINode mediumAdvertisementNode) The medium advertisement region of the page.
void	setMediumAdvertisement(UINode mediumAdvertisementNode) The medium advertisement region of the page.
static void	setMessages(MutableUINode bean, UINode messagesNode) The node to display messages.
void	setMessages(UINode messagesNode) The node to display messages.
static void	setMessageType(MutableUINode bean, java.lang.String messageType) Sets whether page is a messaging dialog.
void	setMessageType(java.lang.String messageType) Sets whether page is a messaging dialog.
static void	setPageButtons(MutableUINode bean, UINode pageButtonsNode) The page-level navigation of the page.
void	setPageButtons(UINode pageButtonsNode) The page-level navigation of the page.
static void	setPageHeader(MutableUINode bean, UINode pageHeaderNode) The header region of the page.
void	setPageHeader(UINode pageHeaderNode) The header region of the page.
static void	setPageStatus(MutableUINode bean, UINode pageStatusNode) The page-level status and/or key notation region.
void	setPageStatus(UINode pageStatusNode) The page-level status and/or key notation region.
static void	setPrivacy(MutableUINode bean, UINode privacyNode) The privacy region of the page.
void	setPrivacy(UINode privacyNode) The privacy region of the page.
static void	setProductBranding(MutableUINode bean, UINode productBrandingNode) The product branding region of the page.
void	setProductBranding(UINode productBrandingNode) The product branding region of the page.
void	setProductBrandingImage(java.lang.String imageURL, java.lang.String titleText) Deprecated. Use setProductBranding instead
void	setQuickLinksShown(boolean quickLinksShown) Sets if links to the top-level headers should be shown on this page.
static void	setQuickLinksShown(MutableUINode bean, boolean quickLinksShown) Sets if links to the top-level headers should be shown on this page.
static void	setQuickSearch(MutableUINode bean, UINode quickSearchNode) The quick search region of the page.
void	setQuickSearch(UINode quickSearchNode) The quick search region of the page.
static void	setReturnNavigation(MutableUINode bean, UINode returnNavigationNode) The "return to [X]" link at the bottom of the page.
void	setReturnNavigation(UINode returnNavigationNode) The "return to [X]" link at the bottom of the page.
static void	setStart(MutableUINode bean, UINode startNode) The start column region of the page.
void	setStart(UINode startNode) The start column region of the page.
static void	setTabs(MutableUINode bean, UINode tabsNode) The Tab region of the page.
void	setTabs(UINode tabsNode) The Tab region of the page.
static void	setTitle(MutableUINode bean, java.lang.String title) Sets The title to display for this page.
void	setTitle(java.lang.String title) Sets The title to display for this page.
static void	setTranslatableTitle(MutableUINode bean, java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the The title to display for this page.
void	setTranslatableTitle(java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the The title to display for this page.
static void	setUserInfo(MutableUINode bean, UINode userInfoNode) The user information region.
void	setUserInfo(UINode userInfoNode) The user information region.

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

PageLayoutBean

public PageLayoutBean()

Construct an instance of the PageLayoutBean.

PageLayoutBean

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

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

Method Detail

setCobrandingImage

public void setCobrandingImage(java.lang.String imageURL,
                               java.lang.String titleText)

Deprecated. Use setCobranding instead

Sets the URL of the image to use for the corporate cobranding area for this page.

See Also:

setCobranding(oracle.cabo.ui.UINode)

setCorporateBrandingImage

public void setCorporateBrandingImage(java.lang.String imageURL,
                                      java.lang.String titleText)

Deprecated. Use setCorporateBranding instead

Sets the URL of the image to use for the corporate branding area for this page.

See Also:

setCorporateBranding(oracle.cabo.ui.UINode)

setProductBrandingImage

public void setProductBrandingImage(java.lang.String imageURL,
                                    java.lang.String titleText)

Deprecated. Use setProductBranding instead

Sets the URL of the image to use for the product branding area for this page.

See Also:

setProductBranding(oracle.cabo.ui.UINode)

setFooterCopyright

public void setFooterCopyright(java.lang.String copyrightText)

Deprecated. Use setCopyright instead

Sets the String to use as the copyright notice in the Page Footer.

See Also:

setCopyright(oracle.cabo.ui.UINode)

getContextSwitcher

public final UINode getContextSwitcher()

The context switcher of a page. This child is not supported on the following agent types: pda.

setContextSwitcher

public final void setContextSwitcher(UINode contextSwitcherNode)

The context switcher of a page. This child is not supported on the following agent types: pda.

getMessages

public final UINode getMessages()

The node to display messages. Usually contains a messageBox.

setMessages

public final void setMessages(UINode messagesNode)

The node to display messages. Usually contains a messageBox.

getTabs

public final UINode getTabs()

The Tab region of the page. If present, this location typically contains a TabBar. This child is not supported on the following agent types: pda.

setTabs

public final void setTabs(UINode tabsNode)

The Tab region of the page. If present, this location typically contains a TabBar. This child is not supported on the following agent types: pda.

getPageHeader

public final UINode getPageHeader()

The header region of the page. This location typically contains a GlobalHeader. This child is not supported on the following agent types: pda.

setPageHeader

public final void setPageHeader(UINode pageHeaderNode)

The header region of the page. This location typically contains a GlobalHeader. This child is not supported on the following agent types: pda.

getGlobalButtons

public final UINode getGlobalButtons()

The global button region of the page. This section typically contains a GlobalButtonBar.

setGlobalButtons

public final void setGlobalButtons(UINode globalButtonsNode)

The global button region of the page. This section typically contains a GlobalButtonBar.

getLargeAdvertisement

public final UINode getLargeAdvertisement()

The large advertisement region of the page. If present, this section typically contains an image of the advertisement with a link for more information. This child is not supported on the following agent types: pda.

setLargeAdvertisement

public final void setLargeAdvertisement(UINode largeAdvertisementNode)

The large advertisement region of the page. If present, this section typically contains an image of the advertisement with a link for more information. This child is not supported on the following agent types: pda.

getMediumAdvertisement

public final UINode getMediumAdvertisement()

The medium advertisement region of the page. If present, this section typically contains an image of the advertisement with a link for more information. This child is not supported on the following agent types: pda.

setMediumAdvertisement

public final void setMediumAdvertisement(UINode mediumAdvertisementNode)

The medium advertisement region of the page. If present, this section typically contains an image of the advertisement with a link for more information. This child is not supported on the following agent types: pda.

getCorporateBranding

public final UINode getCorporateBranding()

The corporate branding region of the page. This section typically contains a medium size Image of the logo of the company owning the page.

setCorporateBranding

public final void setCorporateBranding(UINode corporateBrandingNode)

The corporate branding region of the page. This section typically contains a medium size Image of the logo of the company owning the page.

getCobranding

public final UINode getCobranding()

The associated cobranding region of the page. If present, This section typically contains a small Image of the logo of a non-owning company associated with the page. This child is not supported on the following agent types: pda.

setCobranding

public final void setCobranding(UINode cobrandingNode)

The associated cobranding region of the page. If present, This section typically contains a small Image of the logo of a non-owning company associated with the page. This child is not supported on the following agent types: pda.

getProductBranding

public final UINode getProductBranding()

The product branding region of the page. This section typically contains an Image of the product logo. This child is not supported on the following agent types: pda.

setProductBranding

public final void setProductBranding(UINode productBrandingNode)

The product branding region of the page. This section typically contains an Image of the product logo. This child is not supported on the following agent types: pda.

getQuickSearch

public final UINode getQuickSearch()

The quick search region of the page. This child is not supported on the following agent types: pda.

setQuickSearch

public final void setQuickSearch(UINode quickSearchNode)

The quick search region of the page. This child is not supported on the following agent types: pda.

getLocation

public final UINode getLocation()

The locator region of the page. If present, this section typically contains either a Train, indicating the user's location in a multistep process, or BreadCrumbs, containing links that will bring the user back to each of the parent pages of a tree of pages that he has navigated down into.

setLocation

public final void setLocation(UINode locationNode)

The locator region of the page. If present, this section typically contains either a Train, indicating the user's location in a multistep process, or BreadCrumbs, containing links that will bring the user back to each of the parent pages of a tree of pages that he has navigated down into.

getStart

public final UINode getStart()

The start column region of the page. If present, this section typically contains either a SideNav (deprecated) or SideBar with additional navigation controls, or additional content information for the user. This child is not supported on the following agent types: pda.

setStart

public final void setStart(UINode startNode)

The start column region of the page. If present, this section typically contains either a SideNav (deprecated) or SideBar with additional navigation controls, or additional content information for the user. This child is not supported on the following agent types: pda.

getEnd

public final UINode getEnd()

The end column region. This region provides a location for presenting bins of additional information for the user. This child is not supported on the following agent types: pda.

setEnd

public final void setEnd(UINode endNode)

The end column region. This region provides a location for presenting bins of additional information for the user. This child is not supported on the following agent types: pda.

getContentFooter

public UINode getContentFooter()

DEPRECATED. The content footer region of the page. If present, this area typically contains either a PageButtonBar containing buttons that operate on the entire page, or a NavigationBar allowing the user to move to the next or previous step in a multistep process. Use the pageButtons and returnNavigation regions instead of this. This child is not supported on the following agent types: pda.

setContentFooter

public void setContentFooter(UINode contentFooterNode)

DEPRECATED. The content footer region of the page. If present, this area typically contains either a PageButtonBar containing buttons that operate on the entire page, or a NavigationBar allowing the user to move to the next or previous step in a multistep process. Use the pageButtons and returnNavigation regions instead of this. This child is not supported on the following agent types: pda.

getPageButtons

public final UINode getPageButtons()

The page-level navigation of the page. If present, this area typically contains either a PageButtonBar containing buttons that operate on the entire page, or a NavigationBar allowing the user to move to the next or previous step in a multistep process.

On certain look and feels, this child is shown twice, once under the page title and once at the bottom of the page. The only form element allowed in this area is a choice, and the choice must have a name.

The CONTENT_FOOTER child will be ignored when this child is present.

setPageButtons

public final void setPageButtons(UINode pageButtonsNode)

The page-level navigation of the page. If present, this area typically contains either a PageButtonBar containing buttons that operate on the entire page, or a NavigationBar allowing the user to move to the next or previous step in a multistep process.

On certain look and feels, this child is shown twice, once under the page title and once at the bottom of the page. The only form element allowed in this area is a choice, and the choice must have a name.

The CONTENT_FOOTER child will be ignored when this child is present.

getReturnNavigation

public final UINode getReturnNavigation()

The "return to [X]" link at the bottom of the page.

The CONTENT_FOOTER child will be ignored when this child is present.

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

setReturnNavigation

public final void setReturnNavigation(UINode returnNavigationNode)

The "return to [X]" link at the bottom of the page.

The CONTENT_FOOTER child will be ignored when this child is present.

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

getCopyright

public final UINode getCopyright()

The copyright region of the page. If present, this area typically contains a TextNode with the copyright information for the page. This child is not supported on the following agent types: pda.

setCopyright

public final void setCopyright(UINode copyrightNode)

The copyright region of the page. If present, this area typically contains a TextNode with the copyright information for the page. This child is not supported on the following agent types: pda.

getPrivacy

public final UINode getPrivacy()

The privacy region of the page. If present, this area typically contains a Link to the privacy policy for the site on which this page is present.

setPrivacy

public final void setPrivacy(UINode privacyNode)

The privacy region of the page. If present, this area typically contains a Link to the privacy policy for the site on which this page is present.

getAbout

public final UINode getAbout()

Area to put a link to more information about the application.

setAbout

public final void setAbout(UINode aboutNode)

Area to put a link to more information about the application.

getUserInfo

public final UINode getUserInfo()

The user information region. This region provides a location for presenting user login information and connection information. This child is not supported on the following agent types: pda.

setUserInfo

public final void setUserInfo(UINode userInfoNode)

The user information region. This region provides a location for presenting user login information and connection information. This child is not supported on the following agent types: pda.

getFootnote

public final UINode getFootnote()

The footnote region. This region provides a location for page-level status that is ancillary to the user's task. This child is not supported on the following agent types: pda.

setFootnote

public final void setFootnote(UINode footnoteNode)

The footnote region. This region provides a location for page-level status that is ancillary to the user's task. This child is not supported on the following agent types: pda.

getPageStatus

public final UINode getPageStatus()

The page-level status and/or key notation region. This region provides a location for page-level status that is important to the user's task. It also provides a location for a key notation. A key notation is a legend used to define icons, elements, or terms used within the page content.

setPageStatus

public final void setPageStatus(UINode pageStatusNode)

The page-level status and/or key notation region. This region provides a location for page-level status that is important to the user's task. It also provides a location for a key notation. A key notation is a legend used to define icons, elements, or terms used within the page content.

getTitle

public final java.lang.String getTitle()

Gets The title to display for this page.

setTitle

public final void setTitle(java.lang.String title)

Sets The title to display for this page.

setTranslatableTitle

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

Binds to a ResourceBundle the The title to display for this page.

Parameters:

bundleName - the name of the ResourceBundle

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

getMessageType

public final java.lang.String getMessageType()

Gets whether page is a messaging dialog. Legal values are "error", "info", "confirmation", "warning", "processing" and "none".

setMessageType

public final void setMessageType(java.lang.String messageType)

Sets whether page is a messaging dialog. Legal values are "error", "info", "confirmation", "warning", "processing" and "none".

isQuickLinksShown

public final boolean isQuickLinksShown()

Gets if links to the top-level headers should be shown on this page. This attribute is not supported on the following agent types: pda.

setQuickLinksShown

public final void setQuickLinksShown(boolean quickLinksShown)

Sets if links to the top-level headers should be shown on this page. This attribute is not supported on the following agent types: pda.

getContextSwitcher

public static UINode getContextSwitcher(MutableUINode bean)

The context switcher of a page. This child is not supported on the following agent types: pda.

setContextSwitcher

public static void setContextSwitcher(MutableUINode bean,
                                      UINode contextSwitcherNode)

The context switcher of a page. This child is not supported on the following agent types: pda.

getMessages

public static UINode getMessages(MutableUINode bean)

The node to display messages. Usually contains a messageBox.

setMessages

public static void setMessages(MutableUINode bean,
                               UINode messagesNode)

The node to display messages. Usually contains a messageBox.

getTabs

public static UINode getTabs(MutableUINode bean)

The Tab region of the page. If present, this location typically contains a TabBar. This child is not supported on the following agent types: pda.

setTabs

public static void setTabs(MutableUINode bean,
                           UINode tabsNode)

The Tab region of the page. If present, this location typically contains a TabBar. This child is not supported on the following agent types: pda.

getPageHeader

public static UINode getPageHeader(MutableUINode bean)

The header region of the page. This location typically contains a GlobalHeader. This child is not supported on the following agent types: pda.

setPageHeader

public static void setPageHeader(MutableUINode bean,
                                 UINode pageHeaderNode)

The header region of the page. This location typically contains a GlobalHeader. This child is not supported on the following agent types: pda.

getGlobalButtons

public static UINode getGlobalButtons(MutableUINode bean)

The global button region of the page. This section typically contains a GlobalButtonBar.

setGlobalButtons

public static void setGlobalButtons(MutableUINode bean,
                                    UINode globalButtonsNode)

The global button region of the page. This section typically contains a GlobalButtonBar.

getLargeAdvertisement

public static UINode getLargeAdvertisement(MutableUINode bean)

The large advertisement region of the page. If present, this section typically contains an image of the advertisement with a link for more information. This child is not supported on the following agent types: pda.

setLargeAdvertisement

public static void setLargeAdvertisement(MutableUINode bean,
                                         UINode largeAdvertisementNode)

The large advertisement region of the page. If present, this section typically contains an image of the advertisement with a link for more information. This child is not supported on the following agent types: pda.

getMediumAdvertisement

public static UINode getMediumAdvertisement(MutableUINode bean)

The medium advertisement region of the page. If present, this section typically contains an image of the advertisement with a link for more information. This child is not supported on the following agent types: pda.

setMediumAdvertisement

public static void setMediumAdvertisement(MutableUINode bean,
                                          UINode mediumAdvertisementNode)

The medium advertisement region of the page. If present, this section typically contains an image of the advertisement with a link for more information. This child is not supported on the following agent types: pda.

getCorporateBranding

public static UINode getCorporateBranding(MutableUINode bean)

The corporate branding region of the page. This section typically contains a medium size Image of the logo of the company owning the page.

setCorporateBranding

public static void setCorporateBranding(MutableUINode bean,
                                        UINode corporateBrandingNode)

The corporate branding region of the page. This section typically contains a medium size Image of the logo of the company owning the page.

getCobranding

public static UINode getCobranding(MutableUINode bean)

The associated cobranding region of the page. If present, This section typically contains a small Image of the logo of a non-owning company associated with the page. This child is not supported on the following agent types: pda.

setCobranding

public static void setCobranding(MutableUINode bean,
                                 UINode cobrandingNode)

The associated cobranding region of the page. If present, This section typically contains a small Image of the logo of a non-owning company associated with the page. This child is not supported on the following agent types: pda.

getProductBranding

public static UINode getProductBranding(MutableUINode bean)

The product branding region of the page. This section typically contains an Image of the product logo. This child is not supported on the following agent types: pda.

setProductBranding

public static void setProductBranding(MutableUINode bean,
                                      UINode productBrandingNode)

The product branding region of the page. This section typically contains an Image of the product logo. This child is not supported on the following agent types: pda.

getQuickSearch

public static UINode getQuickSearch(MutableUINode bean)

The quick search region of the page. This child is not supported on the following agent types: pda.

setQuickSearch

public static void setQuickSearch(MutableUINode bean,
                                  UINode quickSearchNode)

The quick search region of the page. This child is not supported on the following agent types: pda.

getLocation

public static UINode getLocation(MutableUINode bean)

The locator region of the page. If present, this section typically contains either a Train, indicating the user's location in a multistep process, or BreadCrumbs, containing links that will bring the user back to each of the parent pages of a tree of pages that he has navigated down into.

setLocation

public static void setLocation(MutableUINode bean,
                               UINode locationNode)

The locator region of the page. If present, this section typically contains either a Train, indicating the user's location in a multistep process, or BreadCrumbs, containing links that will bring the user back to each of the parent pages of a tree of pages that he has navigated down into.

getStart

public static UINode getStart(MutableUINode bean)

The start column region of the page. If present, this section typically contains either a SideNav (deprecated) or SideBar with additional navigation controls, or additional content information for the user. This child is not supported on the following agent types: pda.

setStart

public static void setStart(MutableUINode bean,
                            UINode startNode)

The start column region of the page. If present, this section typically contains either a SideNav (deprecated) or SideBar with additional navigation controls, or additional content information for the user. This child is not supported on the following agent types: pda.

getEnd

public static UINode getEnd(MutableUINode bean)

The end column region. This region provides a location for presenting bins of additional information for the user. This child is not supported on the following agent types: pda.

setEnd

public static void setEnd(MutableUINode bean,
                          UINode endNode)

The end column region. This region provides a location for presenting bins of additional information for the user. This child is not supported on the following agent types: pda.

getContentFooter

public static UINode getContentFooter(MutableUINode bean)

DEPRECATED. The content footer region of the page. If present, this area typically contains either a PageButtonBar containing buttons that operate on the entire page, or a NavigationBar allowing the user to move to the next or previous step in a multistep process. Use the pageButtons and returnNavigation regions instead of this. This child is not supported on the following agent types: pda.

setContentFooter

public static void setContentFooter(MutableUINode bean,
                                    UINode contentFooterNode)

DEPRECATED. The content footer region of the page. If present, this area typically contains either a PageButtonBar containing buttons that operate on the entire page, or a NavigationBar allowing the user to move to the next or previous step in a multistep process. Use the pageButtons and returnNavigation regions instead of this. This child is not supported on the following agent types: pda.

getPageButtons

public static UINode getPageButtons(MutableUINode bean)

The page-level navigation of the page. If present, this area typically contains either a PageButtonBar containing buttons that operate on the entire page, or a NavigationBar allowing the user to move to the next or previous step in a multistep process.

On certain look and feels, this child is shown twice, once under the page title and once at the bottom of the page. The only form element allowed in this area is a choice, and the choice must have a name.

The CONTENT_FOOTER child will be ignored when this child is present.

setPageButtons

public static void setPageButtons(MutableUINode bean,
                                  UINode pageButtonsNode)

The page-level navigation of the page. If present, this area typically contains either a PageButtonBar containing buttons that operate on the entire page, or a NavigationBar allowing the user to move to the next or previous step in a multistep process.

On certain look and feels, this child is shown twice, once under the page title and once at the bottom of the page. The only form element allowed in this area is a choice, and the choice must have a name.

The CONTENT_FOOTER child will be ignored when this child is present.

getReturnNavigation

public static UINode getReturnNavigation(MutableUINode bean)

The "return to [X]" link at the bottom of the page.

The CONTENT_FOOTER child will be ignored when this child is present.

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

setReturnNavigation

public static void setReturnNavigation(MutableUINode bean,
                                       UINode returnNavigationNode)

The "return to [X]" link at the bottom of the page.

The CONTENT_FOOTER child will be ignored when this child is present.

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

getCopyright

public static UINode getCopyright(MutableUINode bean)

The copyright region of the page. If present, this area typically contains a TextNode with the copyright information for the page. This child is not supported on the following agent types: pda.

setCopyright

public static void setCopyright(MutableUINode bean,
                                UINode copyrightNode)

The copyright region of the page. If present, this area typically contains a TextNode with the copyright information for the page. This child is not supported on the following agent types: pda.

getPrivacy

public static UINode getPrivacy(MutableUINode bean)

The privacy region of the page. If present, this area typically contains a Link to the privacy policy for the site on which this page is present.

setPrivacy

public static void setPrivacy(MutableUINode bean,
                              UINode privacyNode)

The privacy region of the page. If present, this area typically contains a Link to the privacy policy for the site on which this page is present.

getAbout

public static UINode getAbout(MutableUINode bean)

Area to put a link to more information about the application.

setAbout

public static void setAbout(MutableUINode bean,
                            UINode aboutNode)

Area to put a link to more information about the application.

getUserInfo

public static UINode getUserInfo(MutableUINode bean)

The user information region. This region provides a location for presenting user login information and connection information. This child is not supported on the following agent types: pda.

setUserInfo

public static void setUserInfo(MutableUINode bean,
                               UINode userInfoNode)

The user information region. This region provides a location for presenting user login information and connection information. This child is not supported on the following agent types: pda.

getFootnote

public static UINode getFootnote(MutableUINode bean)

The footnote region. This region provides a location for page-level status that is ancillary to the user's task. This child is not supported on the following agent types: pda.

setFootnote

public static void setFootnote(MutableUINode bean,
                               UINode footnoteNode)

The footnote region. This region provides a location for page-level status that is ancillary to the user's task. This child is not supported on the following agent types: pda.

getPageStatus

public static UINode getPageStatus(MutableUINode bean)

The page-level status and/or key notation region. This region provides a location for page-level status that is important to the user's task. It also provides a location for a key notation. A key notation is a legend used to define icons, elements, or terms used within the page content.

setPageStatus

public static void setPageStatus(MutableUINode bean,
                                 UINode pageStatusNode)

The page-level status and/or key notation region. This region provides a location for page-level status that is important to the user's task. It also provides a location for a key notation. A key notation is a legend used to define icons, elements, or terms used within the page content.

getTitle

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

Gets The title to display for this page.

setTitle

public static void setTitle(MutableUINode bean,
                            java.lang.String title)

Sets The title to display for this page.

setTranslatableTitle

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

Binds to a ResourceBundle the The title to display for this page.

Parameters:

bundleName - the name of the ResourceBundle

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

getMessageType

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

Gets whether page is a messaging dialog. Legal values are "error", "info", "confirmation", "warning", "processing" and "none".

setMessageType

public static void setMessageType(MutableUINode bean,
                                  java.lang.String messageType)

Sets whether page is a messaging dialog. Legal values are "error", "info", "confirmation", "warning", "processing" and "none".

isQuickLinksShown

public static boolean isQuickLinksShown(MutableUINode bean)

Gets if links to the top-level headers should be shown on this page. This attribute is not supported on the following agent types: pda.

setQuickLinksShown

public static void setQuickLinksShown(MutableUINode bean,
                                      boolean quickLinksShown)

Sets if links to the top-level headers should be shown on this page. This attribute is not supported on the following agent types: pda.