acm.graphics.GLabel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of javakarel Show documentation
Show all versions of javakarel Show documentation
This the original Stanford Karel for Java, packaged for Maven. ACM Library is included. See also https://cs.stanford.edu/people/eroberts/karel-the-robot-learns-java.pdf
The newest version!
/*
* @(#)GLabel.java 1.99.1 08/12/08
*/
// ************************************************************************
// * Copyright (c) 2008 by the Association for Computing Machinery *
// * *
// * The Java Task Force seeks to impose few restrictions on the use of *
// * these packages so that users have as much freedom as possible to *
// * use this software in constructive ways and can make the benefits of *
// * that work available to others. In view of the legal complexities *
// * of software development, however, it is essential for the ACM to *
// * maintain its copyright to guard against attempts by others to *
// * claim ownership rights. The full text of the JTF Software License *
// * is available at the following URL: *
// * *
// * http://www.acm.org/jtf/jtf-software-license.pdf *
// * *
// ************************************************************************
// REVISION HISTORY
//
// -- V2.0 --
// Feature enhancement 26-May-08 (ESR)
// 1. Added support for serialization.
package acm.graphics;
import acm.util.*;
import java.awt.*;
/* Class: GLabel */
/**
* The GLabel class is a graphical object whose appearance
* consists of a text string.
*/
public class GLabel extends GObject {
/* Constant: DEFAULT_FONT */
/**
* The default font used to display strings. You can change the font by invoking
* the setFont method.
*/
public static final Font DEFAULT_FONT = new Font("Default", Font.PLAIN, 12);
/* Constructor: GLabel(str, x, y) */
/**
* Creates a new GLabel object initialized to contain the specified string.
*
* Example: GLabel glabel = new GLabel(str);
* @param str The initial contents of the GLabel
*/
public GLabel(String str) {
this(str, 0, 0);
}
/* Constructor: GLabel(str, x, y) */
/**
* Creates a new GLabel object with its baseline origin at the
* specified position.
*
* Example: GLabel glabel = new GLabel(str, x, y);
* @param str The initial contents of the GLabel
* @param x The x-coordinate of the label origin
* @param y The y-coordinate of the baseline for the label
*/
public GLabel(String str, double x, double y) {
label = str;
setFont(DEFAULT_FONT);
setLocation(x, y);
}
/* Method: setFont(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.
*
* Example: glabel.setFont(font);
* @param font A Font object indicating the new font
*/
public void setFont(Font font) {
labelFont = JTFTools.getStandardFont(font);
repaint();
}
/* Method: setFont(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.
*
* Example: glabel.setFont(str);
* @param str A String specifying the new font
*/
public void setFont(String str) {
setFont(JTFTools.decodeFont(str, getFont()));
}
/* Method: getFont() */
/**
* Returns the font in which the GLabel is displayed.
*
* Example: Font font = glabel.getFont();
* @return The font in use by this object
*/
public Font getFont() {
return labelFont;
}
/* Method: setLabel(str) */
/**
* Changes the string stored within the GLabel object, so that
* a new text string appears on the display.
*
* Example: glabel.setLabel(str);
* @param str The new string to display
*/
public void setLabel(String str) {
label = str;
repaint();
}
/* Method: getLabel() */
/**
* Returns the string displayed by this object.
*
* Example: String str = glabel.getLabel();
* @return The string displayed by this object
*/
public String getLabel() {
return label;
}
/* Method: paint(g) */
/**
* Implements the paint operation for this graphical object. This method
* is not called directly by clients.
*
*/
public void paint(Graphics g) {
g.setFont(labelFont);
g.drawString(label, GMath.round(getX()), GMath.round(getY()));
}
/* Method: getWidth() */
/**
* Returns the width of this string, as it appears on the display.
*
* Example: double width = glabel.getWidth();
* @return The width of this object
*/
public double getWidth() {
return getFontMetrics().stringWidth(label);
}
/* Method: getHeight() */
/**
* Returns the height of this string, as it appears on the display.
*
* Example: double height = glabel.getHeight();
* @return The height of this string
*/
public double getHeight() {
return getFontMetrics().getHeight();
}
/* Method: getAscent() */
/**
* Returns the distance this string extends above the baseline.
*
* Example: double ascent = glabel.getAscent();
* @return The ascent of this string in pixels
*/
public double getAscent() {
return getFontMetrics().getAscent();
}
/* Method: getDescent() */
/**
* Returns the distance this string descends below the baseline.
*
* Example: double descent = glabel.getDescent();
* @return The descent of this string in pixels
*/
public double getDescent() {
return getFontMetrics().getDescent();
}
/* Method: getFontMetrics() */
/**
* Returns a FontMetrics object describing the dimensions of this string.
*
* Example: FontMetrics fm = glabel.getFontMetrics();
* @return A FontMetrics object describing the dimensions of this string
*
*/
public FontMetrics getFontMetrics() {
Component comp = getComponent();
if (comp == null) comp = DUMMY_COMPONENT;
return comp.getFontMetrics(labelFont);
}
/* Method: getBounds() */
/**
* Returns a GRectangle that specifies the bounding box for the string.
*
* Example: GRectangle bounds = glabel.getBounds();
* @return The bounding box for this object
*/
public GRectangle getBounds() {
return new GRectangle(getX(), getY() - getAscent(), getWidth(), getHeight());
}
/* Inherited method: getSize() */
/**
* @inherited GObject#GDimension getSize()
* Returns the size of the bounding box for this object.
*/
/* Inherited method: contains(x, y) */
/**
* @inherited GObject#boolean contains(double x, double y)
* Checks to see whether a point is "inside" the string, which is defined to be
* inside the bounding rectangle.
*/
/* Inherited method: contains(pt) */
/**
* @inherited GObject#boolean contains(GPoint pt)
* Checks to see whether a point is inside the object.
*/
/* Inherited method: setLocation(x, y) */
/**
* @inherited GObject#void setLocation(double x, double y)
* Sets the location of the GLabel to the point (x, y).
* For a GLabel, the location is the point on the text baseline at which the
* text starts.
*/
/* Inherited method: setLocation(pt) */
/**
* @inherited GObject#void setLocation(GPoint pt)
* Sets the location of this object to the specified point.
*/
/* Inherited method: getLocation() */
/**
* @inherited GObject#GPoint getLocation()
* Returns the location of the GLabel as a GPoint object.
*/
/* Inherited method: getX() */
/**
* @inherited GObject#double getX()
* Returns the x-coordinate of the object.
*/
/* Inherited method: getY() */
/**
* @inherited GObject#double getY()
* Returns the y-coordinate of the object.
*/
/* Inherited method: move(dx, dy) */
/**
* @inherited GObject#void move(double dx, double dy)
* Moves the object on the screen using the displacements dx and dy.
*/
/* Inherited method: movePolar(r, theta) */
/**
* @inherited GObject#void movePolar(double r, double theta)
* Moves the object using displacements given in polar coordinates.
*/
/* Inherited method: sendToFront() */
/**
* @inherited GObject#void sendToFront()
* Moves this object to the front of the display in the z dimension.
*/
/* Inherited method: sendToBack() */
/**
* @inherited GObject#void sendToBack()
* Moves this object to the back of the display in the z dimension.
*/
/* Inherited method: sendForward() */
/**
* @inherited GObject#void sendForward()
* Moves this object one step toward the front in the z dimension.
*/
/* Inherited method: sendBackward() */
/**
* @inherited GObject#void sendBackward()
* Moves this object one step toward the back in the z dimension.
*/
/* Inherited method: setColor(color) */
/**
* @inherited GObject#void setColor(Color color)
* Sets the color used to display the text of the GLabel.
*/
/* Inherited method: getColor() */
/**
* @inherited GObject#Color getColor()
* Returns the color used to display the text of the GLabel.
*/
/* Inherited method: setVisible(visible) */
/**
* @inherited GObject#void setVisible(boolean visible)
* Sets the visibility status of the GLabel.
*/
/* Inherited method: isVisible() */
/**
* @inherited GObject#boolean isVisible()
* Checks to see whether the GLabel is visible.
*/
/* Inherited method: addMouseListener(listener) */
/**
* @inherited GObject#void addMouseListener(MouseListener listener)
* Adds a mouse listener to this graphical object.
*/
/* Inherited method: removeMouseListener(listener) */
/**
* @inherited GObject#void removeMouseListener(MouseListener listener)
* Removes a mouse listener from this graphical object.
*/
/* Inherited method: addMouseMotionListener(listener) */
/**
* @inherited GObject#void addMouseMotionListener(MouseMotionListener listener)
* Adds a mouse motion listener to this graphical object.
*/
/* Inherited method: removeMouseMotionListener(listener) */
/**
* @inherited GObject#void removeMouseMotionListener(MouseMotionListener listener)
* Removes a mouse motion listener from this graphical object.
*/
/* Protected method: paramString() */
/**
* Returns a string indicating the parameters of this object.
*
*/
public String paramString() {
return super.paramString() + ", string=\"" + label + "\"";
}
/* Private instance variables */
private String label;
private Font labelFont;
private static final Component DUMMY_COMPONENT = MediaTools.getImageObserver();
/* Serial version UID */
/**
* The serialization code for this class. This value should be incremented
* whenever you change the structure of this class in an incompatible way,
* typically by adding a new instance variable.
*/
static final long serialVersionUID = 1L;
}