Package com.smartgwt.client.widgets.drawing

Class DrawImage

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.drawing.DrawItem
com.smartgwt.client.widgets.drawing.DrawImage
All Implemented Interfaces:
HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget, LogicalStructure, HasClickHandlers, HasDragMoveHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDrawEndHandlers, HasDrawStartHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseUpHandlers, HasMovedHandlers, HasResizedHandlers, HasShowContextMenuHandlers
public class DrawImage extends DrawItem
DrawItem subclass to render embedded images.

  • Constructor Details

    • DrawImage

      public DrawImage()

    • DrawImage

      public DrawImage(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static DrawImage 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:

    • changeAutoChildDefaults

      public static void changeAutoChildDefaults(String autoChildName, DrawItem defaults)
      Changes the defaults for DrawItem AutoChildren named autoChildName.
      Parameters:
      autoChildName - name of an AutoChild to customize the defaults for.
      defaults - DrawItem 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 DrawItem

    • setHeight

      public DrawImage setHeight(int height)
      Height in pixels relative to the local coordinate system.

      If this method is called after the component has been drawn/initialized: Set the height of the drawImage.
      Parameters:
      height - new height. Default value is 16
      Returns:
      DrawImage instance, for chaining setter calls

    • getHeight

      public int getHeight()
      Height in pixels relative to the local coordinate system.
      Returns:
      Current height value. Default value is 16

    • getHeightAsDouble

      public double getHeightAsDouble()
      Height in pixels relative to the local coordinate system.
      Returns:
      Current height value. Default value is 16

    • setLeft

      public DrawImage setLeft(int left)
      Left coordinate in pixels relative to the local coordinate system.

      If this method is called after the component has been drawn/initialized: Set the left coordinate of the drawImage.
      Parameters:
      left - new left coordinate. Default value is 0
      Returns:
      DrawImage instance, for chaining setter calls

    • getLeft

      public int getLeft()
      Left coordinate in pixels relative to the local coordinate system.
      Returns:
      Current left value. Default value is 0

    • getLeftAsDouble

      public double getLeftAsDouble()
      Left coordinate in pixels relative to the local coordinate system.
      Returns:
      Current left value. Default value is 0

    • setSrc

      public DrawImage setSrc(String src)
      URL to the image file.

      If this method is called after the component has been drawn/initialized: Change the URL of the image displayed.
      Parameters:
      src - new URL. Default value is "blank.png"
      Returns:
      DrawImage instance, for chaining setter calls
      See Also:

    • getSrc

      public String getSrc()
      URL to the image file.
      Returns:
      Current src value. Default value is "blank.png"
      See Also:

    • setTitle

      public void setTitle(String title) throws IllegalStateException
      Title (tooltip hover text) for this image.
      Overrides:
      setTitle in class DrawItem
      Parameters:
      title - New title value. Default value is null
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:

    • getTitle

      public String getTitle()
      Title (tooltip hover text) for this image.
      Overrides:
      getTitle in class DrawItem
      Returns:
      Current title value. Default value is null
      See Also:

    • setTop

      public DrawImage setTop(int top)
      Top coordinate in pixels relative to the local coordinate system.

      If this method is called after the component has been drawn/initialized: Set the top coordinate of the drawImage.
      Parameters:
      top - new top coordinate. Default value is 0
      Returns:
      DrawImage instance, for chaining setter calls

    • getTop

      public int getTop()
      Top coordinate in pixels relative to the local coordinate system.
      Returns:
      Current top value. Default value is 0

    • getTopAsDouble

      public double getTopAsDouble()
      Top coordinate in pixels relative to the local coordinate system.
      Returns:
      Current top value. Default value is 0

    • setUseMatrixFilter

      public DrawImage setUseMatrixFilter(Boolean useMatrixFilter) throws IllegalStateException
      Configures whether a Matrix filter is used to render this DrawImage in Internet Explorer 6-8.

      With the default of null, matrix filters may be used unless neverUseFilters has been set. When set explicitly to true, matrix filters may be used even if neverUseFilters is true.

      This setting exists due to platform limitations in Internet Explorer where it is impossible to implement shearing transforms on an image without a matrix filter. Shear can arise by:

      When prohibited from using a matrix filter, DrawImage will ignore the shearing components of its local transform. If any of the above conditions are met then the DrawImage might not be drawn correctly. Setting useMatrixFilter to true avoids this possibility but it also suffers from a range of side-effects mentioned here.
      Parameters:
      useMatrixFilter - New useMatrixFilter value. Default value is null
      Returns:
      DrawImage instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the component has been created
      See Also:

    • getUseMatrixFilter

      public Boolean getUseMatrixFilter()
      Configures whether a Matrix filter is used to render this DrawImage in Internet Explorer 6-8.

      With the default of null, matrix filters may be used unless neverUseFilters has been set. When set explicitly to true, matrix filters may be used even if neverUseFilters is true.

      This setting exists due to platform limitations in Internet Explorer where it is impossible to implement shearing transforms on an image without a matrix filter. Shear can arise by:

      When prohibited from using a matrix filter, DrawImage will ignore the shearing components of its local transform. If any of the above conditions are met then the DrawImage might not be drawn correctly. Setting useMatrixFilter to true avoids this possibility but it also suffers from a range of side-effects mentioned here.
      Returns:
      Current useMatrixFilter value. Default value is null
      See Also:

    • setWidth

      public DrawImage setWidth(int width)
      Width in pixels relative to the local coordinate system.

      If this method is called after the component has been drawn/initialized: Set the width of the drawImage.
      Parameters:
      width - new width. Default value is 16
      Returns:
      DrawImage instance, for chaining setter calls

    • getWidth

      public int getWidth()
      Width in pixels relative to the local coordinate system.
      Returns:
      Current width value. Default value is 16

    • getWidthAsDouble

      public double getWidthAsDouble()
      Width in pixels relative to the local coordinate system.
      Returns:
      Current width value. Default value is 16

    • getCenter

      public Point getCenter()
      Get the center point of the image.
      Overrides:
      getCenter in class DrawItem
      Returns:
      the center point

    • moveBy

      public void moveBy(int dX, int dY)
      Move the drawImage by the specified delta
      Overrides:
      moveBy in class DrawItem
      Parameters:
      dX - number of pixels to move horizontally
      dY - number of pixels to move vertically

    • moveTo

      public void moveTo(Integer left, Integer top)
      Move the drawImage to the specified position
      Overrides:
      moveTo in class DrawItem
      Parameters:
      left - new left coordinate
      top - new top coordinate

    • setRect

      public void setRect(Integer left, Integer top, Integer width, Integer height)
      Updates the drawImage to match the specified coordinates and size in local coordinates.
      Parameters:
      left - new left coordinate
      top - new top coordinate
      width - new width
      height - new height

    • setDefaultProperties

      public static void setDefaultProperties(DrawImage drawImageProperties)
      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:
      drawImageProperties - properties that should be used as new defaults when instances of this class are created
      See Also:

    • setLogicalStructure

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