acm.graphics

Class GLabel

java.lang.Object

acm.graphics.GObject

acm.graphics.GLabel

All Implemented Interfaces:

java.lang.Cloneable

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 java.awt.Font	DEFAULT_FONT The default font used to display strings.

Constructor Summary

Constructors

Constructor and Description
GLabel(java.lang.String str) Creates a new GLabel object initialized to contain the specified string.
GLabel(java.lang.String str, double x, double y) Creates a new GLabel object with its baseline origin at the specified position.

Method Summary

Modifier and Type	Method and Description
double	getAscent() Returns the distance this string extends above the baseline.
GRectangle	getBounds() Returns a GRectangle that specifies the bounding box for the string.
double	getDescent() Returns the distance this string descends below the baseline.
java.awt.Font	getFont() Returns the font in which the GLabel is displayed.
java.awt.FontMetrics	getFontMetrics() Returns a FontMetrics object describing the dimensions of this string.
double	getHeight() Returns the height of this string, as it appears on the display.
java.lang.String	getLabel() Returns the string displayed by this object.
double	getWidth() Returns the width of this string, as it appears on the display.
void	paint(java.awt.Graphics g) Implements the paint operation for this graphical object.
java.lang.String	paramString() Returns a string indicating the parameters of this object.
void	setFont(java.awt.Font font) Changes the font used to display the GLabel.
void	setFont(java.lang.String str) Changes the font used to display the GLabel as specified by the string str, which is interpreted in the style of Font.decode.
void	setLabel(java.lang.String str) Changes the string stored within the GLabel object, so that a new text string appears on the display.

Methods inherited from class acm.graphics.GObject

addActionListener, addMouseListener, addMouseMotionListener, areMouseListenersEnabled, colorName, contains, contains, fireActionEvent, fireActionEvent, fireMouseListeners, getColor, getComponent, getLocation, getObjectColor, getParent, getSize, getX, getY, isVisible, move, movePolar, paintObject, pause, removeActionListener, removeMouseListener, removeMouseMotionListener, repaint, sendBackward, sendForward, sendToBack, sendToFront, setColor, setLocation, setLocation, setParent, setVisible, start, start, toString, updateEnabledList

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FONT

public static final java.awt.Font DEFAULT_FONT

The default font used to display strings. You can change the font by invoking the setFont(Font) or setFont(String) methods.

Constructor Detail

GLabel

public GLabel(java.lang.String str)

Creates a new GLabel object initialized to contain the specified string.

Parameters:

str - The initial contents of the GLabel

GLabel

public GLabel(java.lang.String str,
              double x,
              double y)

Creates a new GLabel object with its baseline origin 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

Method Detail

setFont

public void setFont(java.awt.Font 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

setFont

public void setFont(java.lang.String str)

Changes the font used to display the GLabel as specified by the string str, which is interpreted in the style of Font.decode. The usual format of the font string is family-style-size, where both style and size are optional. If any of these parts are specified as an asterisk, the existing value is retained.

Parameters:

str - A String specifying the new font

getFont

public java.awt.Font getFont()

Returns the font in which the GLabel is displayed.

Returns:

The font in use by this object

setLabel

public void setLabel(java.lang.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

getLabel

public java.lang.String getLabel()

Returns the string displayed by this object.

Returns:

The string displayed by this object

paint

public void paint(java.awt.Graphics g)

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

Specified by:

paint in class GObject

Parameters:

g - The graphics context into which the painting is done

getWidth

public double getWidth()

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

Overrides:

getWidth in class GObject

Returns:

The width of this object

getHeight

public double getHeight()

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

Overrides:

getHeight in class GObject

Returns:

The height of this string

getAscent

public double getAscent()

Returns the distance this string extends above the baseline.

Returns:

The ascent of this string in pixels

getDescent

public double getDescent()

Returns the distance this string descends below the baseline.

Returns:

The descent of this string in pixels

getFontMetrics

public java.awt.FontMetrics getFontMetrics()

Returns a FontMetrics object describing the dimensions of this string.

Returns:

A FontMetrics object describing the dimensions of this string

getBounds

public GRectangle getBounds()

Returns a GRectangle that specifies the bounding box for the string.

Specified by:

getBounds in class GObject

Returns:

The bounding box for this object

paramString

public java.lang.String paramString()

Returns a string indicating the parameters of this object.

Overrides:

paramString in class GObject