acm.graphics

Class GLabel

java.lang.Object

acm.graphics.GObject

acm.graphics.GLabel

All Implemented Interfaces:

GScalable, Serializable, Cloneable

public class GLabel
extends GObject

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

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
GLabel(String str) Creates a new GLabel object initialized to contain the specified string.
GLabel(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
boolean	contains(double x, double y) Returns true if this label contains the given x/y point.
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.
Font	getFont() Returns the font in which the GLabel is displayed.
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.
String	getLabel() Returns the string displayed by this object.
String	getText() Returns the string displayed by this object.
double	getWidth() Returns the width of this string, as it appears on the display.
void	paint2d(Graphics2D g) Implements the paint2d operation for this graphical object.
String	paramString() Returns a string indicating the parameters of this object.
void	setBottomY(double bottomY) Sets the bottom y-coordinate of this object to the given y value.
void	setCenterLocation(double centerX, double centerY) Sets the central x/y-coordinates of this object to the given x/y values.
void	setCenterY(double centerY) Sets the central y-coordinate of this object to the given y value.
void	setFont(Font font) Changes the font used to display the GLabel.
void	setFont(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(String str) 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.
void	setTopY(double topY) Sets the top y-coordinate of this object to the given y value.

Methods inherited from class acm.graphics.GObject

addActionListener, addMouseListener, addMouseMotionListener, areMouseListenersEnabled, clone, colorName, colorName, colorNameFriendly, contains, createTransformedGraphics, fireActionEvent, fireActionEvent, fireMouseListeners, getBottomY, getCenterLocation, getCenterX, getCenterY, getColor, getComponent, getLineWidth, getLocation, getMatrix, getObjectColor, getParent, getRightX, getSize, getX, getY, intersects, isAntiAliasing, isVisible, move, movePolar, paint, pause, removeActionListener, removeMouseListener, removeMouseMotionListener, repaint, rotate, scale, scale, sendBackward, sendForward, sendToBack, sendToFront, setAntiAliasing, setCenterLocation, setCenterX, setColor, setLineWidth, setLocation, setLocation, setParent, setRightX, setVisible, setX, setY, start, start, toString, updateEnabledList

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FONT

public static final Font DEFAULT_FONT

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

Constructor Detail

GLabel

public GLabel(String str)

Creates a new GLabel object 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,
              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

Usage:

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

Method Detail

contains

public boolean contains(double x,
                        double y)

Returns true if this label contains the given x/y point.

Overrides:

contains in class GObject

Parameters:

x - the x-coordinate to check

y - the y-coordinate to check

Returns:

true if this label contains the given x/y point

getAscent

public double getAscent()

Returns the distance this string extends above the baseline.

Returns:

The ascent of this string in pixels

Usage:

double ascent = glabel.getAscent();

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

Usage:

GRectangle bounds = glabel.getBounds();

getDescent

public double getDescent()

Returns the distance this string descends below the baseline.

Returns:

The descent of this string in pixels

Usage:

double descent = glabel.getDescent();

getFont

public Font getFont()

Returns the font in which the GLabel is displayed.

Returns:

The font in use by this object

Usage:

Font font = glabel.getFont();

getFontMetrics

public FontMetrics getFontMetrics()

Returns a FontMetrics object describing the dimensions of this string.

Returns:

A FontMetrics object describing the dimensions of this string

Usage:

FontMetrics fm = glabel.getFontMetrics();

Noshow:

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

Usage:

double height = glabel.getHeight();

getLabel

public String getLabel()

Returns the string displayed by this object. Equivalent to getText.

Returns:

The string displayed by this object

Usage:

String str = glabel.getLabel();

getText

public String getText()

Returns the string displayed by this object. Equivalent to getLabel.

Returns:

The string displayed by this object

Usage:

String str = glabel.getLabel();

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

Usage:

double width = glabel.getWidth();

paint2d

public void paint2d(Graphics2D g)

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

Specified by:

paint2d in class GObject

Parameters:

g - The graphics context into which the painting is done

Noshow:

paramString

public String paramString()

Returns a string indicating the parameters of this object.

Overrides:

paramString in class GObject

Noshow:

setBottomY

public void setBottomY(double bottomY)

Sets the bottom y-coordinate of this object to the given y value. Since labels use y-positioning relative to their bottom, not the top, this is equivalent to calling setY().

Overrides:

setBottomY in class GObject

Parameters:

bottomY - The new bottom y-coordinate for the object

Usage:

gobj.setBottomY(y);

setCenterLocation

public void setCenterLocation(double centerX,
                              double centerY)

Sets the central x/y-coordinates of this object to the given x/y values.

Overrides:

setCenterLocation in class GObject

Parameters:

centerX - The new central x-coordinate for the object

centerY - The new central y-coordinate for the object

Usage:

gobj.setCenterLocation(x, y);

setCenterY

public void setCenterY(double centerY)

Sets the central y-coordinate of this object to the given y value.

Overrides:

setCenterY in class GObject

Parameters:

centerY - The new central y-coordinate for the object

Usage:

gobj.setCenterY(y);

setFont

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

Usage:

glabel.setFont(font);

setFont

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

Usage:

glabel.setFont(str);

setLabel

public void setLabel(String str)

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

Parameters:

str - The new string to display

Usage:

glabel.setLabel(str);

setText

public void setText(String str)

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

Parameters:

str - The new string to display

Usage:

glabel.setText(str);

setTopY

public void setTopY(double topY)

Sets the top y-coordinate of this object to the given y value. Since labels use y-positioning relative to their bottom, not the top, this is equivalent to calling setY() and shifting downward by the label's height.

Parameters:

bottomY - The new top y-coordinate for the object

Usage:

gobj.setBottomY(y);