oracle.cabo.ui.beans
Class MediaBean

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

All Implemented Interfaces:

MutableUINode, UIConstants, UINode

Direct Known Subclasses:

MediaBean

public class MediaBean

extends MarlinBean

The media control displays the media specified by the "source" attribute in the appropriate media player. If a particular media player is desired, it can be specified using the "player" attribute. The media control attempts to intelligently handle two tricky aspects of cross-platform media display--determining the best player to display the media, and sizing the media player.

The media control attempts to pick the appropriate media player using the following steps:

1. If the primary MIME type of the content is "image", the built in user-agent support will be used.
2. If a media player has been specified by the "player" attribute and that player is available on the user agent and can display the media resource, that player will be used.
3. If one player is especially good at playing the media resource and that player is available on the user agent, that player will be used.
4. If one player is especially dominant on the user agent and that player can play the media resource, that player will be used.
5. the "link" player will be used.

The media control supports two approaches to sizing the media control setting the "width" and "height" attributes, which specify the amount of space reserved on the user agent for the media control, and setting the "innerWidth" and "innerHeight" attributes, which specify the size of the media resource content. Since it is almost impossible to determine the correct width and height to use across different players and different player control configurations, specifying the "innerWidth" and "innerHeight" is the recommended strategy.

If the size of the media control isn't specified by one of the above approaches, a default inner size, determined by the content type of the media resource, will be used. This works well for audio content, but can cause content to be clipped or occupy too much space for video content.

Example:

This sample builds a media control, for playing a house music Windows Media file. The typical set of controls is displayed, and the control is sized just large enough to display the controls, since the default inner size of audio files is 0 by 0 pixels.

    <media source="house.wma" />

Example:

This sample builds on the above example but adds a short description and stand by text. Only the minimal media player controls are dsiplayed.

    <media source="house.wma" controls="minimal" shortDesc="Bad House Music" standyText="I wish I wasn't loading this..."/>

Example:

This sample displays a Windows Media video file, specifying the inner size of the media control to be the size of the video clip. The video will start immediately and a full set of controls are available to the user.

    <media source="seattle.wmv" innerWidth="160" innerHeight="112" autostart="true" controls="all" />

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

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

Method Summary

