Package com.smartgwt.client.widgets.plugins

Class ActiveXControl

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.ActiveXControl
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 ActiveXControl extends BrowserPlugin
ISC Abstraction for ActiveX controls

  • Constructor Details

    • ActiveXControl

      public ActiveXControl()

    • ActiveXControl

      public ActiveXControl(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static ActiveXControl 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 ActiveXControl setClassID(String classID) throws IllegalStateException
      This sets the value of the classID property on the object. This is meant to give you complete control over the generated HTML. In practice it may be more handy to set the uuid property on this object and let the classID be generated from that.
      Parameters:
      classID - New classID value. Default value is null
      Returns:
      ActiveXControl instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:

    • getClassID

      public String getClassID()
      This sets the value of the classID property on the object. This is meant to give you complete control over the generated HTML. In practice it may be more handy to set the uuid property on this object and let the classID be generated from that.
      Returns:
      Current classID value. Default value is null
      See Also:

    • setCodeBase

      public ActiveXControl setCodeBase(String codeBase) throws IllegalStateException
      Specifies the URL from which to load the ActiveX control.
      Parameters:
      codeBase - New codeBase value. Default value is null
      Returns:
      ActiveXControl instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:

    • getCodeBase

      public String getCodeBase()
      Specifies the URL from which to load the ActiveX control.
      Returns:
      Current codeBase value. Default value is null
      See Also:

    • setId

      public ActiveXControl setId(String id) throws IllegalStateException
      Sets the 'id' attribute on the 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 reference to your ISC ActiveX control object you can simply call getPluginHandle() to get a handle to the element.
      Parameters:
      id - New id value. Default value is null
      Returns:
      ActiveXControl instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:

    • getId

      public String getId()
      Sets the 'id' attribute on the 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 reference to your ISC ActiveX control object you can simply call getPluginHandle() to get a handle to the element.
      Returns:
      Current id value. Default value is null
      See Also:

    • setParams

      public ActiveXControl setParams(Map params) throws IllegalStateException
      A map of key/value pairs to pass to the Active X control as parameters.
      Parameters:
      params - New params value. Default value is null
      Returns:
      ActiveXControl 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 Active X control as parameters.
      Returns:
      Current params value. Default value is null

    • setUuid

      public ActiveXControl setUuid(String uuid) throws IllegalStateException
      Set this to the uuid of your Active X control - ISC will then generate the appropriate classID entry for you.
      Parameters:
      uuid - New uuid value. Default value is null
      Returns:
      ActiveXControl instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created

    • getUuid

      public String getUuid()
      Set this to the uuid of your Active X control - ISC will then generate the appropriate classID entry for you.
      Returns:
      Current uuid value. Default value is null

    • getPluginID

      public String getPluginID()
      Returns the ID for this ISC ActiveX control object. If the id property was specified for the object, that will be used, otherwise the ID will be auto-generated.
      Returns:
      the ID for this ISC ActiveX control object.

    • setDefaultProperties

      public static void setDefaultProperties(ActiveXControl activeXControlProperties)
      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:
      activeXControlProperties - 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 element for this ISC ActiveX control object.
      Returns:
      pointer to the plugin element in the DOM

    • setLogicalStructure

      public LogicalStructureObject setLogicalStructure(ActiveXControlLogicalStructure 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