dojox/embed/Flash.js

• Provides:

  • dojox.embed.Flash

• dojox.embed.Flash.minSupported

  • type

    Number

  • summary

    The minimum supported version of the Flash Player, defaults to 8.

• dojox.embed.Flash.available

  • alias - fVersion.major
  • type

    Number

  • summary

    Used as both a detection (i.e. if(dojox.embed.Flash.available){ })
    and as a variable holding the major version of the player installed.

• dojox.embed.Flash.supported

  • type

    Boolean

  • summary

    Whether or not the Flash Player installed is supported by dojox.embed.

• dojox.embed.Flash.minimumRequired

  • alias - fVersion.required

• dojox.embed.Flash.version

  • alias - fVersion
  • type

    Object

  • summary

    The version of the installed Flash Player; takes the form of
    { major, minor, rev }.  To get the major version, you'd do this:
    var v=dojox.embed.Flash.version.major;

• dojox.embed.Flash.initialized

  • type

    Boolean

  • summary

    Whether or not the Flash engine is available for use.

• dojox.embed.Flash.onInitialize

  • type

    Function

  • summary

    A stub you can connect to if you are looking to fire code when the
    engine becomes available.  A note: DO NOT use this event to
    place a movie in a document; it will usually fire before DOMContentLoaded
    is fired, and you will get an error.  Use dojo.addOnLoad instead.

• dojox.embed.Flash.__ie_markup__

  • parameters:
    • kwArgs
  • type

    Function

• dojox.embed.Flash.proxy

  • parameters:
    • obj: (typeof dojox.embed.Flash)
    • methods: (typeof Array|String)
  • summary

    Create the set of passed methods on the dojox.embed.Flash object
    so that you can call that object directly, as opposed to having to
    delve into the internal movie to do this.  Intended to make working
    with Flash movies that use ExternalInterface much easier to use.

  • example

    Create "setMessage" and "getMessage" methods on foo.
    	var foo = new dojox.embed.Flash(args, someNode);
    	dojo.connect(foo, "onLoad", dojo.hitch(foo, function(){
    		dojox.embed.Flash.proxy(this, [ "setMessage", "getMessage" ]);
    		this.setMessage("dojox.embed.Flash.proxy is pretty cool...");
    		console.log(this.getMessage());
    	}));

  • type

    Function

• dojox.embed.Flash

  • summary

    Create a wrapper object around a Flash movie; this is the DojoX equivilent
    to SWFObject.

  • type

    Function

  • parameters:
    • kwArgs: (typeof dojox.embed.__flashArgs)

      The various arguments that will be used to help define the Flash movie.

    • node: (typeof DOMNode)

      DomNode The node where the embed object will be placed

  • description

    Creates a wrapper object around a Flash movie.  Wrapper object will
    insert the movie reference in node; when the browser first starts
    grabbing the movie, onReady will be fired; when the movie has finished
    loading, it will fire onLoad.
    
    If your movie uses ExternalInterface, you should use the onLoad event
    to do any kind of proxy setup (see dojox.embed.Flash.proxy); this seems
    to be the only consistent time calling EI methods are stable (since the
    Flash movie will shoot several methods into the window object before
    EI callbacks can be used properly).
    
    *Important note*:  this code includes a workaround for the Eolas "fix" from
    Microsoft; in order to work around the "click to activate this control" message
    on any embedded Flash movie, this code will load a separate, non-dojo.require
    javascript file in order to write the Flash movie into the document.  As such
    it cannot be used with Dojo's scope map techniques for working with multiple
    versions of Dojo on the same page.

  • example

    Embed a flash movie in a document using the new operator, and get a reference to it.
    	var movie = new dojox.embed.Flash({
    		path: "path/to/my/movie.swf",
    		width: 400,
    		height: 300
    	}, myWrapperNode, "testLoaded");

  • example

    Embed a flash movie in a document without using the new operator.
    	var movie = dojox.embed.Flash({
    		path: "path/to/my/movie.swf",
    		width: 400,
    		height: 300,
    		style: "position:absolute;top:0;left:0"
    	}, myWrapperNode, "testLoaded");
    
    File can only be run from a server, due to SWF dependency.

• dojox.embed.Flash.onReady

  • parameters:
    • movie: (typeof HTMLObject)
  • type

    Function

• dojox.embed.Flash.onLoad

  • parameters:
    • movie: (typeof HTMLObject)
  • type

    Function