java.lang.String	getContentType() Gets the MIME type of the media content returned by the "source" URI.
static java.lang.String	getContentType(MutableUINode bean) Gets the MIME type of the media content returned by the "source" URI.
java.lang.String	getControls() Gets the set of controls to made available to the user for controlling the media playback.
static java.lang.String	getControls(MutableUINode bean) Gets the set of controls to made available to the user for controlling the media playback.
java.lang.String	getHeight() Gets height in pixels to reserve for the media player plus its content.
static java.lang.String	getHeight(MutableUINode bean) Gets height in pixels to reserve for the media player plus its content.
int	getInnerHeight() Gets height in pixels to reserve for the media player content.
static int	getInnerHeight(MutableUINode bean) Gets height in pixels to reserve for the media player content.
int	getInnerWidth() Gets width in pixels to reserve for the media player content.
static int	getInnerWidth(MutableUINode bean) Gets width in pixels to reserve for the media player content.
int	getPlayCount() Gets the number of times the media resource will play.
static int	getPlayCount(MutableUINode bean) Gets the number of times the media resource will play.
java.lang.String	getPlayer() Gets which media player to use to play the media resource.
static java.lang.String	getPlayer(MutableUINode bean) Gets which media player to use to play the media resource.
java.lang.String	getSource() Gets the URI specifying the location of the media resource.
static java.lang.String	getSource(MutableUINode bean) Gets the URI specifying the location of the media resource.
java.lang.String	getStandbyText() Gets Message to display in the media player while the media resource is loading.
static java.lang.String	getStandbyText(MutableUINode bean) Gets Message to display in the media player while the media resource is loading.
java.lang.String	getWidth() Gets width in pixels to reserve for the media player plus its content.
static java.lang.String	getWidth(MutableUINode bean) Gets width in pixels to reserve for the media player plus its content.
boolean	isAutostart() Gets a boolean value that controls whether the media resource loads and plays automatically without user initiation.
static boolean	isAutostart(MutableUINode bean) Gets a boolean value that controls whether the media resource loads and plays automatically without user initiation.
void	setAutostart(boolean autostart) Sets a boolean value that controls whether the media resource loads and plays automatically without user initiation.
static void	setAutostart(MutableUINode bean, boolean autostart) Sets a boolean value that controls whether the media resource loads and plays automatically without user initiation.
static void	setContentType(MutableUINode bean, java.lang.String contentType) Sets the MIME type of the media content returned by the "source" URI.
void	setContentType(java.lang.String contentType) Sets the MIME type of the media content returned by the "source" URI.
static void	setControls(MutableUINode bean, java.lang.String controls) Sets the set of controls to made available to the user for controlling the media playback.
void	setControls(java.lang.String controls) Sets the set of controls to made available to the user for controlling the media playback.
void	setHeight(int height) Sets height in pixels to reserve for the media player plus its content.
static void	setHeight(MutableUINode bean, int height) Sets height in pixels to reserve for the media player plus its content.
static void	setHeight(MutableUINode bean, java.lang.String height) Sets height in pixels to reserve for the media player plus its content.
void	setHeight(java.lang.String height) Sets height in pixels to reserve for the media player plus its content.
void	setInnerHeight(int innerHeight) Sets height in pixels to reserve for the media player content.
static void	setInnerHeight(MutableUINode bean, int innerHeight) Sets height in pixels to reserve for the media player content.
void	setInnerWidth(int innerWidth) Sets width in pixels to reserve for the media player content.
static void	setInnerWidth(MutableUINode bean, int innerWidth) Sets width in pixels to reserve for the media player content.
void	setPlayCount(int playCount) Sets the number of times the media resource will play.
static void	setPlayCount(MutableUINode bean, int playCount) Sets the number of times the media resource will play.
static void	setPlayer(MutableUINode bean, java.lang.String player) Sets which media player to use to play the media resource.
void	setPlayer(java.lang.String player) Sets which media player to use to play the media resource.
static void	setSource(MutableUINode bean, java.lang.String source) Sets the URI specifying the location of the media resource.
void	setSource(java.lang.String source) Sets the URI specifying the location of the media resource.
void	setSourceBinding(BoundValue boundValue) Binds the the URI specifying the location of the media resource.
static void	setSourceBinding(MutableUINode bean, BoundValue boundValue) Binds the the URI specifying the location of the media resource.
static void	setSourceBinding(MutableUINode bean, java.lang.Object selectKey) Binds the the URI specifying the location of the media resource.
static void	setSourceBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the the URI specifying the location of the media resource.
void	setSourceBinding(java.lang.Object selectKey) Binds the the URI specifying the location of the media resource.
void	setSourceBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the the URI specifying the location of the media resource.
static void	setStandbyText(MutableUINode bean, java.lang.String standbyText) Sets Message to display in the media player while the media resource is loading.
void	setStandbyText(java.lang.String standbyText) Sets Message to display in the media player while the media resource is loading.
void	setWidth(int width) Sets width in pixels to reserve for the media player plus its content.
static void	setWidth(MutableUINode bean, int width) Sets width in pixels to reserve for the media player plus its content.
static void	setWidth(MutableUINode bean, java.lang.String width) Sets width in pixels to reserve for the media player plus its content.
void	setWidth(java.lang.String width) Sets width in pixels to reserve for the media player plus its content.

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

MediaBean

public MediaBean()

Construct an instance of the MediaBean.

MediaBean

public MediaBean(java.lang.String source)

Construct an instance of the MediaBean.

Parameters:

source - the URI specifying the location of the media resource.

MediaBean

public MediaBean(java.lang.String source,
                 java.lang.String shortDesc)

Construct an instance of the MediaBean.

Parameters:

source - the URI specifying the location of the media resource.

shortDesc - the short description of the bean.

MediaBean

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

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

Method Detail

getWidth

public final java.lang.String getWidth()

