|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class RichMedia
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 control attempts to pick the appropriate media player using the following steps:
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>
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, 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 |
---|
encodeAll, getContainerClientId |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PLAYER_WINDOWS
public static final java.lang.String PLAYER_QUICKTIME
public static final java.lang.String PLAYER_LINK
public static final java.lang.String PLAYER_REAL
public static final java.lang.String CONTROLS_NONE_VISIBLE
public static final java.lang.String CONTROLS_NONE
public static final java.lang.String CONTROLS_TYPICAL
public static final java.lang.String CONTROLS_ALL
public static final java.lang.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 java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichMedia()
protected RichMedia(java.lang.String rendererType)
Method Detail |
---|
public final java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getSource()
public final void setSource(java.lang.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 java.lang.String getContentType()
public final void setContentType(java.lang.String contentType)
contentType
- the new contentType valuepublic final java.lang.String getStandbyText()
public final void setStandbyText(java.lang.String standbyText)
standbyText
- the new standbyText valuepublic final java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.util.Set<java.lang.String> getUnsecure()
public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value
@Deprecated
public final java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic java.lang.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
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |