| Package | org.osmf.elements |
| Class | public class ProxyElement |
| Inheritance | ProxyElement  MediaElement EventDispatcher Object |
| Subclasses | DurationElement, LoadFromDocumentElement |
| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
ProxyElement is not instantiated directly but rather used as the base class for creating wrappers for specific purposes. ProxyElement can be subclassed for any trait type or set of trait types. The subclass controls access to the proxied element either by overriding one or more of the proxied element's traits or by blocking them.
To override any of the proxied element's traits, the subclass creates its own trait instances, which it substitutes for the proxied element's traits that it wishes to override.
To block traits, the subclass prevents the traits of
the proxied element from being exposed by setting the ProxyElement's
blockedTraits property for the trait
types that it wants to block.
This causes the proxied element's hasTrait()
method to return false and its
getTrait() method to return null
for the blocked trait types.
A ProxyElement normally dispatches the proxied element's events, unless the trait's type is among those that are blocked by the ProxyElement.
ProxyElement subclasses are useful for modifying the behavior of a MediaElement in a non-invasive way. An example would be adding temporal capabilities to a set of ImageElements to present them in a slide show in which the images are displayed for a specified duration. The ProxyElement subclass would proxy the non-temporal ImageElements and override the proxied element's TimeTrait to return a custom instance of that trait. A similar approach can be applied to other traits, either to provide an alternate implementation of some of the proxied element's underlying traits, to provide an implementation when a needed underlying trait does not exist, or to prevent an underlying trait from being exposed at all.
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| container : IMediaContainer [read-only]
The media container that this element uses. | MediaElement | |
| metadataNamespaceURLs : Vector.<String> [read-only]
A Vector containing the namespace URLs for all Metadata
objects stored within this MediaElement. | MediaElement | |
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| proxiedElement : MediaElement
The MediaElement for which this ProxyElement serves as a proxy,
or wrapper. | ProxyElement | ||
| resource : MediaResourceBase
The media resource that this media element operates on. | MediaElement | |
| traitTypes : Vector.<String> [read-only]
A Vector of MediaTraitType values representing the trait types on this
media element. | MediaElement | |
| Property | Defined By | ||
|---|---|---|---|
| blockedTraits : Vector.<String>
The set of MediaTraitTypes that this ProxyElement will block. | ProxyElement | ||
| Method | Defined By | ||
|---|---|---|---|
ProxyElement(proxiedElement:MediaElement = null)
Constructor. | ProxyElement | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Adds a Metadata object to this MediaElement under the specified namespace URL. | MediaElement | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Returns the Metadata object that is stored under this MediaElement with
the specified namespace URL. | MediaElement | |
|
Returns the media trait of the specified type. | MediaElement | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether this media element has a media trait of the
specified type. | MediaElement | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes the Metadata object that was stored under this MediaElement with
the specified namespace URL. | MediaElement | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
blockedTraits | property |
blockedTraits:Vector.<String>| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The set of MediaTraitTypes that this ProxyElement will block. When a trait is blocked, the ProxyElement will prevent that trait from being exposed when the proxied element contains the trait and the proxy does not. Subclasses can call this to selectively block access to the traits of the proxied element on a per-type basis.
Implementation
protected function get blockedTraits():Vector.<String> protected function set blockedTraits(value:Vector.<String>):voidproxiedElement | property |
proxiedElement:MediaElement| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The MediaElement for which this ProxyElement serves as a proxy, or wrapper.
Implementation
public function get proxiedElement():MediaElement public function set proxiedElement(value:MediaElement):voidProxyElement | () | Constructor |
public function ProxyElement(proxiedElement:MediaElement = null)| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
ParametersproxiedElement:MediaElement (default = null) |
Mon Nov 28 2011, 06:48 AM -08:00