Gets width in pixels to reserve for the media player plus its content. As the extra width needed for the media player controls can vary from media player to media player and depend on the controls displayed in the media player, it is recommended that the "innerWidth" attribute be used in preference to this attribute.

If both the "width" and "innerWidth" attributes are specified, the "width" attribute will be used.

If no width is specified, the width of the media control is determined by calculating the "innerWidth" and adding any extra width necessary to display the media player controls.

setWidth

public final void setWidth(java.lang.String width)

Sets width in pixels to reserve for the media player plus its content. As the extra width needed for the media player controls can vary from media player to media player and depend on the controls displayed in the media player, it is recommended that the "innerWidth" attribute be used in preference to this attribute.

If both the "width" and "innerWidth" attributes are specified, the "width" attribute will be used.

If no width is specified, the width of the media control is determined by calculating the "innerWidth" and adding any extra width necessary to display the media player controls.

setWidth

public final void setWidth(int width)

Sets width in pixels to reserve for the media player plus its content. As the extra width needed for the media player controls can vary from media player to media player and depend on the controls displayed in the media player, it is recommended that the "innerWidth" attribute be used in preference to this attribute.

If both the "width" and "innerWidth" attributes are specified, the "width" attribute will be used.

If no width is specified, the width of the media control is determined by calculating the "innerWidth" and adding any extra width necessary to display the media player controls.

getHeight

public final java.lang.String getHeight()

Gets height in pixels to reserve for the media player plus its content. As the extra height needed for the media player controls can vary from media player to media player and depend on the controls displayed in the media player, it is recommended that the "innerHeight" attribute be used in preference to this attribute.

If both the "height" and "innerHeight" attributes are specified, the "height" attribute will be used.

If no height is specified, the height of the media control is determined by calculating the "innerHeight" and adding any extra height necessary to display the media player controls.

setHeight

public final void setHeight(java.lang.String height)

Sets height in pixels to reserve for the media player plus its content. As the extra height needed for the media player controls can vary from media player to media player and depend on the controls displayed in the media player, it is recommended that the "innerHeight" attribute be used in preference to this attribute.

If both the "height" and "innerHeight" attributes are specified, the "height" attribute will be used.

If no height is specified, the height of the media control is determined by calculating the "innerHeight" and adding any extra height necessary to display the media player controls.

setHeight

public final void setHeight(int height)

Sets height in pixels to reserve for the media player plus its content. As the extra height needed for the media player controls can vary from media player to media player and depend on the controls displayed in the media player, it is recommended that the "innerHeight" attribute be used in preference to this attribute.

If both the "height" and "innerHeight" attributes are specified, the "height" attribute will be used.

If no height is specified, the height of the media control is determined by calculating the "innerHeight" and adding any extra height necessary to display the media player controls.

getInnerWidth

public final int getInnerWidth()

Gets width in pixels to reserve for the media player content. This will typically be set to the pixel width of the media resource to display.

If no "innerWidth" is specified, the "innerWidth" will be defaulted based on the content type of the media resource to play.

If both the "width" and "innerWidth" attributes are specified, the "width" attribute will be used.

setInnerWidth

public final void setInnerWidth(int innerWidth)

Sets width in pixels to reserve for the media player content. This will typically be set to the pixel width of the media resource to display.

If no "innerWidth" is specified, the "innerWidth" will be defaulted based on the content type of the media resource to play.

If both the "width" and "innerWidth" attributes are specified, the "width" attribute will be used.

getInnerHeight

public final int getInnerHeight()

Gets height in pixels to reserve for the media player content. This will typically be set to the pixel height of the media resource to display.

If no "innerHeight" is specified, the "innerHeight" will be defaulted based on the content type of the media resource to play.

If both the "height" and "innerHeight" attributes are specified, the "height" attribute will be used.

setInnerHeight

public final void setInnerHeight(int innerHeight)

Sets height in pixels to reserve for the media player content. This will typically be set to the pixel height of the media resource to display.

If no "innerHeight" is specified, the "innerHeight" will be defaulted based on the content type of the media resource to play.

If both the "height" and "innerHeight" attributes are specified, the "height" attribute will be used.

getSource

public final java.lang.String getSource()

Gets the URI specifying the location of the media resource. If no contentType is specified, the contentType will be inferred from the extension of the source attribute.

This is a required property on the bean.

setSource

public final void setSource(java.lang.String source)

Sets the URI specifying the location of the media resource. If no contentType is specified, the contentType will be inferred from the extension of the source attribute.

This is a required property on the bean.

setSourceBinding

public final void setSourceBinding(BoundValue boundValue)

Binds the the URI specifying the location of the media resource. If no contentType is specified, the contentType will be inferred from the extension of the source attribute.

This is a required property on the bean.

Parameters:

boundValue - a BoundValue implementation to be used to retrieve the value.

setSourceBinding

public final void setSourceBinding(java.lang.Object selectKey)

Binds the the URI specifying the location of the media resource. If no contentType is specified, the contentType will be inferred from the extension of the source attribute.

This is a required property on the bean.

Parameters:

selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setSourceBinding

public final void setSourceBinding(java.lang.String dataNamespace,
                                   java.lang.String dataName,
                                   java.lang.Object selectKey)

Binds the the URI specifying the location of the media resource. If no contentType is specified, the contentType will be inferred from the extension of the source attribute.

This is a required property on the bean.

Parameters:

dataNamespace - the namespace to be passed to RenderingContext.getDataObject()

dataName - the name to be passed to RenderingContext.getDataObject()

selectKey - the key to be passed to selectValue() on the DataObject.

isAutostart

public final boolean isAutostart()

Gets a boolean value that controls whether the media resource loads and plays automatically without user initiation. When set to "true", the media resource will load and play as soon as possible.

setAutostart

public final void setAutostart(boolean autostart)

Sets a boolean value that controls whether the media resource loads and plays automatically without user initiation. When set to "true", the media resource will load and play as soon as possible.

getPlayCount

public final int getPlayCount()

Gets the number of times the media resource will play. If set to "0", the resource will loop until the user stops the playing.

setPlayCount

public final void setPlayCount(int playCount)

Sets the number of times the media resource will play. If set to "0", the resource will loop until the user stops the playing.

getContentType

public final java.lang.String getContentType()

Gets the MIME type of the media content returned by the "source" URI. This attribute is used as a hint when determining which player to pick, how the controls of the player are to be configured, and the default size of the media player. If it isn't specified, an attempt will be made to derive this information from the extension of the source URI.

setContentType

public final void setContentType(java.lang.String contentType)

Sets the MIME type of the media content returned by the "source" URI. This attribute is used as a hint when determining which player to pick, how the controls of the player are to be configured, and the default size of the media player. If it isn't specified, an attempt will be made to derive this information from the extension of the source URI.

getStandbyText

public final java.lang.String getStandbyText()

Gets Message to display in the media player while the media resource is loading.

setStandbyText

public final void setStandbyText(java.lang.String standbyText)

Sets Message to display in the media player while the media resource is loading.

getPlayer

public final java.lang.String getPlayer()

Gets which media player to use to play the media resource. If possible, the media control will accomodate this request. However, if the requested player is not available on the user agent, or does not support playing the media resource, an alternate player will be used instead. In all cases, the "link" player is used as a fallback if no other player is available, or the requested player fails for some reason.

• UIConstants.PLAYER_LINK

  use a link in the user agent page to launch the playing of the media resource.

  This player setting uses the least amount of space on the page and uses the user agent's built in content type mapping to determine how to display the media resource.

• UIConstants.PLAYER_QUICKTIME

  use the Apple QuickTime player.

• UIConstants.PLAYER_WINDOWS

  use the Windows Media Player.

• UIConstants.PLAYER_REAL

  use the Real Player.

setPlayer

public final void setPlayer(java.lang.String player)

Sets which media player to use to play the media resource. If possible, the media control will accomodate this request. However, if the requested player is not available on the user agent, or does not support playing the media resource, an alternate player will be used instead. In all cases, the "link" player is used as a fallback if no other player is available, or the requested player fails for some reason.

