com.smartgwt.client.widgets.drawing
Class DrawRect

java.lang.Object
  com.smartgwt.client.core.BaseClass
      com.smartgwt.client.widgets.drawing.DrawItem
          com.smartgwt.client.widgets.drawing.DrawRect

All Implemented Interfaces:

HasHandlers, HasClickHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseUpHandlers

public class DrawRect
extends DrawItem

DrawItem subclass to render rectangle shapes, optionally with rounded corners.

Field Summary

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

config, id, scClassName

Constructor Summary

DrawRect()

DrawRect(JavaScriptObject jsObj)

Method Summary

JavaScriptObject	create()
int	getHeight() Height in pixels.
int	getLeft() Left coordinate in pixels relative to the DrawPane, or owning DrawGroup.
LineCap	getLineCap() Style of drawing the endpoints of a line.
static DrawRect	getOrCreateRef(JavaScriptObject jsObj)
float	getRounding() Rounding of corners, from 0 (square corners) to 1.0 (shorter edge is a semicircle).
int	getTop() Top coordinate in pixels relative to the DrawPane, or owning DrawGroup.
int	getWidth() Width in pixels.
void	moveBy(int dX, int dY) Move the drawRect by the specified delta
void	moveTo(int left, int top) Move the drawRect to the specified position
void	resizeBy(int dX, int dY) Resize by the specified delta
void	resizeTo(int width, int height) Resize to the specified size
void	setCenter(int left, int top) Move the drawRect such that it is centered over the specified coordinates.
void	setHeight(int height) Height in pixels.
void	setLeft(int left) Left coordinate in pixels relative to the DrawPane, or owning DrawGroup.
void	setLineCap(LineCap lineCap) Style of drawing the endpoints of a line.
void	setRect(int left, int top, int width, int height) Move and resize the drawRect to match the specified coordinates and size.
void	setRounding(float rounding) Rounding of corners, from 0 (square corners) to 1.0 (shorter edge is a semicircle).
void	setTop(int top) Top coordinate in pixels relative to the DrawPane, or owning DrawGroup.
void	setWidth(int width) Width in pixels.

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

addClickHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, convertToDrawItemArray, destroy, dragMove, dragStart, dragStop, draw, erase, getAttributeAsIntArray, getAttributeAsStringArray, getBoundingBox, getCenter, getDestroyed, getDestroying, getDragStartDistance, getDrawGroup, getDrawPane, getEndArrow, getFillColor, getFillGradient, getFillOpacity, getKnobs, getLineColor, getLineOpacity, getLinePattern, getLineWidth, getMoveKnobOffset, getMoveKnobPoint, getPageLeft, getPageTop, getRef, getResizeKnobPoints, getRotate, getScale, getShadow, getStartArrow, hide, hideKnobs, isInBounds, isPointInPath, rotateBy, rotateTo, scaleBy, scaleTo, setDragStartDistance, setDrawGroup, setDrawPane, setEndArrow, setFillColor, setFillGradient, setFillOpacity, setKnobs, setLineColor, setLineOpacity, setLinePattern, setLineWidth, setMoveKnobOffset, setMoveKnobPoint, setResizeKnobPoints, setRotate, setScale, setShadow, setStartArrow, show, showKnobs

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

doAddHandler, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getConfig, getHandlerCount, getID, getJsObj, getOrCreateJsObj, getScClassName, isCreated, onInit, 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

DrawRect

public DrawRect()

DrawRect

public DrawRect(JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static DrawRect getOrCreateRef(JavaScriptObject jsObj)

create

public JavaScriptObject create()

Overrides:

create in class DrawItem

setHeight

public void setHeight(int height)
               throws IllegalStateException

Height in pixels.

If this method is called after the component has been drawn/initialized: Set the height of the drawRect

Parameters:

height - new height. Default value is 100

Throws:

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, or owning DrawGroup.

If this method is called after the component has been drawn/initialized: Set the left coordinate of the drawRect

Parameters:

left - new left coordinate. Default value is 0

getLeft

public int getLeft()

Left coordinate in pixels relative to the DrawPane, or owning DrawGroup.

Returns:

int

setLineCap

public void setLineCap(LineCap lineCap)

Style of drawing the endpoints of a line.

Note that for dashed and dotted lines, the lineCap style affects each dash or dot.

Overrides:

setLineCap in class DrawItem

Parameters:

lineCap - lineCap Default value is "butt"

getLineCap

public LineCap getLineCap()

Style of drawing the endpoints of a line.

Note that for dashed and dotted lines, the lineCap style affects each dash or dot.

Overrides:

getLineCap in class DrawItem

Returns:

LineCap

setRounding

public void setRounding(float rounding)
                 throws IllegalStateException

Rounding of corners, from 0 (square corners) to 1.0 (shorter edge is a semicircle).

If this method is called after the component has been drawn/initialized: Setter method for rounding

Parameters:

rounding - new rounding value. Should be between zero (a rectangle) and 1 (shorter edge is a semicircle). Default value is 0

Throws:

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

getRounding

public float getRounding()

Rounding of corners, from 0 (square corners) to 1.0 (shorter edge is a semicircle).

Returns:

float

setTop

public void setTop(int top)

Top coordinate in pixels relative to the DrawPane, or owning DrawGroup.

If this method is called after the component has been drawn/initialized: Set the top coordinate of the drawRect

Parameters:

top - new top coordinate. Default value is 0

getTop

public int getTop()

Top coordinate in pixels relative to the DrawPane, or owning DrawGroup.

Returns:

int

setWidth

public void setWidth(int width)
              throws IllegalStateException

Width in pixels.

If this method is called after the component has been drawn/initialized: Set the width of the drawRect

Parameters:

width - new width. Default value is 100

Throws:

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 drawRect 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 drawRect to the specified position

Parameters:

left - new left coordinate

top - new top coordinate

resizeBy

public void resizeBy(int dX,
                     int dY)

Resize by the specified delta

Overrides:

resizeBy in class DrawItem

Parameters:

dX - number of pixels to resize by horizontally

dY - number of pixels to resize by vertically

resizeTo

public void resizeTo(int width,
                     int height)

Resize to the specified size

Parameters:

width - new width

height - new height

setCenter

public void setCenter(int left,
                      int top)

Move the drawRect such that it is centered over the specified coordinates.

Parameters:

left - left coordinate for new center position

top - top coordinate for new center postiion

setRect

public void setRect(int left,
                    int top,
                    int width,
                    int height)

Move and resize the drawRect to match the specified coordinates and size.

Parameters:

left - new left coordinate

top - new top coordinate

width - new width

height - new height