oracle.cabo.ui
Class BaseMutableUINode

java.lang.Object
  |
  +--oracle.cabo.ui.DeprecatedUINode
        |
        +--oracle.cabo.ui.BaseUINode
              |
              +--oracle.cabo.ui.BaseMutableUINode

All Implemented Interfaces:

MutableUINode, UIConstants, UINode

Direct Known Subclasses:

AppModuleScopeBean, AttrDefScopeBean, AttrScopeBean, BaseWebBean, ContextPropertyUINode, DataScopeBean, DisplayExceptionBean, DocumentBean, HTMLWebBean, ImportScriptBean, InputBean, MessageTextBean, RootAppModuleScopeBean, RowScopeBean, RowSetIteratorScopeBean, RowSetScopeBean, StyleSheetBean, TemplateUINode, ViewObjectScopeBean

public class BaseMutableUINode

extends BaseUINode

implements MutableUINode

Root implementation for storing a mutable node of a UIX Components (Marlin) UI tree. This class, as a superclass of BaseWebBean, is an ancestor of all the UIX Components (Marlin) WebBeans.

In addition to simply implementing the methods of MutableUINode, BaseMutableUINode, also specifies how the named and indexed children and attributes are stored, and allows the collections implementing this storage to be set and retrieved.

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

BaseMutableUINode(java.lang.String namespaceURI, java.lang.String localName)
Creates a BaseMutableUINode, binding it to a namespace and local name.

BaseMutableUINode(java.lang.String namespaceURI, java.lang.String localName, java.lang.String id)
Creates a BaseMutableUINode, binding it to a namespace and local name, and setting the ID.

BaseMutableUINode(java.lang.String namespaceURI, java.lang.String localName, java.lang.String id, int initialCapacity)
Creates a BaseMutableUINode, binding it to a namespace and local name, and setting the ID.

Method Summary

void	addIndexedChild(int childIndex, UINode child) Adds an indexed child to the node.
void	addIndexedChild(java.lang.String text) Adds a text child to the bean.
void	addIndexedChild(UINode child) Convenience method for appending an indexed child.
void	addIndexedChildren(java.util.Enumeration indexedChildren) Convenience method for appending an enumeration of indexed children.
void	addIndexedChildren(UINode[] indexedChildren) Convenience method for appending an array of indexed children.
void	clearIndexedChildren() Removes all of the indexed children.
protected AttributeMap	createAttributeMap() Creates the AttributeMap that will be used for attributes of this node.
protected UINodeList	createIndexedNodeList() Creates the UINodeList that will be used for indexed children of this node.
protected ContextMap	createNamedChildMap() Creates the ContextMap that will be used for named children of this node.
AttributeMap	getAttributeMap() Returns the AttributeMap used to store attributes.
protected AttributeMap	getAttributeMap(boolean createIfNull) Returns the AttributeMap used to store attributes.
java.lang.Object	getAttributeValue(AttributeKey attrKey) Returns the attribute value of the node; unlike the version of this method that takes a RenderingContext, this method must return the actual object originally set on the node - BoundValues will be directly returned.
java.lang.Object	getAttributeValue(java.lang.String attrKey) Deprecated. The version of this function taking an AttributeKey rather than a String is more efficient, and thus preferred. Callers should be defining their AttributeKeys as constants and reusing them, rather than calling this method, and forcing the correct AttributeKey to be looked up each time.
int	getIndexedChildCount() Deprecated. The version of this function also taking a RenderingContext is preferred, as this version will return incorrect results if the specified named child is determined by the RenderingContext.
UINodeList	getIndexedNodeList() Returns the UINodeList used to retrieve indexed children from the node.
protected UINodeList	getIndexedNodeList(boolean createIfNull) Returns the UINodeList used to retrieve indexed children from the node.
ContextMap	getNamedChildMap() Returns the ContextMap used to store named children.
protected ContextMap	getNamedChildMap(boolean forMutating) Returns the ContextMap used to store named children.
boolean	isRendered() Sets whether the bean is rendered.
UINode	removeIndexedChild(int childIndex) Removes an indexed child from the node.
void	replaceIndexedChild(int childIndex, UINode child) Replaces a single child.
void	setAttributeDictionary(java.util.Dictionary newAttrDictionary) Deprecated. This function is only present for backwards compatibility. For most uses, AttributeMap implementations other than DictionaryAttributeMap are more efficient.
void	setAttributeMap(AttributeMap newAttrMap) Replaces the AttributeMap used to store the attributes.
void	setAttributeValue(AttributeKey attrKey, java.lang.Object value) Sets an attribute value of the node.
void	setAttributeValue(java.lang.String attrKey, BoundValue value) Deprecated. The version of this function taking an AttributeKey rather than a String is more efficient, and thus preferred. Callers should be defining their AttributeKeys as constants and reusing them, rather than calling this method, and forcing the correct AttributeKey to be looked up each time.
void	setAttributeValue(java.lang.String attrKey, java.lang.Object value) Deprecated. The version of this function taking an AttributeKey rather than a String is more efficient, and thus preferred. Callers should be defining their AttributeKeys as constants and reusing them, rather than calling this method, and forcing the correct AttributeKey to be looked up each time.
void	setID(java.lang.String newID) Sets the page-wide unique client ID of this node.
void	setIndexedNodeList(UINodeList nodeList) Replaces the UINodeList used to store the list of indexed children for this UINode.
void	setNamedChild(java.lang.String childName, UINode namedChild) Sets a named child on the node.
void	setNamedChildMap(ContextMap childMap) Replaces the ContextMap used to store the named children for this UINode.
void	setNodeID(java.lang.String nodeID) Sets the ID indentifying this UINode instance.
void	setRendered(boolean rendered) Sets whether the bean is rendered.

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, getID, 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, getID, getIndexedChild, getIndexedChild, getIndexedChildCount, getLocalName, getNamedChild, getNamedChild, getNamespaceURI, getNodeID, getNodeRole, getRawAttributeValue, render, render

