Class graph.TextLine
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class graph.TextLine

java.lang.Object
   |
   +----graph.TextLine

public class TextLine
extends Object
This class is designed to bundle together all the information required to draw short Strings with subscripts and superscripts
Version:
$Revision: 1.10 $, $Date: 1996/09/05 04:53:27 $
Author:
Leigh Brookshaw

Variable Index

 o ALGEBRAIC
Format to use when parsing a double
 o ascent
The ascent using the current font
 o background
Background Color
 o CENTER
Center the Text over the point
 o color
Text color
 o descent
The descent using the current font
 o font
Font to use for text
 o fontname
The logical name of the font to use
 o fontsize
The font size
 o fontstyle
The font style
 o height
The height using the current font ie ascent+descent+leading
 o justification
Text justification.
 o leading
The leading using the current font
 o LEFT
Position the Text to the Left of the point
 o lg
Local graphics context.
 o list
The parsed string.
 o maxAscent
The maximum ascent using the current font
 o maxDescent
The maximum descent using the current font
 o parse
Has the string been parsed! This only needs to be done once unless the font is altered.
 o RIGHT
Position the Text to the Right of the point
 o SCIENTIFIC
Format to use when parsing a double
 o script_fraction
Decrease in size of successive script levels
 o sub_offset
Subscript offset
 o sup_offset
Superscript offset
 o text
The text to display
 o width
The width of the text using the current Font

Constructor Index

 o TextLine()
Instantiate the class
 o TextLine(Font, Color, int)
Instantiate the class
 o TextLine(String)
Instantiate the class.
 o TextLine(String, Color)
Instantiate the class
 o TextLine(String, Font)
Instantiate the class
 o TextLine(String, Font, Color, int)
Instantiate the class

Method Index

 o charWidth(Graphics, char)
 o copyState()
Create a New Textline object copying the state of the existing object into the new one.
 o copyState(TextLine)
Copy the state of the parsed Textline into the existing object.
 o draw(Graphics, int, int)
Parse the text then draw it without any rotation.
 o draw(Graphics, int, int, int)
Parse the text then draw it.
 o getAscent(Graphics)
 o getBackground()
 o getColor()
 o getDescent(Graphics)
 o getFM(Graphics)
 o getFont()
 o getFontName()
 o getFontSize()
 o getFontStyle()
 o getHeight(Graphics)
 o getJustification()
 o getLeading(Graphics)
 o getMaxAscent(Graphics)
 o getMaxDescent(Graphics)
 o getScriptFont(Font)
 o getText()
 o getWidth(Graphics)
 o isNull()
 o parseDouble(double)
Parse a double value.
 o parseDouble(double, int)
Parse a double value.
 o parseDouble(double, int, int, int)
Parse a double value
 o parseText(Graphics)
parse the text.
 o setBackground(Color)
Set the Background Color to use with the class
 o setColor(Color)
Set the Color to use with the class
 o setFont(Font)
Set the Font to use with the class
 o setFontName(String)
Set the Logical font name of the current font
 o setFontSize(int)
Set the Font size of the current font
 o setFontStyle(int)
Set the Font style of the current font
 o setJustification(int)
Set the Justification to use with the class
 o setText(String)
Set the String to use with the class

Variables

 o CENTER
  public final static int CENTER
Center the Text over the point
 o LEFT
  public final static int LEFT
Position the Text to the Left of the point
 o RIGHT
  public final static int RIGHT
Position the Text to the Right of the point
 o SCIENTIFIC
  public final static int SCIENTIFIC
Format to use when parsing a double
 o ALGEBRAIC
  public final static int ALGEBRAIC
Format to use when parsing a double
 o script_fraction
  protected double script_fraction
Decrease in size of successive script levels
 o sup_offset
  protected double sup_offset
Superscript offset
 o sub_offset
  protected double sub_offset
Subscript offset
 o font
  protected Font font
Font to use for text
 o color
  protected Color color
Text color
 o background
  protected Color background
Background Color
 o text
  protected String text
The text to display
 o fontname
  protected String fontname
The logical name of the font to use
 o fontsize
  protected int fontsize
The font size
 o fontstyle
  protected int fontstyle
The font style
 o justification
  protected int justification
Text justification. Either CENTER, LEFT or RIGHT
 o width
  protected int width
The width of the text using the current Font
 o ascent
  protected int ascent
The ascent using the current font
 o maxAscent
  protected int maxAscent
The maximum ascent using the current font
 o descent
  protected int descent
The descent using the current font
 o maxDescent
  protected int maxDescent
The maximum descent using the current font
 o height
  protected int height
The height using the current font ie ascent+descent+leading
 o leading
  protected int leading
The leading using the current font
 o parse
  protected boolean parse
Has the string been parsed! This only needs to be done once unless the font is altered.
 o lg
  protected Graphics lg
Local graphics context.
 o list
  protected Vector list
The parsed string. Each element in the vector represents a change of context in the string ie font change and offset.

Constructors

 o TextLine
  public TextLine()
Instantiate the class
 o TextLine
  public TextLine(String s)
Instantiate the class.
Parameters:
s - String to parse.
 o TextLine
  public TextLine(String s,
                  Font f)