• dojox.embed.Flash.onError

  • parameters:
    • msg
  • type

    Function

• dojox.embed.Flash._onload

  • summary

    Internal. Cleans up before calling onLoad.

  • type

    Function

• dojox.embed.Flash.init

  • parameters:
    • kwArgs: (typeof dojox.embed.__flashArgs)
    • node: (typeof DOMNode)
  • type

    Function

• dojox.embed.Flash.init._poller

  • type

    Object

• dojox.embed.Flash.init._pollCount

  • type

    Number

• dojox.embed.Flash.init._pollMax

  • type

    Number

• dojox.embed.Flash.init.pollTime

  • type

    Number

• dojox.embed.Flash.init.id

  • type

    Object

• dojox.embed.Flash.init.domNode

• dojox.embed.Flash._destroy

  • type

    Function

• dojox.embed.Flash._destroy.id

  • type

    Object

• dojox.embed.Flash._destroy.movie

  • type

    Object

• dojox.embed.Flash._destroy.domNode

  • type

    Object

• dojox.embed.Flash.destroy

  • type

    Function

• dojox.embed.Flash.byId

  • parameters:
    • movieName: (typeof String)

      The name of the SWF

    • doc: (typeof Object)

      The document, if not current window
      (not fully supported)

  • summary

    Gets Flash movie by id.

  • description

    Probably includes methods for outdated
    browsers, but this should catch all cases.
    arguments:

  • example

     var movie = dojox.embed.Flash.byId("myId");

  • type

    Function

• dojox.embed.__flashArgs

  • parameters:
    • path: (typeof String)

      The URL of the movie to embed.

    • id: (typeof String)

      A unique key that will be used as the id of the created markup.  If you don't
      provide this, a unique key will be generated.

    • width: (typeof Number)

      The width of the embedded movie; the default value is 320px.

    • height: (typeof Number)

      The height of the embedded movie; the default value is 240px

    • style: (typeof String)

      Any CSS style information (i.e. style="background-color:transparent") you want
      to define on the markup.

    • params: (typeof Object)

      A set of key/value pairs that you want to define in the resultant markup.

    • vars: (typeof Object)

      A set of key/value pairs that the Flash movie will interpret as FlashVars.

    • expressInstall: (typeof Boolean)

      Whether or not to include any kind of expressInstall info. Default is false.

    • redirect: (typeof String)

      A url to redirect the browser to if the current Flash version is not supported.

  • type

    Function

• dojox.embed.__flashArgs.id

  • optional
  • type

    String

  • summary

    A unique key that will be used as the id of the created markup.  If you don't
    provide this, a unique key will be generated.

• dojox.embed.__flashArgs.path

  • type

    String

  • summary

    The URL of the movie to embed.

• dojox.embed.__flashArgs.width

  • optional
  • type

    Number

  • summary

    The width of the embedded movie; the default value is 320px.

• dojox.embed.__flashArgs.minimumVersion

  • type

    Number

  • summary

    ?
    The minimum targeted version of the Flash Player (defaults to 9)

• dojox.embed.__flashArgs.height

  • optional
  • type

    Number

  • summary

    The height of the embedded movie; the default value is 240px

• dojox.embed.__flashArgs.style

  • optional
  • type

    String

  • summary

    Any CSS style information (i.e. style="background-color:transparent") you want
    to define on the markup.

• dojox.embed.__flashArgs.params

  • optional
  • type

    Object

  • summary

    A set of key/value pairs that you want to define in the resultant markup.

• dojox.embed.__flashArgs.vars

  • optional
  • type

    Object

  • summary

    A set of key/value pairs that the Flash movie will interpret as FlashVars.

• dojox.embed.__flashArgs.expressInstall

  • optional
  • type

    Boolean

  • summary

    Whether or not to include any kind of expressInstall info. Default is false.

• dojox.embed.__flashArgs.redirect

  • optional
  • type

    String

  • summary

    A url to redirect the browser to if the current Flash version is not supported.

• dojox.embed.Flash.minimumVersion

  • type

    Object

• dojox.embed.Flash.id

  • type

    Object

• dojox.embed.Flash.movie

  • type

    Object

• dojox.embed.Flash.domNode

  • type

    Object

• dojox.embed.Flash.place

  • parameters:
    • kwArgs
    • node
  • type

    Function

• dojox.embed

  • type

    Object

• dojox

  • type

    Object