edu.ucdavis.cstars.client.symbol

Class TextSymbol

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.symbol.Symbol

edu.ucdavis.cstars.client.symbol.TextSymbol

public class TextSymbol
extends Symbol

Text symbols are used to add text on the graphics layer.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextSymbol.AlignType
static class	TextSymbol.DecorationType

Method Summary

Methods

Modifier and Type	Method and Description
static TextSymbol	create(com.google.gwt.core.client.JavaScriptObject json) Creates a new TextSymbol object using a JSON object.
static TextSymbol	create(java.lang.String text) Creates a new TextSymbol object that includes only the text.
static TextSymbol	create(java.lang.String text, Font font, Color color) Creates a new TextSymbol object.
TextSymbol.AlignType	getAlign() The text alignment in relation to the point.
int	getAngle() Text angle.
TextSymbol.DecorationType	getDecoration() The decoration on the text.
Font	getFont() Font for displaying text.
java.lang.String	getText() Text string for display in the graphics layer.
int	getXOffset() The offset on the x-axis in pixels from the point.
int	getYOffset() The offset on the y-axis in pixels from the point.
boolean	hasKerning() Determines whether to adjust the spacing between characters in the text string.
boolean	isRotated() Determines whether every character in the text string is rotated.
TextSymbol	setAlign(TextSymbol.AlignType align) Sets the alignment of the text.
TextSymbol	setAngle(int angle) Sets the angle of the text.
TextSymbol	setDecoration(TextSymbol.DecorationType decoration) Sets the decoration for the text.Many browsers including Internet Explorer 7, Firefox and Opera 9 do not support the decoration properties for text symbols.
TextSymbol	setFont(Font font) Sets the text font.
TextSymbol	setKerning(boolean kerning) Sets whether to adjust the spacing between characters in the text string.
TextSymbol	setOffset(int x, int y) Sets the x and y offset of the text.
TextSymbol	setRotated(boolean rotated) Sets whether every character in the text string is rotated.
TextSymbol	setText(java.lang.String text) Sets the text string.

Methods inherited from class edu.ucdavis.cstars.client.symbol.Symbol

fromJson, getColor, getType, setColor, toJson

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static TextSymbol create(java.lang.String text)

Creates a new TextSymbol object that includes only the text.

Parameters:

text - - Text string for display in the graphics layer.

Returns:

TextSymbol

create

public static TextSymbol create(java.lang.String text,
                Font font,
                Color color)

Creates a new TextSymbol object.

Parameters:

text - - Text string for display in the graphics layer.

font - - Font for displaying text.

color - - Symbol color.

Returns:

TextSymbol

create

public static TextSymbol create(com.google.gwt.core.client.JavaScriptObject json)

Creates a new TextSymbol object using a JSON object.

Parameters:

json - - JSON object representing the text symbol.

Returns:

TextSymbol

getAlign

public final TextSymbol.AlignType getAlign()

The text alignment in relation to the point. Default value: ALIGN_MIDDLE

Returns:

AlignType

getAngle

public final int getAngle()

Text angle. 0 is horizontal and the angle moves clockwise.

Returns:

int

getDecoration

public final TextSymbol.DecorationType getDecoration()

The decoration on the text. Default value: DECORATION_NONE

Returns:

DecorationType

getFont

public final Font getFont()

Font for displaying text.

Returns:

Font

hasKerning

public final boolean hasKerning()

Determines whether to adjust the spacing between characters in the text string. Default value: true

Returns:

boolean

isRotated

public final boolean isRotated()

Determines whether every character in the text string is rotated.

Returns:

boolean

getText

public final java.lang.String getText()

Text string for display in the graphics layer.

Returns:

String

getXOffset

public final int getXOffset()

The offset on the x-axis in pixels from the point. Default value: 0

Returns:

int

getYOffset

public final int getYOffset()

The offset on the y-axis in pixels from the point. Default value: 0

Returns:

int

setAlign

public final TextSymbol setAlign(TextSymbol.AlignType align)

Sets the alignment of the text.

Parameters:

align - - The text alignment.

Returns:

TextSymbol

setAngle

public final TextSymbol setAngle(int angle)

Sets the angle of the text.

Parameters:

angle - - Angle value between 0 and 359.

Returns:

TextSymbol

setDecoration

public final TextSymbol setDecoration(TextSymbol.DecorationType decoration)

Sets the decoration for the text.Many browsers including Internet Explorer 7, Firefox and Opera 9 do not support the decoration properties for text symbols.

Parameters:

decoration - - The decoration on the text.

Returns:

TextSymbol

setFont

public final TextSymbol setFont(Font font)

Sets the text font.

Parameters:

font - - Text font.

Returns:

TextSymbol

setKerning

public final TextSymbol setKerning(boolean kerning)

Sets whether to adjust the spacing between characters in the text string.

Parameters:

kerning - - Set to true for kerning.

Returns:

TextSymbol

setOffset

public final TextSymbol setOffset(int x,
                   int y)

Sets the x and y offset of the text.

Parameters:

x - - X offset value in pixels.

y - - Y offset value in pixels.

Returns:

TextSymbol

setRotated

public final TextSymbol setRotated(boolean rotated)

Sets whether every character in the text string is rotated. Many browsers including Internet Explorer 7, Firefox and Opera 9 do not support rotated for text symbols.

Parameters:

rotated - - Set to true to rotate all characters in the string.

Returns:

TextSymbol

setText

public final TextSymbol setText(java.lang.String text)

Sets the text string.

Parameters:

text - - The text string.

Returns:

TextSymbol