public class RichMedia
extends org.apache.myfaces.trinidad.component.UIXObject
implements javax.faces.component.behavior.ClientBehaviorHolder
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.
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.
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><section name="Geometry_Management"> <html:ul> <html:li>This component cannot be stretched by a parent layout component.</html:li> <html:li>This component does not display any children so there are no child stretching capabilities.</html:li> </html:ul> </section>
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 event might include the width of a column that supported client-side resizing. |
Modifier and Type | Field and Description |
---|---|
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 String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CONTENT_TYPE_KEY |
static String |
CONTROLS_ALL |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CONTROLS_KEY |
static String |
CONTROLS_MINIMAL |
static String |
CONTROLS_NONE |
static String |
CONTROLS_NONE_VISIBLE |
static 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 String |
PLAYER_LINK |
static String |
PLAYER_QUICKTIME |
static String |
PLAYER_REAL |
static 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 |
Modifier | Constructor and Description |
---|---|
|
RichMedia()
Construct an instance of the RichMedia.
|
protected |
RichMedia(String rendererType)
Construct an instance of the RichMedia.
|
Modifier and Type | Method and Description |
---|---|
void |
addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior) |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
Set |
getClientAttributes()
Gets a set of client attribute names.
|
Map<String,List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors() |
ClientListenerSet |
getClientListeners()
Gets a set of client listeners.
|
String |
getContentType()
Gets the MIME type of the media content returned by the "source" URI.
|
String |
getControls()
Gets the set of controls made available to the user for controlling the media playback.
|
String |
getCustomizationId()
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
String |
getDefaultEventName() |
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getHeight()
Gets the height in pixels to reserve for the media player plus its content.
|
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.
|
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.
|
String |
getPlayer()
Gets which media player to use to play the media resource.
|
String |
getShortDesc()
Gets the short description of the component.
|
String |
getSource()
Gets the URI specifying the location of the media resource.
|
String |
getStandbyText()
Gets the message to display in the media player while the media resource is loading.
|
String |
getStyleClass()
Gets a CSS style class to use for this component.
|
Set<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.
|
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(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(String contentType)
Sets the MIME type of the media content returned by the "source" URI.
|
void |
setControls(String controls)
Sets the set of controls made available to the user for controlling the media playback.
|
void |
setCustomizationId(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(String height)
Sets the height in pixels to reserve for the media player plus its content.
|
void |
setInlineStyle(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(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(String player)
Sets which media player to use to play the media resource.
|
void |
setShortDesc(String shortDesc)
Sets the short description of the component.
|
void |
setSource(String source)
Sets the URI specifying the location of the media resource.
|
void |
setStandbyText(String standbyText)
Sets the message to display in the media player while the media resource is loading.
|
void |
setStyleClass(String styleClass)
Sets a CSS style class to use for this component.
|
void |
setUnsecure(Set<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(String width)
Sets the width in pixels to reserve for the media player plus its content.
|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final String PLAYER_WINDOWS
public static final String PLAYER_QUICKTIME
public static final String PLAYER_LINK
public static final String PLAYER_REAL
public static final String CONTROLS_NONE_VISIBLE
public static final String CONTROLS_NONE
public static final String CONTROLS_TYPICAL
public static final String CONTROLS_ALL
public static final String CONTROLS_MINIMAL
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey WIDTH_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HEIGHT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey INNER_WIDTH_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey INNER_HEIGHT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SOURCE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey AUTOSTART_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PLAY_COUNT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_TYPE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STANDBY_TEXT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PLAYER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTROLS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public RichMedia()
protected RichMedia(String rendererType)
public final String getWidth()
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.
public final void setWidth(String width)
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.
width
- the new width valuepublic final void setWidth(int width)
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.
width
- the new width valuepublic final String getHeight()
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.
public final void setHeight(String height)
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.
height
- the new height valuepublic final void setHeight(int height)
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.
height
- the new height valuepublic final int getInnerWidth()
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.
public final void setInnerWidth(int innerWidth)
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.
innerWidth
- the new innerWidth valuepublic final int getInnerHeight()
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.
public final void setInnerHeight(int innerHeight)
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.
innerHeight
- the new innerHeight valuepublic final String getSource()
public final void setSource(String source)
source
- the new source valuepublic final boolean isAutostart()
public final void setAutostart(boolean autostart)
autostart
- the new autostart valuepublic final int getPlayCount()
public final void setPlayCount(int playCount)
playCount
- the new playCount valuepublic final String getContentType()
public final void setContentType(String contentType)
contentType
- the new contentType valuepublic final String getStandbyText()
public final void setStandbyText(String standbyText)
standbyText
- the new standbyText valuepublic final String getPlayer()
"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.
public final void setPlayer(String player)
"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.
player
- the new player valuepublic final String getControls()
"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"
.
public final void setControls(String 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.
"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"
.
controls
- the new controls valuepublic final String getInlineStyle()
public final void setInlineStyle(String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final String getStyleClass()
public final void setStyleClass(String styleClass)
styleClass
- the new styleClass valuepublic final String getShortDesc()
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this 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 and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
public final void setShortDesc(String shortDesc)
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this 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 and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
shortDesc
- the new shortDesc valuepublic final Set<String> getUnsecure()
public final void setUnsecure(Set<String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value@Deprecated public final String getCustomizationId()
@Deprecated public final void setCustomizationId(String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final Set getClientAttributes()
public final void setClientAttributes(Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final String[] getPartialTriggers()
public final void setPartialTriggers(String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXObject
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXObject