stanford.androidlib.graphics

Class GLabel

java.lang.Object

stanford.androidlib.graphics.GObject

stanford.androidlib.graphics.GLabel

public class GLabel
extends GObject

The GLabel class is a graphical object whose appearance consists of a text string.

Field Summary

Fields

Modifier and Type	Field and Description
static Typeface	DEFAULT_FONT The default font used to display strings.

Constructor Summary

Constructors

Constructor and Description
GLabel() Creates a new empty GLabel object with its top-left corner at (0, 0).
GLabel(GCanvas canvas) Creates a new empty GLabel object with its top-left corner at (0, 0).
GLabel(GCanvas canvas, int id) Creates a new GLabel object at with its top-left corner (0, 0), initialized to contain the string with the specified resource ID.
GLabel(GCanvas canvas, int id, float x, float y) Creates a new GLabel object with its top-left corner at the specified position.
GLabel(GCanvas canvas, String str) Creates a new GLabel object at with its top-left corner (0, 0), initialized to contain the specified string.
GLabel(GCanvas canvas, String str, float x, float y) Creates a new GLabel object with its top-left corner at the specified position.
GLabel(int id) Creates a new GLabel object at with its top-left corner (0, 0), initialized to contain the string with the specified resource ID.
GLabel(int id, float x, float y) Creates a new GLabel object with its top-left corner at the specified position.
GLabel(String str) Creates a new GLabel object at with its top-left corner (0, 0), initialized to contain the specified string.
GLabel(String str, float x, float y) Creates a new GLabel object with its top-left corner at the specified position.

Method Summary

Modifier and Type	Method and Description
Typeface	getFont() Returns the font in which the GLabel is displayed.
float	getFontSize() Returns the font size currently used by this label.
int	getFontStyle() Returns this label's current font style.
float	getHeight() Returns the height of this string, as it appears on the display.
String	getLabel() Returns the string displayed by this object.
String	getText() Returns the string displayed by this object.
float	getWidth() Returns the width of this string, as it appears on the display.
void	paint(Canvas canvas) Implements the paint operation for this graphical object.
GLabel	setFont(String str) Changes the font used to display the GLabel as specified by the string str.
GLabel	setFont(Typeface font) Changes the font used to display the GLabel.
GLabel	setFont(Typeface font, float size) Sets this GLabel to use the given font at the given size.
GLabel	setFont(Typeface fontFamily, int style, float size) Sets this GLabel to use the given font at the given style and size.
GLabel	setFontSize(float size) Sets this label to use a font of the given size.
GLabel	setFontStyle(int style) Sets this label to use the given font style, such as TypeFace.BOLD.
GLabel	setLabel(int id) Changes the string stored within the GLabel object, so that a new text string appears on the display.
GLabel	setLabel(String str) Changes the string stored within the GLabel object, so that a new text string appears on the display.
GLabel	setText(int id) Changes the string stored within the GLabel object, so that a new text string appears on the display.
GLabel	setText(String str) Changes the string stored within the GLabel object, so that a new text string appears on the display.

Methods inherited from class stanford.androidlib.graphics.GObject

addTo, addTo, addTo, contains, contains, getBottomY, getBounds, getCenterX, getCenterY, getColor, getFillColor, getGCanvas, getLeftX, getLocation, getPaint, getRightX, getSize, getTopY, getX, getY, intersects, isFilled, isVisible, moveBy, moveByPolar, moveTo, moveTo, moveTo, moveToPolar, remove, repaint, scale, scale, sendBackward, sendForward, sendToBack, sendToFront, setBottomY, setBounds, setBounds, setBounds, setCanvas, setColor, setFillColor, setFilled, setGCanvas, setLocation, setLocation, setLocation, setPaint, setRightX, setSize, setSize, setVisible, setX, setY, toString, translate

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FONT

public static final Typeface DEFAULT_FONT

The default font used to display strings. You can change the font by invoking the setFont method.

Constructor Detail

GLabel

public GLabel()

Creates a new empty GLabel object with its top-left corner at (0, 0).

Usage:

GLabel glabel = new GLabel();

GLabel

public GLabel(String str)

Creates a new GLabel object at with its top-left corner (0, 0), initialized to contain the specified string.

Parameters:

str - The initial contents of the GLabel

Usage:

GLabel glabel = new GLabel(str);

GLabel

public GLabel(String str,
              float x,
              float y)

Creates a new GLabel object with its top-left corner at the specified position.

Parameters:

str - The initial contents of the GLabel

x - The x-coordinate of the label origin

y - The y-coordinate of the baseline for the label

Throws:

NullPointerException - if str is null

Usage:

GLabel glabel = new GLabel(str, x, y);

GLabel

public GLabel(@StringRes
              int id)

Creates a new GLabel object at with its top-left corner (0, 0), initialized to contain the string with the specified resource ID.

Parameters:

id - The resource ID of the initial contents of the GLabel

Usage:

GLabel glabel = new GLabel(id);

GLabel

public GLabel(@StringRes
              int id,
              float x,
              float y)

Creates a new GLabel object with its top-left corner at the specified position.

Parameters:

id - The ID of the resource string for the initial contents of the GLabel

x - The x-coordinate of the label origin

