com.jrefinery.chart
Class TextTitle

java.lang.Object
  |
  +--com.jrefinery.chart.AbstractTitle
        |
        +--com.jrefinery.chart.TextTitle
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
DateTitle

public class TextTitle
extends AbstractTitle

A standard chart title.

Author:
DG

Field Summary
static java.awt.Font DEFAULT_FONT
          The default font.
static java.awt.Paint DEFAULT_TEXT_PAINT
          The default text color.
 
Fields inherited from class com.jrefinery.chart.AbstractTitle
BOTTOM, CENTER, DEFAULT_HORIZONTAL_ALIGNMENT, DEFAULT_POSITION, DEFAULT_SPACER, DEFAULT_VERTICAL_ALIGNMENT, EAST, LEFT, MIDDLE, NORTH, RIGHT, SOUTH, TOP, WEST
 
Constructor Summary
TextTitle(java.lang.String text)
          Constructs a new TextTitle, using default attributes where necessary.
TextTitle(java.lang.String text, java.awt.Font font)
          Constructs a new TextTitle, using default attributes where necessary.
TextTitle(java.lang.String text, java.awt.Font font, int horizontalAlignment)
          Constructs a new TextTitle, using default attributes where necessary.
TextTitle(java.lang.String text, java.awt.Font font, java.awt.Paint paint)
          Constructs a new TextTitle, using default attributes where necessary.
TextTitle(java.lang.String text, java.awt.Font font, java.awt.Paint paint, int position, int horizontalAlignment, int verticalAlignment, Spacer spacer)
          Constructs a TextTitle with the specified properties.
 
Method Summary
 void draw(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D area)
          Draws the title on a Java 2D graphics device (such as the screen or a printer).
protected  void drawHorizontal(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D area)
          Draws the title on a Java 2D graphics device (such as the screen or a printer).
 java.awt.Font getFont()
          Returns the title font.
 java.awt.Paint getPaint()
          Returns the paint used to display the title.
 double getPreferredHeight(java.awt.Graphics2D g2)
          Returns the preferred height of the title.
 double getPreferredWidth(java.awt.Graphics2D g2)
          Returns the preferred width of the title.
 java.lang.String getText()
          Returns the title text.
 boolean isValidPosition(int position)
          Returns true for the positions that are valid for TextTitle (TOP and BOTTOM for now) and false for all other positions.
 void setFont(java.awt.Font font)
          Sets the title font to the specified font and notifies registered listeners that the title has been modified.
 void setPaint(java.awt.Paint paint)
          Sets the Paint used to display the title and notifies registered listeners that the title has been modified.
 void setText(java.lang.String text)
          Sets the title to the specified text.
 
Methods inherited from class com.jrefinery.chart.AbstractTitle
addChangeListener, clone, getHorizontalAlignment, getNotify, getPosition, getSpacer, getVerticalAlignment, isValidHorizontalAlignment, isValidVerticalAlignment, notifyListeners, removeChangeListener, setHorizontalAlignment, setNotify, setPosition, setSpacer, setVerticalAlignment
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_FONT

public static final java.awt.Font DEFAULT_FONT
The default font.

DEFAULT_TEXT_PAINT

public static final java.awt.Paint DEFAULT_TEXT_PAINT
The default text color.
Constructor Detail

TextTitle

public TextTitle(java.lang.String text)
Constructs a new TextTitle, using default attributes where necessary.
Parameters:
text - the title text.

TextTitle

public TextTitle(java.lang.String text,
                 java.awt.Font font)
Constructs a new TextTitle, using default attributes where necessary.
Parameters:
text - the title text.
font - the title font.

TextTitle

public TextTitle(java.lang.String text,
                 java.awt.Font font,
                 java.awt.Paint paint)
Constructs a new TextTitle, using default attributes where necessary.
Parameters:
text - the title text.
font - the title font.
paint - the title color.

TextTitle

public TextTitle(java.lang.String text,
                 java.awt.Font font,
                 int horizontalAlignment)
Constructs a new TextTitle, using default attributes where necessary.
Parameters:
text - the title text.
font - the title font.
horizontalAlignment - the horizontal alignment (use the constants defined in AbstractTitle).

TextTitle

public TextTitle(java.lang.String text,
                 java.awt.Font font,
                 java.awt.Paint paint,
                 int position,
                 int horizontalAlignment,
                 int verticalAlignment,
                 Spacer spacer)
Constructs a TextTitle with the specified properties.

For the titlePosition, horizontalAlignment and verticalAlignment, you can use constants defined in the AbstractTitle class.

Parameters:
text - the text for the title.
font - the title font.
paint - the title color.
position - the title position.
horizontalAlignment - the horizontal alignment.
verticalAlignment - the vertical alignment.
spacer - the space to leave around the outside of the title.
Method Detail

getFont

public java.awt.Font getFont()
Returns the title font.
Returns:
the font.

setFont

public void setFont(java.awt.Font font)
Sets the title font to the specified font and notifies registered listeners that the title has been modified.
Parameters:
font - the new font.

getPaint

public java.awt.Paint getPaint()
Returns the paint used to display the title.
Returns:
the paint.

setPaint

public void setPaint(java.awt.Paint paint)
Sets the Paint used to display the title and notifies registered listeners that the title has been modified.
Parameters:
paint - the new paint.

getText

public java.lang.String getText()
Returns the title text.
Returns:
the text.

setText

public void setText(java.lang.String text)
Sets the title to the specified text. This method notifies registered listeners that the title has been modified.
Parameters:
text - the new text.

isValidPosition

public boolean isValidPosition(int position)
Returns true for the positions that are valid for TextTitle (TOP and BOTTOM for now) and false for all other positions.
Overrides:
isValidPosition in class AbstractTitle
Parameters:
position - the position.
Returns:
true if position is TOP or BOTTOM.

getPreferredWidth

public double getPreferredWidth(java.awt.Graphics2D g2)
Returns the preferred width of the title.
Overrides:
getPreferredWidth in class AbstractTitle
Parameters:
g2 - the graphics device.
Returns:
the preferred width of the title.

getPreferredHeight

public double getPreferredHeight(java.awt.Graphics2D g2)
Returns the preferred height of the title.
Overrides:
getPreferredHeight in class AbstractTitle
Parameters:
g2 - the graphics device.
Returns:
the preferred height of the title.

draw

public void draw(java.awt.Graphics2D g2,
                 java.awt.geom.Rectangle2D area)
Draws the title on a Java 2D graphics device (such as the screen or a printer).
Overrides:
draw in class AbstractTitle
Parameters:
g2 - the graphics device.
area - the area within which the title (and plot) should be drawn.

drawHorizontal

protected void drawHorizontal(java.awt.Graphics2D g2,
                              java.awt.geom.Rectangle2D area)
Draws the title on a Java 2D graphics device (such as the screen or a printer).
Parameters:
g2 - the graphics device.
area - the area within which the title should be drawn.