at.ofai.music.plot

Class Text

java.lang.Object

at.ofai.music.plot.PlottableObject

at.ofai.music.plot.Text

Direct Known Subclasses:

Label, Title

public class Text
extends PlottableObject

Text object of the WG at.ofai.music.plot package. Prints texts on the axes either in axes coordinates or in relative position within the axes panel.

Author:

Werner Goebl, Aug. 2005

See Also:

Figure, Axes

Field Summary

Fields

Modifier and Type	Field and Description
protected java.text.AttributedString	attStr
protected double[]	extent
protected java.lang.String	fontName
protected float	fontSize
protected float	fontStyle
protected java.lang.String	horizontalAlignment
protected int	isLabel
protected boolean	isNormalized
protected double	margin
protected double[]	position
protected double	rotation
protected java.lang.String	string
protected java.lang.String	verticalAlignment

Fields inherited from class at.ofai.music.plot.PlottableObject

ax, color, defaultColor, defaultLineStyle, defaultLineWidth, edgeColor, faceColor, lineStyle, lineWidth

Constructor Summary

Constructors

Constructor and Description
Text(double x, double y, java.lang.String string) Creates a Text object containing the specified string at the user coordinates x, y into the current Axes of the current Figure.
Text(double x, double y, java.lang.String string, Axes ax) Creates a Text object containing the specified string at the user coordinates x, y into the specified Axes object.
Text(double x, double y, java.lang.String string, Axes ax, int isLabel) Creates a Text object containing the specified string at the user coordinates x, y into the specified Axes object.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	cutOut(java.lang.String str, int index) General purpose routine: Returns a string with one element (at position index) cut out.
double[]	getExtent()
java.lang.String	getFontName() Returns the name of the font.
float	getFontSize() Returns the font size (float).
float	getFontStyle()
java.lang.String	getHorizontalAlignment() Gets the horizontalAlignment of the text object as String: left (default) - center - right.
protected int	getIsLabel()
double	getMargin()
double[]	getPosition()
double	getRotation()
java.lang.String	getString() Returns string of text object.
java.lang.String	getVerticalAlignment() Gets the horizontalAlignment of the text object as String: bottom - baseline (default) - middle - top.
boolean	isNormalized()
protected boolean	isXLg()
protected boolean	isYLg()
protected static void	out(java.lang.String str)
protected static void	outn(java.lang.String str)
void	paint(java.awt.Graphics2D g) The paint method of Text object.
void	setExtent(double[] extent)
void	setFontName(java.lang.String fontName) Sets the name of the font (e.g., "Helvethica").
void	setFontSize(float fontSize) Sets the font size (default = 12f).
void	setFontStyle(float fontStyle) Sets the fontStyle of the text (TextAttribute).
void	setHorizontalAlignment(java.lang.String horizontalAlignment) Sets the horizontalAlignment of the text object as String: left (default) - center - right.
protected void	setIsLabel(int isLabel) isLabel specifies what type of label the text object is:
void	setMargin(double margin)
void	setNormalized(boolean isNormalized) Sets the x, y coordinates relative to axes.
void	setPosition(double[] pos) Sets the position (double[2] x y) of the text.
void	setRotation(double rotation) Sets the text object's rotation in degrees (0--360) counterclockwise.
void	setString(java.lang.String str) Sets the string of the Text object.
void	setVerticalAlignment(java.lang.String verticalAlignment) Sets the horizontalAlignment of the text object as String: bottom - baseline (default) - middle - top.
static java.text.AttributedString	stringToAttString(java.lang.String str) Converts a String to an AttributedString by superscripting all characters following a "^" and subscripting all after a "_", very much like in LaTeX.

Methods inherited from class at.ofai.music.plot.PlottableObject

dashdotted, dashed, dotted, getAxes, getColor, getEdgeColor, getFaceColor, getLineStyle, getLineWidth, setColor, setEdgeColor, setFaceColor, setLineStyle, setLineWidth, solid

Methods inherited from class java.lang.Object

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

Field Detail

position

protected double[] position

string

protected java.lang.String string

attStr

protected java.text.AttributedString attStr

fontName

protected java.lang.String fontName

fontStyle

protected float fontStyle

fontSize

protected float fontSize

horizontalAlignment

protected java.lang.String horizontalAlignment

verticalAlignment

protected java.lang.String verticalAlignment

margin

protected double margin

extent

protected double[] extent

rotation

protected double rotation

isLabel

protected int isLabel

isNormalized

protected boolean isNormalized

Constructor Detail

Text

public Text(double x,
    double y,
    java.lang.String string)

Creates a Text object containing the specified string at the user coordinates x, y into the current Axes of the current Figure.

Parameters:

x -

y -

string -

Text

public Text(double x,
    double y,
    java.lang.String string,
    Axes ax)

Creates a Text object containing the specified string at the user coordinates x, y into the specified Axes object.

Parameters:

x -

y -

string -

ax -

Text

public Text(double x,
    double y,
    java.lang.String string,
    Axes ax,
    int isLabel)

Creates a Text object containing the specified string at the user coordinates x, y into the specified Axes object.

Parameters:

x -

y -

string -

ax -

isLabel - indicates whether the Text object is treated as a Label (Label.IS_XLABEL, Label.IS_YLABEL) or as a Title (Title.IS_TITLE) (used to create labels and title).

Method Detail

paint

public void paint(java.awt.Graphics2D g)

The paint method of Text object. Plots the attributedText in the Graphics2D environment.

Specified by:

paint in class PlottableObject

stringToAttString

public static java.text.AttributedString stringToAttString(java.lang.String str)

Converts a String to an AttributedString by superscripting all characters following a "^" and subscripting all after a "_", very much like in LaTeX.

E.g.: "10^3" or to superscript multiple characters: "10^{100}", "X_{12}"

Parameters:

str - input string.

Returns:

AttributedString with superscript and subscript attributes set.

cutOut

public static java.lang.String cutOut(java.lang.String str,
                      int index)

General purpose routine: Returns a string with one element (at position index) cut out.

Parameters:

str - input string.

index - index of element to be removed.

Returns:

String with str.length()-1.

setString

public void setString(java.lang.String str)

Sets the string of the Text object.

Parameters:

str -

getString

public java.lang.String getString()

Returns string of text object.

Returns:

String of the text object.

See Also:

setString(String)

setPosition

public void setPosition(double[] pos)

Sets the position (double[2] x y) of the text.

Parameters:

pos -

See Also:

getHorizontalAlignment(), setHorizontalAlignment(String), getVerticalAlignment(), setVerticalAlignment(String)

getPosition

public double[] getPosition()

Returns:

Returns position of text (double[2]).

See Also:

setPosition(double[])

setFontName

public void setFontName(java.lang.String fontName)

Sets the name of the font (e.g., "Helvethica").

Parameters:

fontName -

getFontName

public java.lang.String getFontName()

Returns the name of the font.

Returns:

returns the name of the font.

setFontStyle

public void setFontStyle(float fontStyle)

Sets the fontStyle of the text (TextAttribute).

Parameters:

fontStyle - The fontStyle to set.

See Also:

getFontStyle()

getFontStyle

public float getFontStyle()

Returns:

Returns the fontStyle (TextAttribute).

setFontSize

public void setFontSize(float fontSize)

Sets the font size (default = 12f).

Parameters:

fontSize -

getFontSize

public float getFontSize()

Returns the font size (float).

Returns:

returns the font size

setHorizontalAlignment

public void setHorizontalAlignment(java.lang.String horizontalAlignment)

Sets the horizontalAlignment of the text object as String: left (default) - center - right.

Parameters:

horizontalAlignment - String specifying the horizontal alignment of text object.

getHorizontalAlignment

public java.lang.String getHorizontalAlignment()

Gets the horizontalAlignment of the text object as String: left (default) - center - right.

Returns:

String specifying the horizontal alignment of text object.

setVerticalAlignment

public void setVerticalAlignment(java.lang.String verticalAlignment)

Sets the horizontalAlignment of the text object as String: bottom - baseline (default) - middle - top.

Parameters:

verticalAlignment - String specifying the vertical alignment of text object.

getVerticalAlignment

public java.lang.String getVerticalAlignment()

Gets the horizontalAlignment of the text object as String: bottom - baseline (default) - middle - top.

Returns:

String specifying the vertical alignment of text object.

setRotation

public void setRotation(double rotation)

Sets the text object's rotation in degrees (0--360) counterclockwise.

Parameters:

rotation - The rotation to set.

See Also:

getRotation()

getRotation

public double getRotation()

Returns:

Returns the rotation.

See Also:

setRotation(double)

isXLg

protected boolean isXLg()

isYLg

protected boolean isYLg()

out

protected static void out(java.lang.String str)

outn

protected static void outn(java.lang.String str)

getIsLabel

protected int getIsLabel()

Returns:

Returns the isLabel.

setIsLabel

protected void setIsLabel(int isLabel)

isLabel specifies what type of label the text object is:

Parameters:

isLabel - The isLabel to set.

isNormalized

public boolean isNormalized()

Returns:

Returns the isNormalized.

See Also:

setNormalized(boolean)

setNormalized

public void setNormalized(boolean isNormalized)

Sets the x, y coordinates relative to axes. E.g., ax.text(.1, .3, "qwer", ax); creates the text at 10% left on the x axis and 30% from the bottom of the y axis irrespective of axis orientation (Axes.setXDir(String), Axes.setYDir(String)) or location Axes.setXAxisLocation(String), Axes.setXAxisLocation(String)).

Parameters:

isNormalized - The isNormalized to set.

getExtent

public double[] getExtent()

Returns:

Returns the extent.

setExtent

public void setExtent(double[] extent)

Parameters:

extent - The extent to set.

getMargin

public double getMargin()

Returns:

Returns the margin.

setMargin

public void setMargin(double margin)

Parameters:

margin - The margin to set.