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(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.
void	setFont(String str) Changes the font used to display the GLabel as specified by the string str.
void	setFont(Typeface font) Changes the font used to display the GLabel.
void	setFont(Typeface font, float size) Sets this GLabel to use the given font at the given size.
void	setFont(Typeface fontFamily, int style, float size) Sets this GLabel to use the given font at the given style and size.
void	setFontSize(float size) Sets this label to use a font of the given size.
void	setFontStyle(int style) Sets this label to use the given font style, such as TypeFace.BOLD.
void	setLabel(int id) Changes the string stored within the GLabel object, so that a new text string appears on the display.
void	setLabel(String str) Changes the string stored within the GLabel object, so that a new text string appears on the display.
void	setText(int id) Changes the string stored within the GLabel object, so that a new text string appears on the display.
void	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

contains, contains, getBottomY, getBounds, getCenterX, getCenterY, getColor, getGCanvas, getLocation, getPaint, getRightX, getSize, getX, getY, intersects, isVisible, moveBy, moveByPolar, moveTo, moveTo, moveToPolar, repaint, sendBackward, sendForward, sendToBack, sendToFront, setBottomY, setCanvas, setColor, setGCanvas, setLocation, setLocation, setPaint, setRightX, 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

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

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

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 void setFontStyle(int style)

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

setFont

public void 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

Usage:

glabel.setFont(font);

setFont

public void setFont(Typeface font,
                    float size)

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

setFont

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

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

setFont

public void 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

Usage:

glabel.setFont(str);

setFontSize

public void setFontSize(float size)

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

setLabel

public void 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 void 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

Usage:

glabel.setLabel(str);

setText

public void 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 void 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

Usage:

glabel.setText(str);