com.smartgwt.client.widgets.drawing

Class DrawImage

java.lang.Object

com.smartgwt.client.core.BaseClass

com.smartgwt.client.widgets.drawing.DrawItem

com.smartgwt.client.widgets.drawing.DrawImage

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers, HasClickHandlers, HasDragMoveHandlers, HasDragResizeMoveHandlers, HasDragStartHandlers, HasDragStopHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseUpHandlers, HasMovedHandlers, HasResizedHandlers, HasShowContextMenuHandlers

public class DrawImage
extends DrawItem

DrawItem subclass to render embedded images.

Field Summary

Fields inherited from class com.smartgwt.client.core.BaseClass

config, id, scClassName

Constructor Summary

Constructors

Constructor and Description
DrawImage()
DrawImage(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Summary

Methods

Modifier and Type	Method and Description
com.google.gwt.core.client.JavaScriptObject	create()
int	getHeight() Height in pixels.
int	getLeft() Left coordinate in pixels relative to the DrawPane.
static DrawImage	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
java.lang.String	getSrc() URL to the image file.
java.lang.String	getTitle() Title (tooltip hover text) for this image.
int	getTop() Top coordinate in pixels relative to the DrawPane.
int	getWidth() Width in pixels.
void	moveBy(int dX, int dY) Move the drawImage by the specified delta
void	moveTo(int left, int top) Move the drawImage to the specified position
static void	setDefaultProperties(DrawImage drawImageProperties) Class level method to set the default properties of this class.
void	setHeight(int height) Height in pixels.
void	setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)
void	setLeft(int left) Left coordinate in pixels relative to the DrawPane.
void	setSrc(java.lang.String src) URL to the image file.
void	setTitle(java.lang.String title) Title (tooltip hover text) for this image.
void	setTop(int top) Top coordinate in pixels relative to the DrawPane.
void	setWidth(int width) Width in pixels.

Methods inherited from class com.smartgwt.client.widgets.drawing.DrawItem

addClickHandler, addDragMoveHandler, addDragResizeMoveHandler, addDragStartHandler, addDragStopHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMovedHandler, addResizedHandler, addShowContextMenuHandler, computeAngle, computeAngleAsDouble, dragResizeMove, draw, erase, getAttributeAsIntArray, getBoundingBox, getCanDrag, getCanHover, getCenter, getContextMenu, getCursor, getDestroyed, getDestroying, getDragStartDistance, getDrawGroup, getDrawPane, getEndArrow, getFillColor, getFillGradient, getFillOpacity, getHoverHTML, getKeepInParentRect, getKnobs, getLineCap, getLineColor, getLineOpacity, getLinePattern, getLineWidth, getMoveKnobOffset, getMoveKnobPoint, getPageLeft, getPageTop, getPrompt, getRef, getResizeKnobPoints, getRotation, getScale, getShadow, getShowHover, getStartArrow, getSvgString, hide, hideKnobs, hover, isInBounds, isPointInPath, resizeBy, resizeTo, rotateBy, rotateBy, rotateTo, rotateTo, scaleBy, scaleBy, scaleTo, scaleTo, setAttribute, setCanDrag, setCanHover, setContextMenu, setCursor, setDefaultProperties, setDragStartDistance, setDrawGroup, setDrawPane, setEndArrow, setFillColor, setFillGradient, setFillOpacity, setKeepInParentRect, setKeepInParentRect, setKnobs, setLineCap, setLineColor, setLineOpacity, setLinePattern, setLineWidth, setMoveKnobOffset, setMoveKnobPoint, setPrompt, setResizeKnobPoints, setRotation, setScale, setShadow, setShowHover, setStartArrow, show, showKnobs

Methods inherited from class com.smartgwt.client.core.BaseClass

asSGWTComponent, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getID, getJsObj, getOrCreateJsObj, getScClassName, internalSetID, internalSetID, isCreated, onBind, onInit, registerID, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setID, setProperty, setProperty, setProperty, setProperty, setScClassName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

DrawImage

public DrawImage()

DrawImage

public DrawImage(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static DrawImage getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

setJavaScriptObject

public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)

Overrides:

setJavaScriptObject in class DrawItem

create

public com.google.gwt.core.client.JavaScriptObject create()

Overrides:

create in class DrawItem

setHeight

public void setHeight(int height)
               throws java.lang.IllegalStateException

Height in pixels.

Parameters:

height - height Default value is 16

Throws:

java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created

getHeight

public int getHeight()

Height in pixels.

Returns:

int

setLeft

public void setLeft(int left)

Left coordinate in pixels relative to the DrawPane.

Parameters:

left - left Default value is 0

getLeft

public int getLeft()

Left coordinate in pixels relative to the DrawPane.

Returns:

int

setSrc

public void setSrc(java.lang.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. See String. Default value is "blank.png"

getSrc

public java.lang.String getSrc()

URL to the image file.

Returns:

. See String

setTitle

public void setTitle(java.lang.String title)
              throws java.lang.IllegalStateException

Title (tooltip hover text) for this image.

Parameters:

title - . See String. Default value is null

Throws:

java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created

getTitle

public java.lang.String getTitle()

Title (tooltip hover text) for this image.

Returns:

. See String

setTop

public void setTop(int top)

Top coordinate in pixels relative to the DrawPane.

Parameters:

top - top Default value is 0

getTop

public int getTop()

Top coordinate in pixels relative to the DrawPane.

Returns:

int

setWidth

public void setWidth(int width)
              throws java.lang.IllegalStateException

Width in pixels.

Parameters:

width - width Default value is 16

Throws:

java.lang.IllegalStateException - this property cannot be changed after the underlying component has been created

getWidth

public int getWidth()

Width in pixels.

Returns:

int

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(int left,
          int top)

Move the drawImage to the specified position

Parameters:

left - new left coordinate

top - new top coordinate

setDefaultProperties

public static void setDefaultProperties(DrawImage drawImageProperties)

Class level method to set the default properties of this class. If set, then all subsequent instances of this class will automatically have the default properties that were set when this method was called. 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 effect 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.

Parameters:

drawImageProperties - properties that should be used as new defaults when instances of this class are created