oracle.cabo.ui
Class BaseUINode

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

All Implemented Interfaces:

UIConstants, UINode

Direct Known Subclasses:

BaseMutableUINode, ContextPoppingUINode

public class BaseUINode

extends DeprecatedUINode

implements UINode, UIConstants

Root implementation for storing a node of a UIX Components (Marlin) UI tree.

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

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

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

Method Summary

protected AttributeMap	getAttributeMap(boolean createIfNull) Returns the AttributeMap used to store attributes.
java.util.Enumeration	getAttributeNames(RenderingContext context) Returns an Enumeration of the names that attribute values have been added under.
java.lang.Object	getAttributeValue(RenderingContext context, AttributeKey attrKey) Returns the value of the attribute with the specified name in the RenderingContext.
protected java.lang.Object	getAttributeValueImpl(RenderingContext context, AttributeKey attrKey, boolean returnBoundValue) Bottleneck method for all attribute getting.
protected UINode[]	getChildArray() Returns the child array used to retrieve indexed children from the node.
java.util.Enumeration	getChildNames(RenderingContext context) Returns an Enumeration of the names that named children have been added under.
UINode	getIndexedChild(int childIndex) Deprecated. The version of this function also taking a RenderingContext is preferred, as this version will return incorrect results if the specified indexed child is determined by the RenderingContext.
UINode	getIndexedChild(RenderingContext context, int childIndex) Returns the indexed child at the specified index.
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.
int	getIndexedChildCount(RenderingContext context) Returns the number of indexed children in this UINode.
protected UINodeList	getIndexedNodeList(boolean createIfNull) Returns the UINodeList used to retrieve indexed children from the node.
java.lang.String	getLocalName() Name used to distinguish the name of a UINode within a namespace.
UINode	getNamedChild(RenderingContext context, java.lang.String childName) Returns the child identified by childName.
protected ContextMap	getNamedChildMap(boolean createIfNull) Returns the dictionary used to store named children.
java.lang.String	getNamespaceURI() The namespace URI that segregates the local name of this UINode so that nodes with the same local name will not clash.
java.lang.String	getNodeID() Returns an ID indentifying this UINode instance.
NodeRole	getNodeRole(RenderingContext context) Returns the role that this node occupies.
protected java.lang.Object	getPreorderDescendentAttributeValue(RenderingContext context, AttributeKey attrKey) Returns the first attribute value for the specified attrName, found by performing a preorder (depth-first) search of the startNode and its children.
java.lang.Object	getRawAttributeValue(RenderingContext context, AttributeKey attrKey) Returns the value of the attribute with a specified name, without attempting to further resolve that value - as if , for instance, it might be a BoundValue.
protected UINode	getRenderedUINode(RenderingContext context) Returns the UINode to render and to use to dtermine the renderer.
protected Renderer	getRenderer(RenderingContext context)
protected Renderer	getRenderer(RenderingContext context, UINode dataNode) Returns the Renderer used to render this UINode.
void	render(RenderingContext context) Renders this UINode.
void	render(RenderingContext context, UINode dataNode) Renders this UINode.
protected void	setNodeID(java.lang.String newID) Sets the nodeID.
java.lang.String	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

getAttributeValue, getChildNames, getID, getNamedChild

Constructor Detail

BaseUINode

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

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

BaseUINode

public BaseUINode(java.lang.String namespaceURI,
                  java.lang.String localName,
                  java.lang.String nodeID)

Creates a BaseUINode, binding it to a namespace and local name, and setting the nodeID.

Method Detail

getNamespaceURI

public java.lang.String getNamespaceURI()

The namespace URI that segregates the local name of this UINode so that nodes with the same local name will not clash. Together, the namespace URI and the local identify the kind of UINode that this is.

Any namespace String returned by this method should be interned for maximum performance. This allows namespace comparisons to be performed using object identity, versus the slower object equality. If the String returned is a String constant, the Java VM will have done this for you automatically.

As with all namespace URI's, this name is only used as an identifier. No other sematics are implied.