Constructor Detail

BaseMutableUINode

public BaseMutableUINode(java.lang.String namespaceURI,
                         java.lang.String localName)

Creates a BaseMutableUINode, binding it to a namespace and local name.

BaseMutableUINode

public BaseMutableUINode(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String id)

Creates a BaseMutableUINode, binding it to a namespace and local name, and setting the ID.

BaseMutableUINode

public BaseMutableUINode(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String id,
                         int initialCapacity)

Creates a BaseMutableUINode, binding it to a namespace and local name, and setting the ID.

Method Detail

setID

public void setID(java.lang.String newID)

Sets the page-wide unique client ID of this node. The string set must comply with the XML id specification--namely it must begin with a [a-z][A-z] and after that can contain as many of [a-z][A-Z][0-9][._-:] as desired.

This property is typically only needed when writing client-side JavaScript.

Specified by:

setID in interface MutableUINode

setRendered

public void setRendered(boolean rendered)

Sets whether the bean is rendered. When set to false, no output will be delivered for this bean.

isRendered

public boolean isRendered()

Sets whether the bean is rendered. When set to false, no output will be delivered for this bean.

getAttributeValue

public java.lang.Object getAttributeValue(java.lang.String attrKey)

Deprecated. The version of this function taking an AttributeKey rather than a String is more efficient, and thus preferred. Callers should be defining their AttributeKeys as constants and reusing them, rather than calling this method, and forcing the correct AttributeKey to be looked up each time.

Returns the value of the attribute with the specified name. If no attribute with the specified name exists in this UINode, or a checked Exception occurs in retrieving the value of the attribute, null will be returned.

Specified by:

getAttributeValue in interface MutableUINode

setAttributeValue

public final void setAttributeValue(java.lang.String attrKey,
                                    java.lang.Object value)

Deprecated. The version of this function taking an AttributeKey rather than a String is more efficient, and thus preferred. Callers should be defining their AttributeKeys as constants and reusing them, rather than calling this method, and forcing the correct AttributeKey to be looked up each time.

Sets an attribute value of the node.

Specified by:

setAttributeValue in interface MutableUINode

Parameters:

attrKey - the name of the attribute

value - the new value; passing null will remove any existing attribute with that name.

setAttributeValue

public final void setAttributeValue(java.lang.String attrKey,
                                    BoundValue value)

Deprecated. The version of this function taking an AttributeKey rather than a String is more efficient, and thus preferred. Callers should be defining their AttributeKeys as constants and reusing them, rather than calling this method, and forcing the correct AttributeKey to be looked up each time.

Sets an attribute value of the node.

Specified by:

setAttributeValue in interface MutableUINode

Parameters:

attrKey - the name of the attribute

value - the new value; passing null will remove any existing attribute with that name.

setAttributeDictionary

public final void setAttributeDictionary(java.util.Dictionary newAttrDictionary)

Deprecated. This function is only present for backwards compatibility. For most uses, AttributeMap implementations other than DictionaryAttributeMap are more efficient.

Backwards compatibility convenience function that replaces the AttributeMap used to store the attributes with an AttributeMap that delegates to the specified Dictionary. All currently set attributes will be forgotten, and all future requests to get or set attributes will go to this AttributeMap. Neither the ID of this node nor its children are retrived from this AttributeMap.

addIndexedChild

public void addIndexedChild(int childIndex,
                            UINode child)

Adds an indexed child to the node. Unlike many other APIs, adding a child does not remove it from any other parent nodes.

Specified by:

addIndexedChild in interface MutableUINode

Parameters:

childIndex - the zero-based index to add the child at

child - the new child node

addIndexedChild

public void addIndexedChild(UINode child)

Convenience method for appending an indexed child.

Specified by:

addIndexedChild in interface MutableUINode

Following copied from interface: oracle.cabo.ui.MutableUINode

Parameters:

child - the new child node

See Also:

MutableUINode.removeIndexedChild(int), MutableUINode.clearIndexedChildren(), List.add(java.lang.Object)

addIndexedChildren

public final void addIndexedChildren(UINode[] indexedChildren)

Convenience method for appending an array of indexed children.

addIndexedChildren

public final void addIndexedChildren(java.util.Enumeration indexedChildren)

Convenience method for appending an enumeration of indexed children.

addIndexedChild

public void addIndexedChild(java.lang.String text)

Adds a text child to the bean. A convenience function that automatically creates a TextNode.

Parameters:

text - the text - does not need to be escaped

removeIndexedChild

public UINode removeIndexedChild(int childIndex)

Removes an indexed child from the node.

Specified by:

removeIndexedChild in interface MutableUINode

Parameters:

childIndex - the zero-based index of the child

clearIndexedChildren

public void clearIndexedChildren()

Removes all of the indexed children.

Specified by:

clearIndexedChildren in interface MutableUINode

Following copied from interface: oracle.cabo.ui.MutableUINode

See Also:

MutableUINode.removeIndexedChild(int), Collection.clear()

replaceIndexedChild

public void replaceIndexedChild(int childIndex,
                                UINode child)

Replaces a single child.

Although this method could be implemented in terms of addIndexedChild and removeIndexedChild, it is present on this interface in order to allow for more efficient implementations.

Specified by:

replaceIndexedChild in interface MutableUINode

Parameters:

childIndex - the zero-based index to add the child at.

child - the new child node

See Also:

removeIndexedChild(int)

setNamedChild

public void setNamedChild(java.lang.String childName,
                          UINode namedChild)

Sets a named child on the node. Any node attached with that name will be removed.

Specified by:

setNamedChild in interface MutableUINode

Parameters:

childName - the name of the child

namedChild - the child; passing null will remove any existing UINode with that name.

getAttributeValue

public final java.lang.Object getAttributeValue(AttributeKey attrKey)

Returns the attribute value of the node; unlike the version of this method that takes a RenderingContext, this method must return the actual object originally set on the node - BoundValues will be directly returned.

Parameters:

name - the name of the attribute

setAttributeValue

public void setAttributeValue(AttributeKey attrKey,
                              java.lang.Object value)

Sets an attribute value of the node.

Specified by:

setAttributeValue in interface MutableUINode

Parameters:

name - the name of the attribute

value - the new value; passing null will remove any existing attribute with that name.

setNodeID

public void setNodeID(java.lang.String nodeID)

Sets the ID indentifying this UINode instance. This ID is never output to the user agent.

Node IDs should be static over the lifetime of a webbean, so clients should avoid setting the node ID more than once.

This method is especiall useful for clients creating webbeans with <jsp:usebean> as that creation approach can only use zero-argument constructors.

Specified by:

setNodeID in interface MutableUINode

Overrides:

setNodeID in class BaseUINode

setAttributeMap

public void setAttributeMap(AttributeMap newAttrMap)

Replaces the AttributeMap used to store the attributes. All currently set attributes will be forgotten, and all future requests to get or set attributes will go to this dictionary. Neither the ID of this node nor its children are retrieved from this dictionary.

setIndexedNodeList

public void setIndexedNodeList(UINodeList nodeList)

Replaces the UINodeList used to store the list of indexed children for this UINode. All current indexed children of this UINode are forgotten and all request to get and set indexed children will go to this UINodeList.

See Also:

setAttributeMap(oracle.cabo.ui.collection.AttributeMap), setNamedChildMap(oracle.cabo.ui.collection.ContextMap)

setNamedChildMap

public void setNamedChildMap(ContextMap childMap)

Replaces the ContextMap used to store the named children for this UINode. All current named children of this UINode are forgotten and all request to get and set named children will go to this ContextMap.

getNamedChildMap

public final ContextMap getNamedChildMap()

Returns the ContextMap used to store named children.

getNamedChildMap

protected final ContextMap getNamedChildMap(boolean forMutating)

Returns the ContextMap used to store named children.

Overrides:

getNamedChildMap in class BaseUINode

Parameters:

createIfNull - if true, creates a ContextMap object if one has not yet been created.

getAttributeMap

public final AttributeMap getAttributeMap()

Returns the AttributeMap used to store attributes.

getAttributeMap

protected final AttributeMap getAttributeMap(boolean createIfNull)

Returns the AttributeMap used to store attributes.

Overrides:

getAttributeMap in class BaseUINode

Parameters:

createIfNull - if true, creates an AttributeMap object if one has not yet been created.

getIndexedNodeList

public final UINodeList getIndexedNodeList()

Returns the UINodeList used to retrieve indexed children from the node. getIndexedChild(), getIndexedChildCount(), and replaceIndexedChild() will use the result of this method - if not implemented, subclasses must override both of those methods.

See Also:

BaseUINode.getIndexedChild(oracle.cabo.ui.RenderingContext, int), replaceIndexedChild(int, oracle.cabo.ui.UINode), getIndexedChildCount()

getIndexedChildCount

public int getIndexedChildCount()

Deprecated. The version of this function also taking a RenderingContext is preferred, as this version will return incorrect results if the specified named child is determined by the RenderingContext.

Convenience function for returning the number of indexed children in this UINode.

Specified by:

getIndexedChildCount in interface UINode

Overrides:

getIndexedChildCount in class BaseUINode

getIndexedNodeList

protected final UINodeList getIndexedNodeList(boolean createIfNull)

Returns the UINodeList used to retrieve indexed children from the node. getIndexedChild(), getIndexedChildCount(), and replaceIndexedChild() will use the result of this method - if not implemented, subclasses must override all of those methods.

Overrides:

getIndexedNodeList in class BaseUINode

See Also:

BaseUINode.getIndexedChild(oracle.cabo.ui.RenderingContext, int), replaceIndexedChild(int, oracle.cabo.ui.UINode), getIndexedChildCount()

createIndexedNodeList

protected UINodeList createIndexedNodeList()

Creates the UINodeList that will be used for indexed children of this node.

createNamedChildMap

protected ContextMap createNamedChildMap()

Creates the ContextMap that will be used for named children of this node.

createAttributeMap

protected AttributeMap createAttributeMap()

Creates the AttributeMap that will be used for attributes of this node.