y - The y-coordinate of the baseline for the label

Throws:

NullPointerException - if no string found for given resource ID

Usage:

GLabel glabel = new GLabel(str, x, y);

GLabel

public GLabel(GCanvas canvas)

Creates a new empty GLabel object with its top-left corner at (0, 0).

Usage:

GLabel glabel = new GLabel();

GLabel

public GLabel(GCanvas canvas,
              String str)

Creates a new GLabel object at with its top-left corner (0, 0), initialized to contain the specified string.

Parameters:

str - The initial contents of the GLabel

Usage:

GLabel glabel = new GLabel(str);

GLabel

public GLabel(GCanvas canvas,
              String str,
              float x,
              float y)

Creates a new GLabel object with its top-left corner at the specified position.

Parameters:

str - The initial contents of the GLabel

x - The x-coordinate of the label origin

y - The y-coordinate of the baseline for the label

Throws:

NullPointerException - if str is null

Usage:

GLabel glabel = new GLabel(str, x, y);

GLabel

public GLabel(GCanvas canvas,
              @StringRes
              int id)

Creates a new GLabel object at with its top-left corner (0, 0), initialized to contain the string with the specified resource ID.

Parameters:

id - The resource ID of the initial contents of the GLabel

Usage:

GLabel glabel = new GLabel(id);

GLabel

public GLabel(GCanvas canvas,
              @StringRes
              int id,
              float x,
              float y)

Creates a new GLabel object with its top-left corner at the specified position.

Parameters:

id - The ID of the resource string for the initial contents of the GLabel

x - The x-coordinate of the label origin

y - The y-coordinate of the baseline for the label

Throws:

NullPointerException - if no string found for given resource ID

Usage:

GLabel glabel = new GLabel(str, x, y);

Method Detail

getFont

public Typeface getFont()

Returns the font in which the GLabel is displayed.

Returns:

The font in use by this object

Usage:

Font font = glabel.getFont();

getFontStyle

public int getFontStyle()

Returns this label's current font style.

getLabel

public String getLabel()

Returns the string displayed by this object.

Returns:

The string displayed by this object

Usage:

String str = glabel.getLabel();

getText

public String getText()

Returns the string displayed by this object.

Returns:

The string displayed by this object

Usage:

String str = glabel.getText();

paint

public void paint(Canvas canvas)

Implements the paint operation for this graphical object. This method is not called directly by clients.

Specified by:

paint in class GObject

Throws:

NullPointerException - if canvas is null

Noshow:

getWidth

public float getWidth()

Returns the width of this string, as it appears on the display.

Overrides:

getWidth in class GObject

Returns:

The width of this object

Usage:

float width = glabel.getWidth();

getHeight

public float getHeight()

Returns the height of this string, as it appears on the display.

Overrides:

getHeight in class GObject

Returns:

The height of this string

Usage:

float height = glabel.getHeight();

getFontSize

public float getFontSize()

Returns the font size currently used by this label.

setFontStyle

public GLabel setFontStyle(int style)

Sets this label to use the given font style, such as TypeFace.BOLD.

Throws:

IllegalArgumentException - if style is not a valid font style

setFont

public GLabel setFont(Typeface font)

Changes the font used to display the GLabel. This call will usually change the size of the displayed object and will therefore affect the result of calls to getSize and getBounds.

Parameters:

font - A Font object indicating the new font

Throws:

NullPointerException - if font is null

Usage:

glabel.setFont(font);

setFont

public GLabel setFont(Typeface font,
                      float size)

Sets this GLabel to use the given font at the given size.

Throws:

IllegalArgumentException - if size is 0 or negative

NullPointerException - if font is null

setFont

public GLabel setFont(Typeface fontFamily,
                      int style,
                      float size)

Sets this GLabel to use the given font at the given style and size.

Throws:

IllegalArgumentException - if size is 0 or negative, or style is not a valid font style

NullPointerException - if font family is null

setFont

public GLabel setFont(String str)

Changes the font used to display the GLabel as specified by the string str.

Parameters:

str - A String specifying the new font

Throws:

NullPointerException - if the string is null

Usage:

glabel.setFont(str);

setFontSize

public GLabel setFontSize(float size)

Sets this label to use a font of the given size.

Throws:

IllegalArgumentException - if size is 0 or negative

setLabel

public GLabel setLabel(@StringRes
                       int id)

Changes the string stored within the GLabel object, so that a new text string appears on the display.

Parameters:

id - The new string to display's resource ID

Usage:

glabel.setLabel(R.string.someID);

setLabel

public GLabel setLabel(String str)

Changes the string stored within the GLabel object, so that a new text string appears on the display.

Parameters:

str - The new string to display

Throws:

NullPointerException - if string is null

Usage:

glabel.setLabel(str);

setText

public GLabel setText(@StringRes
                      int id)

Changes the string stored within the GLabel object, so that a new text string appears on the display.

Parameters:

id - The new string to display's ID

Usage:

glabel.setText(R.string.someID);

setText

public GLabel setText(String str)

Changes the string stored within the GLabel object, so that a new text string appears on the display.

Parameters:

str - The new string to display

Throws:

NullPointerException - if string is null

Usage:

glabel.setText(str);