The RendererManager allows RendererFactorys to be registered by namespace.

Specified by:

getNamespaceURI in interface UINode

See Also:

getLocalName(), RendererManager, RendererFactory

getLocalName

public java.lang.String getLocalName()

Name used to distinguish the name of a UINode within a namespace.

Together with the UINode's namespace URI, the local name is typically used to determine which Renderer to use to render the UINode.

Specified by:

getLocalName in interface UINode

getNodeID

public java.lang.String getNodeID()

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

This ID should not be confused with the ID_ATTR attribute, which is output to the client and is typically used in conjunction with client-side scripting technologies, such as JavaScript.

Specified by:

getNodeID in interface UINode

getIndexedChildCount

public int getIndexedChildCount(RenderingContext context)

Returns the number of indexed children in this UINode.

Specified by:

getIndexedChildCount in interface UINode

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

See Also:

UINode.getIndexedChild(oracle.cabo.ui.RenderingContext, int)

getIndexedChild

public UINode getIndexedChild(RenderingContext context,
                              int childIndex)

Returns the indexed child at the specified index. Indexed children are used to represent homogenously treated children of UINodes.

If the UINode is mutable and may be modified and read in different threads, it is the programmer's responsibility to ensure proper synchronization.

Specified by:

getIndexedChild in interface UINode

See Also:

getIndexedChildCount(oracle.cabo.ui.RenderingContext)

getNamedChild

public UINode getNamedChild(RenderingContext context,
                            java.lang.String childName)

Returns the child identified by childName. Named children are used to represent heterogenously treated children of UINodes.

Constants for named children used by UIX Components (Marlin)'s UINodes may be found in the UIConstants interface. The constants for the named children follow the pattern <xxx>_CHILD.

If the UINode is mutable and may be modified and read in different threads, it is the programmer's responsibility to ensure proper synchronization.

Specified by:

getNamedChild in interface UINode

See Also:

getChildNames(oracle.cabo.ui.RenderingContext), UIConstants

getChildNames

public java.util.Enumeration getChildNames(RenderingContext context)

Returns an Enumeration of the names that named children have been added under. The actual UINodes for these named children may be retrieved by passing the Strings returned by this Enumeration to getNamedChild.

If the UINode is mutable and may be modified and read in different threads, it is the programmer's responsibility to ensure proper synchronization.

Specified by:

getChildNames in interface UINode

See Also:

getNamedChild(oracle.cabo.ui.RenderingContext, java.lang.String)

getAttributeValue

public final java.lang.Object getAttributeValue(RenderingContext context,
                                                AttributeKey attrKey)

Returns the value of the attribute with the specified name in the RenderingContext. 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.

Note that as with indexed children and named children, the presence of of an attribute is no guarantee that the Renderer used to render this UINode will actually use the attribute. The presence of attributes should only be considered as hints to the Renderer.

If the UINode is mutable and may be modified and read in different threads, it is the programmer's responsibility to ensure proper synchronization.

Specified by:

getAttributeValue in interface UINode

See Also:

getAttributeNames(oracle.cabo.ui.RenderingContext)

getRawAttributeValue

public final java.lang.Object getRawAttributeValue(RenderingContext context,
                                                   AttributeKey attrKey)

Description copied from interface: UINode

Returns the value of the attribute with a specified name, without attempting to further resolve that value - as if , for instance, it might be a BoundValue.

Specified by:

getRawAttributeValue in interface UINode

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

See Also:

BoundValue

getAttributeNames

public java.util.Enumeration getAttributeNames(RenderingContext context)

Returns an Enumeration of the names that attribute values have been added under. The actual values for these attributes may be retrieved by passing the AttributeKeys returned by this Enumeration to getAttributeValue.

If the UINode is mutable and may be modified and read in different threads, it is the programmer's responsibility to ensure proper synchronization.

Specified by:

getAttributeNames in interface UINode

See Also:

getAttributeValue(oracle.cabo.ui.RenderingContext, oracle.cabo.ui.AttributeKey)

getNodeRole

