public class CoreMedia extends UIXObject implements javax.faces.component.behavior.ClientBehaviorHolder
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. |
UIXComponentBase.ComponentSystemEventListenerWrapper
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
Modifier | Constructor and Description |
---|---|
|
CoreMedia()
Construct an instance of the CoreMedia.
|
protected |
CoreMedia(String rendererType)
Construct an instance of the CoreMedia.
|
Modifier and Type | Method and Description |
---|---|
void |
addClientBehavior(String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
Utility method to assist sub-classes in the implementation of the
ClientBehaviorHolder interface. |
protected FacesBean.Type |
getBeanType() |
Map<String,List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors()
Utility method to assist sub-classes in the implementation of the
ClientBehaviorHolder interface. |
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 |
getDefaultEventName()
Utility method to assist sub-classes in the implementation of the
ClientBehaviorHolder interface. |
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getHeight()
Gets 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 height in pixels to reserve for the media player content.
|
int |
getInnerWidth()
Gets width in pixels to reserve for the media player content.
|
String |
getOnclick()
Gets an onclick Javascript handler.
|
String |
getOndblclick()
Gets an ondblclick Javascript handler.
|
String |
getOnkeydown()
Gets an onkeydown Javascript handler.
|
String |
getOnkeypress()
Gets an onkeypress Javascript handler.
|
String |
getOnkeyup()
Gets an onkeyup Javascript handler.
|
String |
getOnmousedown()
Gets an onmousedown Javascript handler.
|
String |
getOnmousemove()
Gets an onmousemove Javascript handler.
|
String |
getOnmouseout()
Gets an onmouseout Javascript handler.
|
String |
getOnmouseover()
Gets an onmouseover Javascript handler.
|
String |
getOnmouseup()
Gets an onmouseup Javascript handler.
|
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 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.
|
String |
getWidth()
Gets width in pixels to reserve for the media player plus its content.
|
boolean |
isAutostart()
Gets a boolean value that controls whether the media resource loads
and plays automatically without user initiation.
|
void |
setAutostart(boolean autostart)
Sets a boolean value that controls whether the media resource loads
and plays automatically without user initiation.
|
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 |
setHeight(int height)
Sets height in pixels to reserve for the media player plus its content.
|
void |
setHeight(String height)
Sets 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 height in pixels to reserve for the media player content.
|
void |
setInnerWidth(int innerWidth)
Sets width in pixels to reserve for the media player content.
|
void |
setOnclick(String onclick)
Sets an onclick Javascript handler.
|
void |
setOndblclick(String ondblclick)
Sets an ondblclick Javascript handler.
|
void |
setOnkeydown(String onkeydown)
Sets an onkeydown Javascript handler.
|
void |
setOnkeypress(String onkeypress)
Sets an onkeypress Javascript handler.
|
void |
setOnkeyup(String onkeyup)
Sets an onkeyup Javascript handler.
|
void |
setOnmousedown(String onmousedown)
Sets an onmousedown Javascript handler.
|
void |
setOnmousemove(String onmousemove)
Sets an onmousemove Javascript handler.
|
void |
setOnmouseout(String onmouseout)
Sets an onmouseout Javascript handler.
|
void |
setOnmouseover(String onmouseover)
Sets an onmouseover Javascript handler.
|
void |
setOnmouseup(String onmouseup)
Sets an onmouseup Javascript handler.
|
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 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 |
setWidth(int width)
Sets width in pixels to reserve for the media player plus its content.
|
void |
setWidth(String width)
Sets 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 FacesBean.Type TYPE
public static final PropertyKey WIDTH_KEY
public static final PropertyKey HEIGHT_KEY
public static final PropertyKey INNER_WIDTH_KEY
public static final PropertyKey INNER_HEIGHT_KEY
public static final PropertyKey SOURCE_KEY
public static final PropertyKey AUTOSTART_KEY
public static final PropertyKey PLAY_COUNT_KEY
public static final PropertyKey CONTENT_TYPE_KEY
public static final PropertyKey STANDBY_TEXT_KEY
public static final PropertyKey PLAYER_KEY
public static final PropertyKey CONTROLS_KEY
public static final PropertyKey INLINE_STYLE_KEY
public static final PropertyKey STYLE_CLASS_KEY
public static final PropertyKey SHORT_DESC_KEY
public static final PropertyKey PARTIAL_TRIGGERS_KEY
public static final PropertyKey ONCLICK_KEY
public static final PropertyKey ONDBLCLICK_KEY
public static final PropertyKey ONMOUSEDOWN_KEY
public static final PropertyKey ONMOUSEUP_KEY
public static final PropertyKey ONMOUSEOVER_KEY
public static final PropertyKey ONMOUSEMOVE_KEY
public static final PropertyKey ONMOUSEOUT_KEY
public static final PropertyKey ONKEYPRESS_KEY
public static final PropertyKey ONKEYDOWN_KEY
public static final PropertyKey ONKEYUP_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public CoreMedia()
protected CoreMedia(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()
public final void setShortDesc(String shortDesc)
shortDesc
- the new shortDesc valuepublic final String[] getPartialTriggers()
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.
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".
public final void setPartialTriggers(String[] partialTriggers)
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.
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".
partialTriggers
- the new partialTriggers valuepublic final String getOnclick()
public final void setOnclick(String onclick)
onclick
- the new onclick valuepublic final String getOndblclick()
public final void setOndblclick(String ondblclick)
ondblclick
- the new ondblclick valuepublic final String getOnmousedown()
public final void setOnmousedown(String onmousedown)
onmousedown
- the new onmousedown valuepublic final String getOnmouseup()
public final void setOnmouseup(String onmouseup)
onmouseup
- the new onmouseup valuepublic final String getOnmouseover()
public final void setOnmouseover(String onmouseover)
onmouseover
- the new onmouseover valuepublic final String getOnmousemove()
public final void setOnmousemove(String onmousemove)
onmousemove
- the new onmousemove valuepublic final String getOnmouseout()
public final void setOnmouseout(String onmouseout)
onmouseout
- the new onmouseout valuepublic final String getOnkeypress()
public final void setOnkeypress(String onkeypress)
onkeypress
- the new onkeypress valuepublic final String getOnkeydown()
public final void setOnkeydown(String onkeydown)
onkeydown
- the new onkeydown valuepublic final String getOnkeyup()
public final void setOnkeyup(String onkeyup)
onkeyup
- the new onkeyup valuepublic String getDefaultEventName()
UIXComponentBase
ClientBehaviorHolder
interface.
This method must only be called by classes that implement the interface, doing otherwise will result in an exception.
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class UIXComponentBase
ClientBehaviorHolder.getDefaultEventName()
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
UIXComponentBase
ClientBehaviorHolder
interface.
This method must only be called by classes that implement the interface, doing otherwise will result in an exception.
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class UIXComponentBase
ClientBehaviorHolder.getClientBehaviors()
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
UIXComponentBase
ClientBehaviorHolder
interface.
This method must only be called by classes that implement the interface, doing otherwise will result in an exception.
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class UIXComponentBase
eventName
- The event namebehavior
- The behavior to addClientBehaviorHolder.addClientBehavior(String, ClientBehavior)
protected FacesBean.Type getBeanType()
getBeanType
in class UIXObject
Copyright © 2001-2017 The Apache Software Foundation. All Rights Reserved.