com.smartgwt.client.widgets.drawing
Class DrawLabel

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

All Implemented Interfaces:

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

public class DrawLabel
extends DrawItem

DrawItem subclass to render a single-line text label.

Field Summary

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

config, id, scClassName

Constructor Summary

DrawLabel()

DrawLabel(JavaScriptObject jsObj)

Method Summary

JavaScriptObject	create()
String	getContents() This is the content that will exist as the label.
String	getFontFamily() Font family name, similar to the CSS font-family attribute.
int	getFontSize() Font size, similar to the CSS font-size attribute.
String	getFontStyle() Font style, similar to the CSS font-style attribute, eg "normal", "italic".
String	getFontWeight() Font weight, similar to the CSS font-weight attribute, eg "normal", "bold".
int	getLeft() Sets the amount from the left of its positioning that the element should be placed.
static DrawLabel	getOrCreateRef(JavaScriptObject jsObj)
int	getTop() Sets the amount from the top of its positioning that the element should be placed.
void	moveBy(int left, int top) Move both the start and end points of the line by a relative amount.
void	moveTo(int left, int top) Move the label to the absolute x, y coordinates
void	rotateTo(float degrees) Rotate the label by the absolute rotation in degrees
void	setContents(String contents) This is the content that will exist as the label.
void	setFontFamily(String fontFamily) Font family name, similar to the CSS font-family attribute.
void	setFontSize(int fontSize) Font size, similar to the CSS font-size attribute.
void	setFontStyle(String fontStyle) Font style, similar to the CSS font-style attribute, eg "normal", "italic".
void	setFontWeight(String fontWeight) Font weight, similar to the CSS font-weight attribute, eg "normal", "bold".
void	setLeft(int left) Sets the amount from the left of its positioning that the element should be placed.
void	setTop(int top) Sets the amount from the top of its positioning that the element should be placed.

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, getLineCap, getLineColor, getLineOpacity, getLinePattern, getLineWidth, getMoveKnobOffset, getMoveKnobPoint, getPageLeft, getPageTop, getRef, getResizeKnobPoints, getRotate, getScale, getShadow, getStartArrow, hide, hideKnobs, isInBounds, isPointInPath, resizeBy, rotateBy, scaleBy, scaleTo, setDragStartDistance, setDrawGroup, setDrawPane, setEndArrow, setFillColor, setFillGradient, setFillOpacity, setKnobs, setLineCap, 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

DrawLabel

public DrawLabel()

DrawLabel

public DrawLabel(JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static DrawLabel getOrCreateRef(JavaScriptObject jsObj)

create

public JavaScriptObject create()

Overrides:

create in class DrawItem

setContents

public void setContents(String contents)
                 throws IllegalStateException

This is the content that will exist as the label.

Parameters:

contents - contents Default value is null

Throws:

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

getContents

public String getContents()

This is the content that will exist as the label.

Returns:

String

setFontFamily

public void setFontFamily(String fontFamily)
                   throws IllegalStateException

Font family name, similar to the CSS font-family attribute.

Parameters:

fontFamily - fontFamily Default value is "Tahoma"

Throws:

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

getFontFamily

public String getFontFamily()

Font family name, similar to the CSS font-family attribute.

Returns:

String

setFontSize

public void setFontSize(int fontSize)
                 throws IllegalStateException

Font size, similar to the CSS font-size attribute.

Parameters:

fontSize - fontSize Default value is 18

Throws:

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

getFontSize

public int getFontSize()

Font size, similar to the CSS font-size attribute.

Returns:

int

setFontStyle

public void setFontStyle(String fontStyle)
                  throws IllegalStateException

Font style, similar to the CSS font-style attribute, eg "normal", "italic".

Parameters:

fontStyle - fontStyle Default value is "normal"

Throws:

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

getFontStyle

public String getFontStyle()

Font style, similar to the CSS font-style attribute, eg "normal", "italic".

Returns:

String

setFontWeight

public void setFontWeight(String fontWeight)
                   throws IllegalStateException

Font weight, similar to the CSS font-weight attribute, eg "normal", "bold".

Parameters:

fontWeight - fontWeight Default value is "bold"

Throws:

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

getFontWeight

public String getFontWeight()

Font weight, similar to the CSS font-weight attribute, eg "normal", "bold".

Returns:

String

setLeft

public void setLeft(int left)
             throws IllegalStateException

Sets the amount from the left of its positioning that the element should be placed.

Parameters:

left - left Default value is 0

Throws:

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

getLeft

public int getLeft()

Sets the amount from the left of its positioning that the element should be placed.

Returns:

int

setTop

public void setTop(int top)
            throws IllegalStateException

Sets the amount from the top of its positioning that the element should be placed.

Parameters:

top - top Default value is 0

Throws:

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

getTop

public int getTop()

Sets the amount from the top of its positioning that the element should be placed.

Returns:

int

moveBy

public void moveBy(int left,
                   int top)

Move both the start and end points of the line by a relative amount.

Overrides:

moveBy in class DrawItem

Parameters:

left - change to left coordinate in pixels

top - change to top coordinate in pixels

moveTo

public void moveTo(int left,
                   int top)

Move the label to the absolute x, y coordinates

Parameters:

left - new startLeft coordinate in pixels

top - new startTop coordinate in pixels

rotateTo

public void rotateTo(float degrees)

Rotate the label by the absolute rotation in degrees

Overrides:

rotateTo in class DrawItem

Parameters:

degrees - number of degrees to rotate