Instantiate the class
Parameters:
s - String to parse.
f - Font to use.
 o TextLine
  public TextLine(String s,
                  Font f,
                  Color c,
                  int j)
Instantiate the class
Parameters:
s - String to parse.
f - Font to use.
c - Color to use
j - Justification
 o TextLine
  public TextLine(String s,
                  Color c)
Instantiate the class
Parameters:
s - String to parse.
c - Color to use
 o TextLine
  public TextLine(Font f,
                  Color c,
                  int j)
Instantiate the class
Parameters:
f - Font to use.
c - Color to use
j - Justification

Methods

 o copyState
  public TextLine copyState()
Create a New Textline object copying the state of the existing object into the new one. The state of the class is the color, font, and justification ie everything but the string.
 o copyState
  public void copyState(TextLine t)
Copy the state of the parsed Textline into the existing object.
Parameters:
t - The TextLine to get the state information from.
 o setFont
  public void setFont(Font f)
Set the Font to use with the class
Parameters:
f - Font
 o setText
  public void setText(String s)
Set the String to use with the class
Parameters:
s - String
 o setColor
  public void setColor(Color c)
Set the Color to use with the class
Parameters:
c - Color
 o setBackground
  public void setBackground(Color c)
Set the Background Color to use with the class
Parameters:
c - Color
 o setJustification
  public void setJustification(int i)
Set the Justification to use with the class
Parameters:
t - Justification
 o getFont
  public Font getFont()
Returns:
the font the class is using
 o getText
  public String getText()
Returns:
the String the class is using.
 o getColor
  public Color getColor()
Returns:
the Color the class is using.
 o getBackground
  public Color getBackground()
Returns:
the Background Color the class is using.
 o getJustification
  public int getJustification()
Returns:
the Justification the class is using.
 o getFM
  public FontMetrics getFM(Graphics g)
Parameters:
g - Graphics context.
Returns:
the Fontmetrics the class is using.
 o charWidth
  public int charWidth(Graphics g,
                       char ch)
Parameters:
g - Graphics context.
ch - The character.
Returns:
the width of the character.
 o getWidth
  public int getWidth(Graphics g)
Parameters:
g - Graphics context.
Returns:
the width of the parsed text.
 o getHeight
  public int getHeight(Graphics g)
Parameters:
g - Graphics context.
Returns:
the height of the parsed text.
 o getAscent
  public int getAscent(Graphics g)
Parameters:
g - Graphics context.
Returns:
the ascent of the parsed text.
 o getMaxAscent
  public int getMaxAscent(Graphics g)
Parameters:
g - Graphics context.
Returns:
the maximum ascent of the parsed text.
 o getDescent
  public int getDescent(Graphics g)
Parameters:
g - Graphics context.
Returns:
the descent of the parsed text.
 o getMaxDescent
  public int getMaxDescent(Graphics g)
Parameters:
g - Graphics context.
Returns:
the maximum descent of the parsed text.
 o getLeading
  public int getLeading(Graphics g)
Parameters:
g - Graphics context.
Returns:
the leading of the parsed text.
 o parseText
  public void parseText(Graphics g)
parse the text. When the text is parsed the width, height, leading are all calculated. The text will only be truly parsed if the graphics context has changed or the text has changed or the font has changed. Otherwise nothing is done when this method is called.
Parameters:
g - Graphics context.
 o isNull
  public boolean isNull()
Returns:
true if the text has never been set or is null
 o draw
  public void draw(Graphics g,
                   int x,
                   int y,
                   int j)
Parse the text then draw it.
Parameters:
g - Graphics context
x - pixel position of the text
y - pixel position of the text
j - justification of the text
 o draw
  public void draw(Graphics g,
                   int x,
                   int y)
Parse the text then draw it without any rotation.
Parameters:
g - Graphics context
x - pixel position of the text
y - pixel position of the text
 o getFontName
  public String getFontName()
Returns:
Logical font name of the set font
 o getFontStyle
  public int getFontStyle()
Returns:
Style of the set font
 o getFontSize
  public int getFontSize()
Returns:
Size of the set font
 o setFontName
  public void setFontName(String s)
Set the Logical font name of the current font
Parameters:
s - Logical font name.
 o setFontStyle
  public void setFontStyle(int i)
Set the Font style of the current font
Parameters:
i - Font style.
 o setFontSize
  public void setFontSize(int i)
Set the Font size of the current font
Parameters:
i - Font size.
 o getScriptFont
  public Font getScriptFont(Font f)
Parameters:
f - Font
Returns:
The script font version of the parsed font using the script_fraction variable.
 o parseDouble
  public boolean parseDouble(double d)
Parse a double value. Precision is 6 figures, with 7 significant figures.
Parameters:
d - double to parse return true if the parse was successful
 o parseDouble
  public boolean parseDouble(double d,
                             int p)
Parse a double value. Number of significant figures is 1 greater than the precision.
Parameters:
d - double to parse
p - precision of the number return true if the parse was successful
 o parseDouble
  public boolean parseDouble(double d,
                             int n,
                             int p,
                             int f)
Parse a double value
Parameters:
d - double to parse
n - number of significant figures
p - precision of the number
f - format of the number scientific, algebraic etc. return true if the parse was successful

All Packages  Class Hierarchy  This Package  Previous  Next  Index