• UIConstants.PLAYER_LINK

  use a link in the user agent page to launch the playing of the media resource.

  This player setting uses the least amount of space on the page and uses the user agent's built in content type mapping to determine how to display the media resource.

• UIConstants.PLAYER_QUICKTIME

  use the Apple QuickTime player.

• UIConstants.PLAYER_WINDOWS

  use the Windows Media Player.

• UIConstants.PLAYER_REAL

  use the Real Player.

getControls

public final java.lang.String getControls()

Gets the set of controls to made available to the user for controlling the media playback. The actual set of controls displayed for the same value may differ between players. Likewise, the amount of space occupied by the controls will differ from media player to media player. This can cause problems if the size of the media control has been specified by the "width" and "height" attributes rather than "innerWidth" nad "innerHeight".

• UIConstants.CONTROLS_NONE

  don't show any controls for the media player and don't allow control access through alternate means, such as context menus.

  This value is typically only used in kiosk-type applications where no user control over the playing of the media is allowed. It is typically used in conjunction with setting the "autostart" attribute to "true", and the "playCount" attribute to "0" to cause the media play immediately and then loop.

• UIConstants.CONTROLS_NONE_VISIBLE

  don't show any controls for the media player but allow control access through alternate means, such as context menus.

  This value is typically only used in applications where user control over the playing of the media is allowed, but not encouraged. It is typically used in conjunction with setting the "autostart" attribute to "true", and the "playCount" attribute to "0" to cause the media to play immediately and then loop.

• UIConstants.CONTROLS_MINIMAL

  show a minimal set of controls for playing media on the media player.

  This value gives users control over the most important media playing controls, while occupying the least amount of additional space on the user agent.

• UIConstants.CONTROLS_TYPICAL

  show the typical set of controls for playing media on the media player.

  This value, the default, gives users control over the most common media playing controls, without occupying an inordinate amount of extra space on the user agent.

• UIConstants.CONTROLS_ALL

  Show all available controls for playing media on the media player

  Using this setting can cause large amount of additional space to be required, depending on the media player used.

The default of this attribute is "typical".

setControls

public final void setControls(java.lang.String controls)

Sets the set of controls to made available to the user for controlling the media playback. The actual set of controls displayed for the same value may differ between players. Likewise, the amount of space occupied by the controls will differ from media player to media player. This can cause problems if the size of the media control has been specified by the "width" and "height" attributes rather than "innerWidth" nad "innerHeight".

• UIConstants.CONTROLS_NONE

  don't show any controls for the media player and don't allow control access through alternate means, such as context menus.

  This value is typically only used in kiosk-type applications where no user control over the playing of the media is allowed. It is typically used in conjunction with setting the "autostart" attribute to "true", and the "playCount" attribute to "0" to cause the media play immediately and then loop.

• UIConstants.CONTROLS_NONE_VISIBLE

  don't show any controls for the media player but allow control access through alternate means, such as context menus.

  This value is typically only used in applications where user control over the playing of the media is allowed, but not encouraged. It is typically used in conjunction with setting the "autostart" attribute to "true", and the "playCount" attribute to "0" to cause the media to play immediately and then loop.

• UIConstants.CONTROLS_MINIMAL

  show a minimal set of controls for playing media on the media player.

  This value gives users control over the most important media playing controls, while occupying the least amount of additional space on the user agent.

• UIConstants.CONTROLS_TYPICAL

  show the typical set of controls for playing media on the media player.

  This value, the default, gives users control over the most common media playing controls, without occupying an inordinate amount of extra space on the user agent.

• UIConstants.CONTROLS_ALL

  Show all available controls for playing media on the media player

  Using this setting can cause large amount of additional space to be required, depending on the media player used.

The default of this attribute is "typical".

getWidth

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

Gets width in pixels to reserve for the media player plus its content. As the extra width needed for the media player controls can vary from media player to media player and depend on the controls displayed in the media player, it is recommended that the "innerWidth" attribute be used in preference to this attribute.

