oracle.cabo.ui.data
Class MessageData
java.lang.Object
|
+--oracle.cabo.ui.data.DictionaryData
|
+--oracle.cabo.ui.data.MessageData
- All Implemented Interfaces:
- DataObject, DataObjectList, KeyedDataObject, MutableDataObject, UIConstants
- public class MessageData
- extends DictionaryData
- implements UIConstants, DataObjectList
When combined with InlineMessageBean, or any of the other "message" beans (beans in the oracle.cabo.ui.beans.message package), the MessageData class makes it easy to automatically show error, warning, or informational messages and icons around form widgets without adjusting a page's hierarchy. The MessageData object provides a standard binding for all the error, info, and warning information on a page.
The MessageBoxBean can also utilize the MessageData to automatically configure itself to display messages based on the contents of a MessageData instance. More details on utilizing this functionality can be found in the MessageBoxBean documentation.
To use, when creating your UINodes:
- First, create a series of message beans, and add their content. There's no need to set anything other than the prompt of each bean.
- For each message bean, pick a name. This name can be the name set on the widget inside the bean, but it doesn't have to be. The name should not include any whitespace.
- Pass the message bean and that name to
MessageData.bindNode()
.
Then, just before rendering, if there are no messages do nothing. If there are any messages:
- Create a MessageData object.
- For each widget that has an error, call one of
addError()
, addWarning()
, or addInfo()
. Pass the same name that was sent to MessageData.bindNode()
- Register the MessageData object with
MessageData.addToRenderingContext()
If you want to register the message DataObject with a custom namespace or name, use the 4-arg bindNode()
method, and register the DataObject yourself before rendering.
A MessageData is essentially a DictionaryData, where each of the contained elements is itself a DataObject. These contained DataObjects contain three properties:
- "messageType": the message type, either "error", "info", or "warning"
- "message": the message text
- "longDescURL": an optional link to a location with more information
Additionally, clients can also specify messageLinkText and messageDescription properties which are used by a MessageBoxBean which is automatically configured to utilize MessageData. If these properties are not specified, the MessageBoxBean will fall back on the chosen "name" and the "message" properties, respectively. Otherwise these two properties are not used.
When bound (using one of the two bindNode()
methods), the MESSAGE_TYPE_ATTR
, MESSAGE_ATTR
, and LONG_DESC_URL_ATTR
attributes of the target node will be dynamically retrieved from one of the pieces of the MessageData object.
- See Also:
MessageBean
, MessageBoxBean
, MessagePromptBean
, MessageTextBean
Field Summary |
static java.lang.String |
MESSAGE_DATA_COUNT_SELECT
Deprecated. since 2.0; call getLength() on the DataObjectList returned by MESSAGE_DATA_MESSAGES_SELECT instead |
static java.lang.String |
MESSAGE_DATA_MESSAGE
A key value which can be passed to selectValue() to return the summary text for the entire set of messages. |
static java.lang.String |
MESSAGE_DATA_MESSAGES_SELECT
A key value which can be passed to selectValue() to return a DataObjectList with each DataObject representing the message data for one of the registered messages. |
static java.lang.String |
MESSAGE_DATA_OBJECT_NAME
Default name under which MessageData DataObjects may be registered. |
static java.lang.String |
MESSAGE_DATA_TYPE_SELECT
A key value which can be passed to selectValue() to return one of the UIConstants (e.g. |
Fields inherited from interface oracle.cabo.ui.UIConstants |
ABBREVIATION_ATTR, ABOUT_CHILD, ACCESS_KEY_ATTR, ADD_NAME, ADD_ROWS_EVENT, ADD_TABLE_ROW_NAME, ADVANCED_CHOICES_CHILD, AGENT_NAME, ALIGNMENT_GROUP_ATTR, ALL_DETAILS_ENABLED_ATTR, ALLOWS_TRANSPARENT_ATTR, ALTERNATE_CONTENT_CHILD, ALTERNATE_TEXT_ATTR, ANCESTOR_ATTRIBUTE_NAME, ANCESTOR_ID_ATTR, ANCESTOR_PATH_ATTR, ANCHOR_ATTR, AND_NAME, ANNOTATION_ATTR, APPLICATION_SWITCHER_NAME, ARRAY_NODE_LIST_NAME, ATTRIBUTE_MAP_NAME, AUTOFLIP_ATTR, AUTOMATIC_ATTR, AUTOSTART_ATTR, BACKGROUND_ATTR, BACKGROUND_DARK, BACKGROUND_LIGHT, BACKGROUND_MEDIUM, BACKGROUND_TRANSPARENT, 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_CRUMB_TEXT_ATTR, BREAD_CRUMBS_NAME, BROWSE_EVENT, BROWSE_MENU_NAME, BULLETED_LIST_NAME, BULLETS_GROUP_ATTR, BUNDLE_NAME, BUTTON_NAME, BUTTONS_CHILD, BYTE_LENGTH_NAME, CALENDAR_ID_ATTR, 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_BLOCK_SIZE_ATTR, CHILD_DATA_ATTR, CHILD_LIST_NAME, CHILD_MAP_NAME, CHILD_NAME_ATTR, CHILD_TYPE_TEXT, CHILD_TYPE_TEXT_ATTR, CHOICE_NAME, CHROME_TYPE_ATTR, CLICK_THRU_DESTINATION_URI_ATTR, COBRANDING_CHILD, COLLAPSE_ALL_EVENT, COLLAPSE_DESTINATION_KEY, COLOR_BUTTON_NAME, COLOR_DATA_ATTR, COLOR_FIELD_NAME, COLOR_NAME, COLOR_PALETTE_NAME, COLOR_PICKER_NAME, COLOR_SWATCH_NAME, 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, COMPACT_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, CONFIG_NAME_PARAM, 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, CONTEXT_URI_PARAM, CONTROLS_ALL, CONTROLS_ATTR, CONTROLS_MINIMAL, CONTROLS_NONE, CONTROLS_NONE_VISIBLE, CONTROLS_TYPICAL, CONVERT_NAME, CONVERT_PARAM, COPYRIGHT_CHILD, CORPORATE_BRANDING_CHILD, CURRENT_DATA_ATTR, CURRENT_INDEX_ATTR, CURRENT_THROWABLE_PROPERTY, CUSTOM_COLOR_DATA_ATTR, DATA_KEY, DATA_NAME, DATA_NAME_ATTR, DATA_NAMESPACE_ATTR, DATA_OBJECT_NAME, DATA_SCOPE_NAME, DATA_TYPE_ATTR, DATE_BUTTON_NAME, DATE_EVENT, DATE_FIELD_NAME, DATE_FORMAT_NAME, DATE_NAME, DATE_STYLE_PARAM, DECIMAL_NAME, DEFAULT_CASE_ATTR, DEFAULT_CONTENTS_ATTR, DEFAULT_FORM_NAME, DEFAULT_NAME, DEFAULTING_NAME, DESCRIPTION_ATTR, 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, EDGE_STAMP_CHILD, EDIT_GROUP_ATTR, EMBEDDED_ATTR, ENC_PARAM, ENCODED_PARAMETER_NAME, END_CHILD, ENTER_CLIENT_ACTION_ATTR, EVENT_ATTR, EVENT_PARAM, EXCEPTIONS_CAUGHT_PROPERTY, EXPAND_ALL_EVENT, EXPAND_DESTINATION_KEY, EXPAND_EVENT, EXPANDABLE_ALWAYS, EXPANDABLE_COLLAPSED, EXPANDABLE_EXPANDED, EXPANDABLE_KEY, EXPANDABLE_NO, EXPRESSION_LANGUAGE_ATTRIBUTE_NAME, FACET_DEFAULT, FACET_EMAIL, FACET_PORTLET, FACET_PRINTABLE, FIELD_WIDTH_ATTR, FILE_UPLOAD_NAME, FILTER_CHILD, FILTER_CHOICE_CHILD, FIRST_CLICK_PASSED_ATTR, FIXED_NAME, FLOW_LAYOUT_NAME, FOCUS_EVENT, FONT_BAR_ATTR, FONT_BEAN_ATTR, FONT_COLOR_BEAN_ATTR, FONT_SIZE_BEAN_ATTR, FOOTER_CHILD, 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, GRAPH_DIAGRAM_NAME, GRAPH_EDGE_NAME, GRAPH_NODE_NAME, GRAPH_VIEW_STATE_ATTR, 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_ATTR, HEADER_INSTRUCTIONS_CHILD, HEADER_NAME, HEADERS_ATTR, HEIGHT_ATTR, HIDE_EVENT, HIDE_SHOW_HEADER_NAME, HIDE_SHOW_NAME, HYPERLINK_BUTTON_ATTR, ICON_ATTR, ICON_BUTTON_FORMAT, ICON_KEY, ICON_KEY_NAME, ICON_NAME, ICON_REQUIRED, ICON_SHORT_DESC_KEY, ID_ATTR, IF_NAME, IMAGE_ATTR, IMAGE_MAP_TYPE_ATTR, IMAGE_MAP_TYPE_NONE, IMAGE_MAP_TYPE_SERVER, IMAGE_NAME, IMAGE_UPLOAD_URI_ATTR, IMPORT_SCRIPT_NAME, IN_CONTEXT_BRANDING_CHILD, IN_CONTEXT_BRANDING_STYLE, INCLUDE_NAME, INCOMPLETE_DATA_SET, INDENTATION_GROUP_ATTR, INITIAL_FOCUS_CONTEXT_PROPERTY, INITIAL_FOCUS_ID_ATTR, INLINE_DATE_PICKER_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, INSTRUCTION_STYLE, ITEM_TITLE_ATTR, ITEMS_CHILD, JSP_PARAM, 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, LOC_PARAM, LOCATION_CHILD, LOCATION_PARAM, LONG_DESC_ATTR, LONG_DESC_URL_ATTR, LOV_BUTTON_NAME, LOV_CHOICE_NAME, LOV_EVENT, LOV_FIELD_NAME, LOV_FILTER_EVENT, LOV_INPUT_NAME, LOV_LIBRARY_NAME, LOV_SEARCH_TEXT, LOV_SELECT_COLUMN_NAME, MAILTO_NAME, MAIN_VIEW_HEIGHT_ATTR, MAIN_VIEW_WIDTH_ATTR, MARLIN_NAMESPACE, MAX_VALUE_ATTR, MAX_VALUE_PARAM, 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_COLOR_FIELD_NAME, MESSAGE_COMPONENT_LAYOUT_NAME, MESSAGE_DATA_ATTR, MESSAGE_DATA_TEXT_NAME, MESSAGE_DATE_FIELD_NAME, MESSAGE_FILE_UPLOAD_NAME, MESSAGE_FORMAT_NAME, MESSAGE_LAYOUT_NAME, MESSAGE_LIST_NAME, MESSAGE_LOV_CHOICE_NAME, MESSAGE_LOV_FIELD_NAME, MESSAGE_LOV_INPUT_NAME, MESSAGE_PROMPT_NAME, MESSAGE_RADIO_BUTTON_NAME, MESSAGE_RADIO_GROUP_NAME, MESSAGE_RADIO_SET_NAME, MESSAGE_RICH_TEXT_EDITOR_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, MIN_VALUE_PARAM, MINIMUM_WIDTH_ATTR, MODEL_ATTR, MONTH_PARAM, MULTIPLE_ATTR, MULTIPLE_SELECTION_NAME, NAME_ATTR, NAME_TRANSFORMED_ATTR, NAME_VALUES_ATTR, NAMED_SOURCE_ATTR, NAMES_ATTR, NAVIGATE_EVENT, NAVIGATION_BAR_NAME, NAVIGATION_EXCLUDE_NAMES_ATTR, NAVIGATION_FORM_NAME_ATTR, NAVIGATOR_HEIGHT_ATTR, NAVIGATOR_WIDTH_ATTR, NEXT_EVENT, NO_BANDING, NODE_ATTR, NODE_PARAM, NODE_STAMP_CHILD, NODES_ATTR, NODES_KEY, NOT_NAME, NULL_NAME, NUMBER_FORMAT, OBJECT_NAME_FORMAT, ON_BLUR_ATTR, ON_BLUR_VALIDATER_ATTR, ON_CHANGE_ATTR, ON_CLICK_ATTR, ON_CLICK_KEY, ON_COLOR_SELECT_ATTR, ON_DEMAND, 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_NAME, PAGE_STAMP_STYLE, PAGE_STATUS_CHILD, PALETTE_ID_ATTR, PALETTE_NAME, PARAM_NAME_EXCHANGES_ATTR, PARSE_NAME, PARTIAL_CONTENT_NAME, PARTIAL_KEEP_ALIVE_PROPERTY, PARTIAL_LINK_NAME, PARTIAL_LIST_UNRENDERED_PROPERTY, 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, PATTERN_ATTR, PATTERN_PARAM, PATTERNS_ATTR, PERCENT_COMPLETE_ATTR, PERCENT_UNKNOWN, PICKER_ID_ATTR, PLAY_COUNT_ATTR, PLAYER_ATTR, PLAYER_LINK, PLAYER_QUICKTIME, PLAYER_REAL, PLAYER_WINDOWS, PORTLET_NAME, POST_TEXT_ATTR, PRE_TEXT_ATTR, PREVIOUS_EVENT, PRIMARY_CLIENT_ACTION_ATTR, PRIVACY_CHILD, PROCESS_STEPS_NAME, PROCESSING_LAYOUT_NAME, PROCESSING_NAME, PRODUCT_BRANDING_CHILD, PRODUCT_BRANDING_NAME, PROMPT_ATTR, PROMPT_CHILD, PROMPT_WIDTH_ATTR, 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, RENDERING_MODE_ATTR, REORDERABLE_ATTR, REQUIRED_ATTR, REQUIRED_NO, REQUIRED_UI_ONLY, REQUIRED_VALIDATER_ONLY, REQUIRED_YES, RESET_BUTTON_NAME, RETURN_NAVIGATION_CHILD, RICH_TEXT_EDITOR_NAME, RICH_TEXT_MODE, RICH_TEXT_MODE_DISPLAY_HEIGHT_ATTR, RICH_TEXT_MODE_DISPLAY_LENGTH_ATTR, RICH_TEXT_MODE_EVENT, 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, SCROLLED_VALUE_PARAM, SCROLLING_ATTR, SCROLLING_AUTO, SCROLLING_NO, SCROLLING_YES, SEARCH_AREA_MODE_ATTR, SEARCH_DESC_ATTR, SEARCH_INSTRUCTIONS_CHILD, SEARCH_TEXT_ATTR, SECRET_ATTR, SECRET_FIELD_DEFAULT_VALUE, SELECT_ATTR, SELECT_MODE_KEY, SELECT_OPTION_NAME, SELECTED_ATTR, SELECTED_INDEX_ATTR, SELECTED_KEY, SELECTED_VALUE_ATTR, SELECTION_ATTR, SELECTION_PARAM, SEPARATOR_CHILD, SEPARATOR_NAME, SERVER_VALIDATER_ATTR, SERVLET_INCLUDE_NAME, SET_CONTEXT_PROPERTY_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, 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_CHECK_ATTR, STATE_PARAM, STATE_ROLE, STEPS_COMPLETE_ATTR, STRUCTURAL_ROLE, STYLE_CLASS_ATTR, STYLE_GROUP_ATTR, STYLE_SHEET_NAME, STYLE_USAGE_ATTR, STYLED_ITEM_NAME, STYLED_LIST_NAME, STYLED_TEXT_NAME, SUB_TAB_BAR_NAME, SUB_TAB_LAYOUT_NAME, SUB_TABS_CHILD, SUB_TRAIN_ATTR, SUBMIT_BUTTON_NAME, SUBMIT_PREPARE_ATTR, SUMMARY_ATTR, SWITCH_APP_EVENT, SWITCH_APP_TYPE_BACK, SWITCH_APP_TYPE_GOTO, SWITCH_MODE_HYPERLINK_ATTR, SWITCHER_NAME, TAB_BAR_NAME, TABLE_ACTIONS_CHILD, TABLE_BANDING_KEY, TABLE_DATA_ATTR, TABLE_FILTER_CHILD, TABLE_FOOTER_NAME, 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_MODE, TEXT_MODE_DISPLAY_HEIGHT_ATTR, TEXT_MODE_DISPLAY_LENGTH_ATTR, TEXT_NAME, THREADED_ATTR, THREADED_LAYOUT_NAME, TIME_INTERVAL_ATTR, TIP_ATTR, TIP_NAME, TITLE_ATTR, TOK_PARAM, TOP_CHILD, TOTAL_CHILD, TOTAL_ROW_NAME, TRAILING_CHILD, TRAILING_DESC_SHOWN_ATTR, TRAILING_FOOTER_CHILD, TRAILING_HEADER_ATTR, TRAIN_NAME, TREE_DATA_ATTR, TREE_NAME, TRUNCATE_AT_ATTR, TRUNCATE_NAME, TRY_NAME, TYPE_ATTR, TYPE_PARAM, TYPE_POST, TYPE_PRE, TYPE_TEXT_ATTR, TZ_OFFSET_PARAM, UNDISCLOSED_TEXT_ATTR, UNKNOWN_ROLE, UNVALIDATED_ATTR, UPDATE_EVENT, URI_PARAM, URL_INCLUDE_NAME, USE_SEPARATE_ROWS_ATTR, 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, YEAR_PARAM |
Constructor Summary |
MessageData()
Creates an empty MessageData. |
Method Summary |
void |
addError(java.lang.Object select, java.lang.String message, java.lang.String longDescURL)
Adds an error message. |
void |
addError(java.lang.Object select, java.lang.String message, java.lang.String longDescURL, java.lang.String messageLinkText, java.lang.String messageDescription)
Adds an error message. |
void |
addInfo(java.lang.Object select, java.lang.String message, java.lang.String longDescURL)
Adds an informational message. |
void |
addInfo(java.lang.Object select, java.lang.String message, java.lang.String longDescURL, java.lang.String messageLinkText, java.lang.String messageDescription)
Adds an informational message. |
void |
addMessage(java.lang.Object select, java.lang.String message, java.lang.String longDescURL, java.lang.String messageType)
Adds a message. |
void |
addMessage(java.lang.Object select, java.lang.String message, java.lang.String longDescURL, java.lang.String messageType, java.lang.String messageLinkText, java.lang.String messageDescription)
Adds a message. |
void |
addToRenderingContext(RenderingContext context)
Attaches a MessageData object to a RenderingContext . |
void |
addWarning(java.lang.Object select, java.lang.String message, java.lang.String longDescURL)
Adds a warning message. |
void |
addWarning(java.lang.Object select, java.lang.String message, java.lang.String longDescURL, java.lang.String messageLinkText, java.lang.String messageDescription)
Adds a warning message. |
static void |
bindNode(MutableUINode node, BoundValue boundValue)
Binds a bean's (usually, a InlineMessageBean) message-related attributes to a piece of a MessageData. |
static void |
bindNode(MutableUINode node, java.lang.Object select)
Binds a bean's (usually, a InlineMessageBean) message-related attributes to a piece of a MessageData. |
static void |
bindNode(MutableUINode node, java.lang.Object select, java.lang.String namespaceURI, java.lang.String name)
Binds a bean's (usually, a InlineMessageBean) message-related attributes to a piece of a MessageData. |
static void |
bindNodes(MutableUINode promptNode, MutableUINode textNode, BoundValue boundValue)
Binds a pair of beans' (usually, a MessagePromptBean and a MessageTextBean) message-related attributes to a piece of a MessageData. |
static void |
bindNodes(MutableUINode promptNode, MutableUINode textNode, java.lang.Object select)
Binds a pair of beans' (usually, a MessagePromptBean and a MessageTextBean) message-related attributes to a piece of a MessageData. |
static void |
bindNodes(MutableUINode promptNode, MutableUINode textNode, java.lang.Object select, java.lang.String namespaceURI, java.lang.String name)
Binds a pair of beans' (usually, a MessagePromptBean and a MessageTextBean) message-related attributes to a piece of a MessageData. |
static void |
bindRowNode(MutableUINode node, java.lang.Object rowKey)
Binds the message-related attributes of a bean used as a row in a table to a piece of MessageData. |
static void |
bindRowNodes(MutableUINode promptNode, MutableUINode textNode, java.lang.Object rowKey)
Binds the message-related attributes of a pair of beans used in a row of a table. |
DataObject |
getItem(int index)
Returns the message at the index. |
int |
getLength()
Returns the number of contained messages. |
java.lang.String |
getMessage()
Sets the main message for the entire box. |
java.lang.String |
getMessageType()
Returns the current message type of the MessageData. |
java.lang.Object |
selectValue(RenderingContext context, java.lang.Object select)
Returns the value registered with the select key. |
void |
setMessage(java.lang.String message)
Sets the main message for the entire box. |
void |
setMessageType(java.lang.String messageType)
Sets the current message type of the MessageData. |
DataProvider |
toDataProvider()
Converts the MessageData into a DataProvider. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
MESSAGE_DATA_OBJECT_NAME
public static final java.lang.String MESSAGE_DATA_OBJECT_NAME
- Default name under which MessageData DataObjects may be registered. There is no requirement to use this name; only the two-arg
bindNode()
and addRenderingContext()
methods use this value.
MESSAGE_DATA_COUNT_SELECT
public static final java.lang.String MESSAGE_DATA_COUNT_SELECT
- Deprecated. since 2.0; call getLength() on the DataObjectList returned by MESSAGE_DATA_MESSAGES_SELECT instead
- A key value which can be passed to
selectValue()
to return an Integer representing the number of messages currently registered in a MessageData.
MESSAGE_DATA_MESSAGES_SELECT
public static final java.lang.String MESSAGE_DATA_MESSAGES_SELECT
- A key value which can be passed to
selectValue()
to return a DataObjectList with each DataObject representing the message data for one of the registered messages.
MESSAGE_DATA_TYPE_SELECT
public static final java.lang.String MESSAGE_DATA_TYPE_SELECT
- A key value which can be passed to
selectValue()
to return one of the UIConstants (e.g. MESSAGE_TYPE_ERROR, MESSAGE_TYPE_INFO, etc.) indicating which type of message is registered in this MessageData, or null if none is registered. In the case of multiple types, "error" takes highest precedence, followed by "warning", "info".
MESSAGE_DATA_MESSAGE
public static final java.lang.String MESSAGE_DATA_MESSAGE
- A key value which can be passed to
selectValue()
to return the summary text for the entire set of messages.
MessageData
public MessageData()
- Creates an empty MessageData.
bindNode
public static void bindNode(MutableUINode node,
java.lang.Object select)
- Binds a bean's (usually, a InlineMessageBean) message-related attributes to a piece of a MessageData. The message data will be retrieved from the UIX Components namespace, and the
MESSAGE_DATA_OBJECT_NAME
name.
-
- Parameters:
node
- the node (generally, a InlineMessageBean)
select
- the select key that will be used to retrieve the message information
bindNode
public static void bindNode(MutableUINode node,
java.lang.Object select,
java.lang.String namespaceURI,
java.lang.String name)
- Binds a bean's (usually, a InlineMessageBean) message-related attributes to a piece of a MessageData. The message data will be retrieved from the UIX Components namespace, and the
MESSAGE_DATA_OBJECT_NAME
name.
-
- Parameters:
node
- the node (generally, a InlineMessageBean)
select
- the select key that will be used to retrieve the message information
namespaceURI
- the namespace to retrieve the message DataObject from
name
- the name of the message DataObject
bindNode
public static void bindNode(MutableUINode node,
BoundValue boundValue)
- Binds a bean's (usually, a InlineMessageBean) message-related attributes to a piece of a MessageData. The message DataObject will be retrieved from the given BoundValue
-
- Parameters:
node
- the node (generally, a InlineMessageBean)
boundValue
- a BoundValue that will return the DataObject containing messages for this node
bindNodes
public static void bindNodes(MutableUINode promptNode,
MutableUINode textNode,
java.lang.Object select)
- Binds a pair of beans' (usually, a MessagePromptBean and a MessageTextBean) message-related attributes to a piece of a MessageData. The message data will be retrieved from the UIX Components namespace, and the
MESSAGE_DATA_OBJECT_NAME
name.
-
- Parameters:
promptNode
- the message prompt (usually a MessagePromptBean)
textNode
- the message text (usually a MessageTextBean)
select
- the select key that will be used to retrieve the message information
bindNodes
public static void bindNodes(MutableUINode promptNode,
MutableUINode textNode,
java.lang.Object select,
java.lang.String namespaceURI,
java.lang.String name)
- Binds a pair of beans' (usually, a MessagePromptBean and a MessageTextBean) message-related attributes to a piece of a MessageData. The message data will be retrieved from the UIX Components namespace, and the
MESSAGE_DATA_OBJECT_NAME
name.
-
- Parameters:
promptNode
- the message prompt (usually a MessagePromptBean)
textNode
- the message text (usually a MessageTextBean)
select
- the select key that will be used to retrieve the message information
namespaceURI
- the namespace to retrieve the message DataObject from
name
- the name of the message DataObject
bindNodes
public static void bindNodes(MutableUINode promptNode,
MutableUINode textNode,
BoundValue boundValue)
- Binds a pair of beans' (usually, a MessagePromptBean and a MessageTextBean) message-related attributes to a piece of a MessageData. The message DataObject will be retrieved from the given BoundValue
-
- Parameters:
promptNode
- the message prompt (usually a MessagePromptBean)
textNode
- the message text (usually a MessageTextBean)
boundValue
- a BoundValue that will return the DataObject containing messages for this node
bindRowNode
public static void bindRowNode(MutableUINode node,
java.lang.Object rowKey)
- Binds the message-related attributes of a bean used as a row in a table to a piece of MessageData.
The message DataObject will be retrieved from the default location (the UIX Components namespace, and named MESSAGE_DATA_OBJECT_NAME
). The key passed in will not be used directly, but will instead be used to get the "real" key from the current DataObject.
For variations on this behavior (like looking for the message DataObject at another location), clients can use the RowMessageBoundValue class.
-
- Parameters:
node
- the node (generally, a InlineMessageBean)
rowKey
- the key that will be used to retrieve the "real" message key.
- See Also:
RowMessageBoundValue
bindRowNodes
public static void bindRowNodes(MutableUINode promptNode,
MutableUINode textNode,
java.lang.Object rowKey)
- Binds the message-related attributes of a pair of beans used in a row of a table.
The message DataObject will be retrieved from the default location (the UIX Components namespace, and named MESSAGE_DATA_OBJECT_NAME
). The key passed in will not be used directly, but will instead be used to get the "real" key from the current DataObject.
For variations on this behavior (like looking for the message DataObject at another location), clients can use the RowMessageBoundValue class.
-
- Parameters:
promptNode
- the message prompt (usually a MessagePromptBean)
textNode
- the message text (usually a MessageTextBean)
rowKey
- the key that will be used to retrieve the "real" message key.
- See Also:
RowMessageBoundValue
setMessage
public void setMessage(java.lang.String message)
- Sets the main message for the entire box.
getMessage
public java.lang.String getMessage()
- Sets the main message for the entire box.
toDataProvider
public DataProvider toDataProvider()
- Converts the MessageData into a DataProvider. The data provider will serve up the MessageData on the default namespace and local name.
addToRenderingContext
public void addToRenderingContext(RenderingContext context)
- Attaches a
MessageData
object to a RenderingContext
. The message DataObject will be registered in the UIX Components namespace, and at the MESSAGE_DATA_OBJECT_NAME
name.
-
- Parameters:
context
- a RenderingContext
addError
public final void addError(java.lang.Object select,
java.lang.String message,
java.lang.String longDescURL)
- Adds an error message.
-
- Parameters:
select
- the key that will be used to serve the error message
message
- the text of the message
longDescURL
- an optional link to a location with more information
addError
public final void addError(java.lang.Object select,
java.lang.String message,
java.lang.String longDescURL,
java.lang.String messageLinkText,
java.lang.String messageDescription)
- Adds an error message. Supply additional properties for a MessageBoxBean.
-
- Parameters:
select
- the key that will be used to serve the error message. Maybe null for page-level errors.
message
- the text of the message. Maybe null for page-level messages.
longDescURL
- an optional link to a location with more information
messageLinkText
- optional text to display as the item's link text in a MessageBoxBean
messageDescription
- optional text to display as the item's description in a MessageBoxBean
addWarning
public final void addWarning(java.lang.Object select,
java.lang.String message,
java.lang.String longDescURL)
- Adds a warning message.
-
- Parameters:
select
- the key that will be used to serve the warning message
message
- the text of the message
longDescURL
- an optional link to a location with more information
addWarning
public final void addWarning(java.lang.Object select,
java.lang.String message,
java.lang.String longDescURL,
java.lang.String messageLinkText,
java.lang.String messageDescription)
- Adds a warning message. Supply additional properties for a MessageBoxBean.
-
- Parameters:
select
- the key that will be used to serve the warning message. Maybe null for page-level messages.
message
- the text of the message. Maybe null for page-level messages.
longDescURL
- an optional link to a location with more information
messageLinkText
- optional text to display as the item's link text in a MessageBoxBean
messageDescription
- optional text to display as the item's description in a MessageBoxBean
addInfo
public final void addInfo(java.lang.Object select,
java.lang.String message,
java.lang.String longDescURL)
- Adds an informational message.
-
- Parameters:
select
- the key that will be used to serve the informational message
message
- the text of the message.
longDescURL
- an optional link to a location with more information
addInfo
public final void addInfo(java.lang.Object select,
java.lang.String message,
java.lang.String longDescURL,
java.lang.String messageLinkText,
java.lang.String messageDescription)
- Adds an informational message. Supply additional properties for a MessageBoxBean.
-
- Parameters:
select
- the key that will be used to serve the informational message. Maybe null for page-level messages.
message
- the text of the message. Maybe null for page-level messages.
longDescURL
- an optional link to a location with more information
messageLinkText
- optional text to display as the item's link text in a MessageBoxBean
messageDescription
- optional text to display as the item's description in a MessageBoxBean
addMessage
public final void addMessage(java.lang.Object select,
java.lang.String message,
java.lang.String longDescURL,
java.lang.String messageType)
- Adds a message.
-
- Parameters:
select
- the key that will be used to serve the informational message.
message
- the text of the message.
longDescURL
- an optional link to a location with more information
messageType
- the type of the message; one of "error", "warning", or "info"
addMessage
public void addMessage(java.lang.Object select,
java.lang.String message,
java.lang.String longDescURL,
java.lang.String messageType,
java.lang.String messageLinkText,
java.lang.String messageDescription)
- Adds a message. Supply additional properties for a MessageBoxBean.
-
- Parameters:
select
- the key that will be used to serve the informational message. Maybe null for page-level messages.
message
- the text of the message. Maybe null for page-level messages.
longDescURL
- an optional link to a location with more information. maybe null
messageType
- the type of the message; one of "error", "warning", or "info"
messageLinkText
- optional text to display as the item's link text in a MessageBoxBean.
messageDescription
- optional text to display as the item's description in a MessageBoxBean
getMessageType
public java.lang.String getMessageType()
- Returns the current message type of the MessageData.
setMessageType
public void setMessageType(java.lang.String messageType)
- Sets the current message type of the MessageData. Note that calls that try set the message type to a less severe type of message than the currently set message type will be ignored; severity can only be ratcheted upwards.
-
- Parameters:
messageType
- one of MESSAGE_TYPE_ERROR, MESSAGE_TYPE_WARNING, or MESSAGE_TYPE_INFO
selectValue
public java.lang.Object selectValue(RenderingContext context,
java.lang.Object select)
- Returns the value registered with the select key.
-
- Overrides:
selectValue
in class DictionaryData
- Following copied from interface:
oracle.cabo.ui.data.DataObject
-
- Parameters:
context
- the current rendering context
select
- a select criterion, syntax as defined by the data object
getLength
public int getLength()
- Returns the number of contained messages.
-
- Specified by:
getLength
in interface DataObjectList
getItem
public DataObject getItem(int index)
- Returns the message at the index.
-
- Specified by:
getItem
in interface DataObjectList