Package com.smartgwt.client.widgets.plugins

Class Flashlet

java.lang.Object
com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.Widget
com.smartgwt.client.widgets.BaseWidget
com.smartgwt.client.widgets.Canvas
com.smartgwt.client.widgets.plugins.BrowserPlugin
com.smartgwt.client.widgets.plugins.Flashlet
All Implemented Interfaces:
HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, LogicalStructure, HasClearHandlers, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasRuleContextChangedHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasVisibilityChangedHandlers
public class Flashlet extends BrowserPlugin
ISC abstraction for Flashlets.

  • Constructor Details

    • Flashlet

      public Flashlet()

    • Flashlet

      public Flashlet(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static Flashlet getOrCreateRef(JavaScriptObject jsObj)

    • changeAutoChildDefaults

      public static void changeAutoChildDefaults(String autoChildName, Canvas defaults)
      Changes the defaults for Canvas AutoChildren named autoChildName.
      Parameters:
      autoChildName - name of an AutoChild to customize the defaults for.
      defaults - Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
      See Also:

    • changeAutoChildDefaults

      public static void changeAutoChildDefaults(String autoChildName, FormItem defaults)
      Changes the defaults for FormItem AutoChildren named autoChildName.
      Parameters:
      autoChildName - name of an AutoChild to customize the defaults for.
      defaults - FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, see SGWTProperties.
      See Also:

    • create

      protected JavaScriptObject create()
      Overrides:
      create in class BrowserPlugin

    • setClassID

      public Flashlet setClassID(String classID) throws IllegalStateException
      This attribute specifies the clsid of the outer <object> tag.

      The default classID is: "clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"

      Parameters:
      classID - New classID value. Default value is see below
      Returns:
      Flashlet instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created

    • getClassID

      public String getClassID()
      This attribute specifies the clsid of the outer <object> tag.

      The default classID is: "clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"

      Returns:
      Current classID value. Default value is see below

    • setCodeBase

      public Flashlet setCodeBase(String codeBase) throws IllegalStateException
      This attribute specifies the minimum version of the flash player required to show this flashlet.

      The default codeBase is: "http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=5,0,0,0"

      Parameters:
      codeBase - New codeBase value. Default value is see below
      Returns:
      Flashlet instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:

    • getCodeBase

      public String getCodeBase()
      This attribute specifies the minimum version of the flash player required to show this flashlet.

      The default codeBase is: "http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=5,0,0,0"

      Returns:
      Current codeBase value. Default value is see below
      See Also:

    • setName

      public Flashlet setName(String name) throws IllegalStateException
      Sets the 'name' attribute on the flashlet object. If a name is not provided it will be auto-generated. Note that in general you don't need to set this. If you have a handle to your ISC Flashlet object you can simply call getPluginHandle() to get a handle to the element.
      Overrides:
      setName in class Canvas
      Parameters:
      name - New name value. Default value is null
      Returns:
      Flashlet instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:

    • getName

      public String getName()
      Sets the 'name' attribute on the flashlet object. If a name is not provided it will be auto-generated. Note that in general you don't need to set this. If you have a handle to your ISC Flashlet object you can simply call getPluginHandle() to get a handle to the element.
      Overrides:
      getName in class Canvas
      Returns:
      Current name value. Default value is null
      See Also:

    • setParams

      public Flashlet setParams(Map params) throws IllegalStateException
      A map of key/value pairs to pass to the flashlet as parameters. Note that these will be set on the outer <object> element as well as the inner <embed> element.
      Parameters:
      params - New params value. Default value is null
      Returns:
      Flashlet instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created

    • getParams

      public Map getParams()
      A map of key/value pairs to pass to the flashlet as parameters. Note that these will be set on the outer <object> element as well as the inner <embed> element.
      Returns:
      Current params value. Default value is null

    • setPluginsPage

      public Flashlet setPluginsPage(String pluginsPage) throws IllegalStateException
      This attribute specifies the page the user should go to to get the plugin required to view this flashlet.

      The default pluginsPage is: "http://www.macromedia.com/shockwave/download/index.cgi?P1_Prod_Version=ShockwaveFlash"

      Parameters:
      pluginsPage - New pluginsPage value. Default value is see below
      Returns:
      Flashlet instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:

    • getPluginsPage

      public String getPluginsPage()
      This attribute specifies the page the user should go to to get the plugin required to view this flashlet.

      The default pluginsPage is: "http://www.macromedia.com/shockwave/download/index.cgi?P1_Prod_Version=ShockwaveFlash"

      Returns:
      Current pluginsPage value. Default value is see below
      See Also:

    • setSrc

      public Flashlet setSrc(String src) throws IllegalStateException
      Location from which to load the Flashlet.

      If this method is called after the component has been drawn/initialized: Sets the source file for the flash component
      Parameters:
      src - New src value. Default value is null
      Returns:
      Flashlet instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:

    • getSrc

      public String getSrc()
      Location from which to load the Flashlet.
      Returns:
      Current src value. Default value is null
      See Also:

    • flashAvailable

      public static boolean flashAvailable()
      Is Shockwave Flash installed on this browser?
      Returns:
      true if Flash is installed; false otherwise.

    • getFlashVersion

      public static int getFlashVersion()
      Which version of Flash is installed on this browser?
      Returns:
      flash version number, or null if flash is not installed

    • setDefaultProperties

      public static void setDefaultProperties(Flashlet flashletProperties)
      Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

      Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.

      Parameters:
      flashletProperties - properties that should be used as new defaults when instances of this class are created
      See Also:

    • getPluginHandle

      public Element getPluginHandle()
      Returns a handle to the flashlet DOM element (valid only after the component has been drawn).
      Returns:
      pointer to the plugin element in the DOM

    • setLogicalStructure

      public LogicalStructureObject setLogicalStructure(FlashletLogicalStructure s)
      Setter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.

    • getLogicalStructure

      public LogicalStructureObject getLogicalStructure()
      Getter implementing the LogicalStructure interface, which supports Eclipse's logical structure debugging facility.
      Specified by:
      getLogicalStructure in interface LogicalStructure
      Overrides:
      getLogicalStructure in class BrowserPlugin