If both the "width" and "innerWidth" attributes are specified, the "width" attribute will be used.

If no width is specified, the width of the media control is determined by calculating the "innerWidth" and adding any extra width necessary to display the media player controls.

setWidth

public static void setWidth(MutableUINode bean,
                            java.lang.String width)

Sets width in pixels to reserve for the media player plus its content. As the extra width needed for the media player controls can vary from media player to media player and depend on the controls displayed in the media player, it is recommended that the "innerWidth" attribute be used in preference to this attribute.

If both the "width" and "innerWidth" attributes are specified, the "width" attribute will be used.

If no width is specified, the width of the media control is determined by calculating the "innerWidth" and adding any extra width necessary to display the media player controls.

setWidth

public static void setWidth(MutableUINode bean,
                            int width)

Sets width in pixels to reserve for the media player plus its content. As the extra width needed for the media player controls can vary from media player to media player and depend on the controls displayed in the media player, it is recommended that the "innerWidth" attribute be used in preference to this attribute.

If both the "width" and "innerWidth" attributes are specified, the "width" attribute will be used.

If no width is specified, the width of the media control is determined by calculating the "innerWidth" and adding any extra width necessary to display the media player controls.

getHeight

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

Gets height in pixels to reserve for the media player plus its content. As the extra height needed for the media player controls can vary from media player to media player and depend on the controls displayed in the media player, it is recommended that the "innerHeight" attribute be used in preference to this attribute.

If both the "height" and "innerHeight" attributes are specified, the "height" attribute will be used.

If no height is specified, the height of the media control is determined by calculating the "innerHeight" and adding any extra height necessary to display the media player controls.

setHeight

public static void setHeight(MutableUINode bean,
                             java.lang.String height)

Sets height in pixels to reserve for the media player plus its content. As the extra height needed for the media player controls can vary from media player to media player and depend on the controls displayed in the media player, it is recommended that the "innerHeight" attribute be used in preference to this attribute.

If both the "height" and "innerHeight" attributes are specified, the "height" attribute will be used.

If no height is specified, the height of the media control is determined by calculating the "innerHeight" and adding any extra height necessary to display the media player controls.

setHeight

public static void setHeight(MutableUINode bean,
                             int height)

Sets height in pixels to reserve for the media player plus its content. As the extra height needed for the media player controls can vary from media player to media player and depend on the controls displayed in the media player, it is recommended that the "innerHeight" attribute be used in preference to this attribute.

If both the "height" and "innerHeight" attributes are specified, the "height" attribute will be used.

If no height is specified, the height of the media control is determined by calculating the "innerHeight" and adding any extra height necessary to display the media player controls.

getInnerWidth

public static int getInnerWidth(MutableUINode bean)

Gets width in pixels to reserve for the media player content. This will typically be set to the pixel width of the media resource to display.

If no "innerWidth" is specified, the "innerWidth" will be defaulted based on the content type of the media resource to play.

If both the "width" and "innerWidth" attributes are specified, the "width" attribute will be used.

setInnerWidth

public static void setInnerWidth(MutableUINode bean,
                                 int innerWidth)

Sets width in pixels to reserve for the media player content. This will typically be set to the pixel width of the media resource to display.

If no "innerWidth" is specified, the "innerWidth" will be defaulted based on the content type of the media resource to play.

If both the "width" and "innerWidth" attributes are specified, the "width" attribute will be used.

getInnerHeight

public static int getInnerHeight(MutableUINode bean)

Gets height in pixels to reserve for the media player content. This will typically be set to the pixel height of the media resource to display.

If no "innerHeight" is specified, the "innerHeight" will be defaulted based on the content type of the media resource to play.

If both the "height" and "innerHeight" attributes are specified, the "height" attribute will be used.

setInnerHeight

public static void setInnerHeight(MutableUINode bean,
                                  int innerHeight)

Sets height in pixels to reserve for the media player content. This will typically be set to the pixel height of the media resource to display.

If no "innerHeight" is specified, the "innerHeight" will be defaulted based on the content type of the media resource to play.