public NodeRole getNodeRole(RenderingContext context)

Returns the role that this node occupies.

Specified by:

getNodeRole in interface UINode

render

public final void render(RenderingContext context)
                  throws java.io.IOException

Renders this UINode. Clients can implements this method in any way desired. All UIX Components (Marlin) based implementations will get a RendererManager from the RenderingContext, get a Renderer, and defer rendering to that Renderer.

Specified by:

render in interface UINode

render

public void render(RenderingContext context,
                   UINode dataNode)
            throws java.io.IOException

Renders this UINode. Clients can implements this method in any way desired. All UIX Components (Marlin) based implementations will get a RendererManager from the RenderingContext, get a Renderer, and defer rendering to that Renderer.

Specified by:

render in interface UINode

getRenderer

protected final Renderer getRenderer(RenderingContext context)

getRenderer

protected Renderer getRenderer(RenderingContext context,
                               UINode dataNode)

Returns the Renderer used to render this UINode. Although UINodes typically delegate the binding of the Renderer to the RenderManager on the RenderingContext, UINodes are free to implement getRenderer to return any Renderer it wishes. An example of this is TextNode, which always returns TextRenderer as its renderer.

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 DeprecatedUINode

getIndexedChild

public final UINode getIndexedChild(int childIndex)

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

Convenience function for returning a n indexed UINode child given its index.

Specified by:

getIndexedChild in interface UINode

Overrides:

getIndexedChild in class DeprecatedUINode

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getChildArray

protected final UINode[] getChildArray()

Returns the child array used to retrieve indexed children from the node. By default, returns null. getIndexedChild() and getIndexedChildCount() will use the result of this method - if not implemented, subclasses must override both of those methods. Subclasses should not copy the array - so subclasses must be extremely careful when modifying this array or returning to "untrusted" classes.

See Also:

getIndexedChild(oracle.cabo.ui.RenderingContext, int), getIndexedChildCount(oracle.cabo.ui.RenderingContext)

getNamedChildMap

protected ContextMap getNamedChildMap(boolean createIfNull)

Returns the dictionary used to store named children. This class just returns null.

Parameters:

createIfNull - if true, the subclass should create a NamedChildMap object if one has not yet been created.

getAttributeMap

protected AttributeMap getAttributeMap(boolean createIfNull)

Returns the AttributeMap used to store attributes. This class just returns null.

Parameters:

createIfNull - if true, the subclass must create a Dictionary object if one has not yet been created.

getIndexedNodeList

protected UINodeList getIndexedNodeList(boolean createIfNull)

Returns the UINodeList used to retrieve indexed children from the node. By default, returns null. getIndexedChild() and getIndexedChildCount() will use the result of this method - if not implemented, subclasses must override both of those methods. Subclasses should not clone the UINodeList - so subclasses must be extremely careful when modifying this list or returning to "untrusted" classes.

See Also:

getIndexedChild(oracle.cabo.ui.RenderingContext, int), getIndexedChildCount(oracle.cabo.ui.RenderingContext)

setNodeID

protected void setNodeID(java.lang.String newID)

Sets the nodeID. nodeIDs should be static over the lifetime of a webbean, so clients should avoid setting the nodeID more than once. This method exists so that subclasses that need a zero-argument constructor can still support IDs.

getAttributeValueImpl

protected java.lang.Object getAttributeValueImpl(RenderingContext context,
                                                 AttributeKey attrKey,
                                                 boolean returnBoundValue)

Bottleneck method for all attribute getting.

getPreorderDescendentAttributeValue

protected java.lang.Object getPreorderDescendentAttributeValue(RenderingContext context,
                                                               AttributeKey attrKey)

Returns the first attribute value for the specified attrName, found by performing a preorder (depth-first) search of the startNode and its children.

getRenderedUINode

protected UINode getRenderedUINode(RenderingContext context)

Returns the UINode to render and to use to dtermine the renderer. Subclasses can override this method to return a different rendered UINode hierarchy than that apparent from the client's view of the UINode hierarchy, enabling composite UINodes to be created.