Skip navigation links

oracle.adf.view.rich.component.rich.output
Class RichMedia

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXObject
oracle.adf.view.rich.component.rich.output.RichMedia

All Implemented Interfaces:

javax.faces.component.StateHolder

public class RichMedia

extends org.apache.myfaces.trinidad.component.UIXObject

The media component displays media content, such as audio, video, or image in a player embedded in the user agent. 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.

Media Player Selection

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.

Player Sizing

The media component 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.

Behavior Of The Link Player

If the player type is "link" or the media component falls back on the link-player,then the behavior upon clicking the link depends upon the MIME type sent by the web server, for that particular media type. This is usually configured in the web.xml deployment descriptor or in the web server wide configuration file.Please see the servlet spec for more details.

             Example:
             <mime-mapping>
               <extension>wmv</extension>
               <mime-type>video/x-ms-wmv</mime-type>
             </mime-mapping> 
           

Events:

Type	Phases	Description
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	AUTOSTART_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_ATTRIBUTES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_COMPONENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_TYPE_KEY
static java.lang.String	CONTROLS_ALL
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTROLS_KEY
static java.lang.String	CONTROLS_MINIMAL
static java.lang.String	CONTROLS_NONE
static java.lang.String	CONTROLS_NONE_VISIBLE
static java.lang.String	CONTROLS_TYPICAL
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	HEIGHT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INNER_HEIGHT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INNER_WIDTH_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PLAY_COUNT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PLAYER_KEY
static java.lang.String	PLAYER_LINK
static java.lang.String	PLAYER_QUICKTIME
static java.lang.String	PLAYER_REAL
static java.lang.String	PLAYER_WINDOWS
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SOURCE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STANDBY_TEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	UNSECURE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	WIDTH_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

	RichMedia() Construct an instance of the RichMedia.
protected	RichMedia(java.lang.String rendererType) Construct an instance of the RichMedia.

Method Summary

protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.util.Set	getClientAttributes() Gets a set of client attribute names.
ClientListenerSet	getClientListeners() Gets a set of client listeners.
java.lang.String	getContentType() Gets the MIME type of the media content returned by the "source" URI.
java.lang.String	getControls() Gets the set of controls made available to the user for controlling the media playback.
java.lang.String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
java.lang.String	getFamily()
java.lang.String	getHeight() Gets the height in pixels to reserve for the media player plus its content.
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
int	getInnerHeight() Gets the height in pixels to reserve for the media player content.
int	getInnerWidth() Gets the width in pixels to reserve for the media player content.
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
int	getPlayCount() 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.
java.lang.String	getShortDesc() Gets the short description of the component.
java.lang.String	getSource() Gets the URI specifying the location of the media resource.
java.lang.String	getStandbyText() Gets the message to display in the media player while the media resource is loading.
java.lang.String	getStyleClass() Gets a CSS style class to use for this component.
java.util.Set<java.lang.String>	getUnsecure() Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
java.lang.String	getWidth() Gets the 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.
boolean	isClientComponent() Gets whether a client-side component will be generated.
boolean	isVisible() Gets the visibility of the component.
void	setAutostart(boolean autostart) Sets a boolean value that controls whether the media resource loads and plays automatically without user initiation.
void	setClientAttributes(java.util.Set clientAttributes) Sets a set of client attribute names.
void	setClientComponent(boolean clientComponent) Sets whether a client-side component will be generated.
void	setClientListeners(ClientListenerSet clientListeners) Sets a set of client listeners.
void	setContentType(java.lang.String contentType) Sets the MIME type of the media content returned by the "source" URI.
void	setControls(java.lang.String controls) Sets the set of controls made available to the user for controlling the media playback.
void	setCustomizationId(java.lang.String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setHeight(int height) Sets the height in pixels to reserve for the media player plus its content.
void	setHeight(java.lang.String height) Sets the height in pixels to reserve for the media player plus its content.
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setInnerHeight(int innerHeight) Sets the height in pixels to reserve for the media player content.
void	setInnerWidth(int innerWidth) Sets the width in pixels to reserve for the media player content.
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setPlayCount(int playCount) Sets the number of times the media resource will play.
void	setPlayer(java.lang.String player) Sets which media player to use to play the media resource.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the component.
void	setSource(java.lang.String source) Sets the URI specifying the location of the media resource.
void	setStandbyText(java.lang.String standbyText) Sets the message to display in the media player while the media resource is loading.
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.
void	setUnsecure(java.util.Set<java.lang.String> unsecure) Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
void	setVisible(boolean visible) Sets the visibility of the component.
void	setWidth(int width) Sets the width in pixels to reserve for the media player plus its content.
void	setWidth(java.lang.String width) Sets the width in pixels to reserve for the media player plus its content.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

getContainerClientId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PLAYER_WINDOWS

public static final java.lang.String PLAYER_WINDOWS

See Also:

Constant Field Values

PLAYER_QUICKTIME

public static final java.lang.String PLAYER_QUICKTIME

See Also:

Constant Field Values

PLAYER_LINK

public static final java.lang.String PLAYER_LINK

See Also:

Constant Field Values

PLAYER_REAL

public static final java.lang.String PLAYER_REAL

See Also:

Constant Field Values

CONTROLS_NONE_VISIBLE

public static final java.lang.String CONTROLS_NONE_VISIBLE

See Also:

Constant Field Values

CONTROLS_NONE

public static final java.lang.String CONTROLS_NONE

See Also:

Constant Field Values

CONTROLS_TYPICAL

public static final java.lang.String CONTROLS_TYPICAL

See Also:

Constant Field Values

CONTROLS_ALL

public static final java.lang.String CONTROLS_ALL

See Also:

Constant Field Values

CONTROLS_MINIMAL

public static final java.lang.String CONTROLS_MINIMAL

See Also:

Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

WIDTH_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey WIDTH_KEY

HEIGHT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HEIGHT_KEY

INNER_WIDTH_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INNER_WIDTH_KEY

INNER_HEIGHT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INNER_HEIGHT_KEY

SOURCE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SOURCE_KEY

AUTOSTART_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey AUTOSTART_KEY

PLAY_COUNT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PLAY_COUNT_KEY

CONTENT_TYPE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_TYPE_KEY

STANDBY_TEXT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STANDBY_TEXT_KEY

PLAYER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PLAYER_KEY

CONTROLS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTROLS_KEY

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

UNSECURE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

Deprecated.

CLIENT_COMPONENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

RichMedia

public RichMedia()

Construct an instance of the RichMedia.

RichMedia

protected RichMedia(java.lang.String rendererType)

Construct an instance of the RichMedia.

Method Detail

getWidth

public final java.lang.String getWidth()

Gets the 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.

Returns:

the new width value

setWidth

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

Sets the 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.

Parameters:

width - the new width value

setWidth

public final void setWidth(int width)

Sets the 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.

Parameters:

width - the new width value

getHeight

public final java.lang.String getHeight()

Gets the 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.

Returns:

the new height value

setHeight

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

Sets the 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.

Parameters:

height - the new height value

setHeight

public final void setHeight(int height)

Sets the 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.

Parameters:

height - the new height value

getInnerWidth

public final int getInnerWidth()

Gets the 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.

Returns:

the new innerWidth value

setInnerWidth

public final void setInnerWidth(int innerWidth)

Sets the 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.

Parameters:

innerWidth - the new innerWidth value

getInnerHeight

public final int getInnerHeight()

Gets the 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.

Returns:

the new innerHeight value

setInnerHeight

public final void setInnerHeight(int innerHeight)

Sets the 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.

Parameters:

innerHeight - the new innerHeight value

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.

Returns:

the new source value

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.

Parameters:

source - the new source value

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.

Returns:

the new autostart value

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.

Parameters:

autostart - the new autostart value

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.

Returns:

the new playCount value

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.

Parameters:

playCount - the new playCount value

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.

Returns:

the new contentType value

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.

Parameters:

contentType - the new contentType value

getStandbyText

public final java.lang.String getStandbyText()

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

Returns:

the new standbyText value

setStandbyText

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

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

Parameters:

standbyText - the new standbyText value

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.

• "none"

  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.

• "quicktime"

  use the Apple QuickTime player.

• "windows"

  use the Windows Media Player.

• "real"

  use the Real Player.

Returns:

the new player value

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.

• "none"

  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.

• "quicktime"

  use the Apple QuickTime player.

• "windows"

  use the Windows Media Player.

• "real"

  use the Real Player.

Parameters:

player - the new player value

getControls

public final java.lang.String getControls()

Gets the set of controls 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" and "innerHeight".

• "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.

• "noneVisible"

  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.

• "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.

• "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.

• "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".

Returns:

the new controls value

setControls

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

Sets the set of controls 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" and "innerHeight".

• "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.

• "noneVisible"

  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.

• "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.

• "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.

• "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".

Parameters:

controls - the new controls value

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()

Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Parameters:

styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final java.util.Set<java.lang.String> getUnsecure()

Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.

Returns:

the new unsecure value

setUnsecure

public final void setUnsecure(java.util.Set<java.lang.String> unsecure)

Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.

Parameters:

unsecure - the new unsecure value

isVisible

public final boolean isVisible()

Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Returns:

the new visible value

setVisible

public final void setVisible(boolean visible)

Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Parameters:

visible - the new visible value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()

Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Returns:

the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)

Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Parameters:

clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Parameters:

partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class org.apache.myfaces.trinidad.component.UIXObject

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXObject

Skip navigation links