If both the "height" and "innerHeight" attributes are specified, the "height" attribute will be used.

getSource

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

Gets the URI specifying the location of the media resource. If no contentType is specified, the contentType will be inferred from the extension of the source attribute.

This is a required property on the bean.

setSource

public static void setSource(MutableUINode bean,
                             java.lang.String source)

Sets the URI specifying the location of the media resource. If no contentType is specified, the contentType will be inferred from the extension of the source attribute.

This is a required property on the bean.

setSourceBinding

public static void setSourceBinding(MutableUINode bean,
                                    BoundValue boundValue)

Binds the the URI specifying the location of the media resource. If no contentType is specified, the contentType will be inferred from the extension of the source attribute.

This is a required property on the bean.

Parameters:

boundValue - a BoundValue implementation to be used to retrieve the value.

setSourceBinding

public static void setSourceBinding(MutableUINode bean,
                                    java.lang.Object selectKey)

Binds the the URI specifying the location of the media resource. If no contentType is specified, the contentType will be inferred from the extension of the source attribute.

This is a required property on the bean.

Parameters:

selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setSourceBinding

public static void setSourceBinding(MutableUINode bean,
                                    java.lang.String dataNamespace,
                                    java.lang.String dataName,
                                    java.lang.Object selectKey)

Binds the the URI specifying the location of the media resource. If no contentType is specified, the contentType will be inferred from the extension of the source attribute.

This is a required property on the bean.

Parameters:

dataNamespace - the namespace to be passed to RenderingContext.getDataObject()

dataName - the name to be passed to RenderingContext.getDataObject()

selectKey - the key to be passed to selectValue() on the DataObject.

isAutostart

public static boolean isAutostart(MutableUINode bean)

Gets a boolean value that controls whether the media resource loads and plays automatically without user initiation. When set to "true", the media resource will load and play as soon as possible.

setAutostart

public static void setAutostart(MutableUINode bean,
                                boolean autostart)

Sets a boolean value that controls whether the media resource loads and plays automatically without user initiation. When set to "true", the media resource will load and play as soon as possible.

getPlayCount

public static int getPlayCount(MutableUINode bean)

Gets the number of times the media resource will play. If set to "0", the resource will loop until the user stops the playing.

setPlayCount

public static void setPlayCount(MutableUINode bean,
                                int playCount)

Sets the number of times the media resource will play. If set to "0", the resource will loop until the user stops the playing.

getContentType

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

Gets the MIME type of the media content returned by the "source" URI. This attribute is used as a hint when determining which player to pick, how the controls of the player are to be configured, and the default size of the media player. If it isn't specified, an attempt will be made to derive this information from the extension of the source URI.

setContentType

public static void setContentType(MutableUINode bean,
                                  java.lang.String contentType)

Sets the MIME type of the media content returned by the "source" URI. This attribute is used as a hint when determining which player to pick, how the controls of the player are to be configured, and the default size of the media player. If it isn't specified, an attempt will be made to derive this information from the extension of the source URI.

getStandbyText

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

Gets Message to display in the media player while the media resource is loading.

setStandbyText

public static void setStandbyText(MutableUINode bean,
                                  java.lang.String standbyText)

Sets Message to display in the media player while the media resource is loading.

getPlayer

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

Gets which media player to use to play the media resource. If possible, the media control will accomodate this request. However, if the requested player is not available on the user agent, or does not support playing the media resource, an alternate player will be used instead. In all cases, the "link" player is used as a fallback if no other player is available, or the requested player fails for some reason.

• UIConstants.PLAYER_LINK

  use a link in the user agent page to launch the playing of the media resource.

  This player setting uses the least amount of space on the page and uses the user agent's built in content type mapping to determine how to display the media resource.

• UIConstants.PLAYER_QUICKTIME

  use the Apple QuickTime player.

• UIConstants.PLAYER_WINDOWS

  use the Windows Media Player.

• UIConstants.PLAYER_REAL

  use the Real Player.

setPlayer

public static void setPlayer(MutableUINode bean,
                             java.lang.String player)

Sets which media player to use to play the media resource. If possible, the media control will accomodate this request. However, if the requested player is not available on the user agent, or does not support playing the media resource, an alternate player will be used instead. In all cases, the "link" player is used as a fallback if no other player is available, or the requested player fails for some reason.

• UIConstants.PLAYER_LINK

  use a link in the user agent page to launch the playing of the media resource.

  This player setting uses the least amount of space on the page and uses the user agent's built in content type mapping to determine how to display the media resource.

• UIConstants.PLAYER_QUICKTIME

  use the Apple QuickTime player.

• UIConstants.PLAYER_WINDOWS

  use the Windows Media Player.

• UIConstants.PLAYER_REAL

  use the Real Player.

getControls

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

Gets the set of controls to made available to the user for controlling the media playback. The actual set of controls displayed for the same value may differ between players. Likewise, the amount of space occupied by the controls will differ from media player to media player. This can cause problems if the size of the media control has been specified by the "width" and "height" attributes rather than "innerWidth" nad "innerHeight".

• UIConstants.CONTROLS_NONE

  don't show any controls for the media player and don't allow control access through alternate means, such as context menus.

  This value is typically only used in kiosk-type applications where no user control over the playing of the media is allowed. It is typically used in conjunction with setting the "autostart" attribute to "true", and the "playCount" attribute to "0" to cause the media play immediately and then loop.

• UIConstants.CONTROLS_NONE_VISIBLE

  don't show any controls for the media player but allow control access through alternate means, such as context menus.

  This value is typically only used in applications where user control over the playing of the media is allowed, but not encouraged. It is typically used in conjunction with setting the "autostart" attribute to "true", and the "playCount" attribute to "0" to cause the media to play immediately and then loop.

• UIConstants.CONTROLS_MINIMAL

  show a minimal set of controls for playing media on the media player.

  This value gives users control over the most important media playing controls, while occupying the least amount of additional space on the user agent.

• UIConstants.CONTROLS_TYPICAL

  show the typical set of controls for playing media on the media player.

  This value, the default, gives users control over the most common media playing controls, without occupying an inordinate amount of extra space on the user agent.

• UIConstants.CONTROLS_ALL

  Show all available controls for playing media on the media player

  Using this setting can cause large amount of additional space to be required, depending on the media player used.

The default of this attribute is "typical".

setControls

public static void setControls(MutableUINode bean,
                               java.lang.String controls)

Sets the set of controls to made available to the user for controlling the media playback. The actual set of controls displayed for the same value may differ between players. Likewise, the amount of space occupied by the controls will differ from media player to media player. This can cause problems if the size of the media control has been specified by the "width" and "height" attributes rather than "innerWidth" nad "innerHeight".

• UIConstants.CONTROLS_NONE

  don't show any controls for the media player and don't allow control access through alternate means, such as context menus.

  This value is typically only used in kiosk-type applications where no user control over the playing of the media is allowed. It is typically used in conjunction with setting the "autostart" attribute to "true", and the "playCount" attribute to "0" to cause the media play immediately and then loop.

• UIConstants.CONTROLS_NONE_VISIBLE

  don't show any controls for the media player but allow control access through alternate means, such as context menus.

  This value is typically only used in applications where user control over the playing of the media is allowed, but not encouraged. It is typically used in conjunction with setting the "autostart" attribute to "true", and the "playCount" attribute to "0" to cause the media to play immediately and then loop.

• UIConstants.CONTROLS_MINIMAL

  show a minimal set of controls for playing media on the media player.

  This value gives users control over the most important media playing controls, while occupying the least amount of additional space on the user agent.

• UIConstants.CONTROLS_TYPICAL

  show the typical set of controls for playing media on the media player.

  This value, the default, gives users control over the most common media playing controls, without occupying an inordinate amount of extra space on the user agent.

• UIConstants.CONTROLS_ALL

  Show all available controls for playing media on the media player

  Using this setting can cause large amount of additional space to be required, depending on the media player used.

The default of this attribute is "typical".