org.jfree.chart.title
Class TextTitle

java.lang.Object
  extended byorg.jfree.chart.title.Title
      extended byorg.jfree.chart.title.TextTitle
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable
Direct Known Subclasses:
DateTitle

public class TextTitle
extends Title
implements java.io.Serializable, java.lang.Cloneable

A standard chart title.

Author:
David Berry
See Also:
Serialized Form

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 org.jfree.chart.title.Title
BOTTOM, CENTER, DEFAULT_HORIZONTAL_ALIGNMENT, DEFAULT_POSITION, DEFAULT_SPACER, DEFAULT_VERTICAL_ALIGNMENT, EAST, LEFT, MIDDLE, NORTH, RIGHT, SOUTH, TOP, WEST
 
Constructor Summary
TextTitle()
          Creates a new title, using default attributes where necessary.
TextTitle(java.lang.String text)
          Creates a new title, using default attributes where necessary.
TextTitle(java.lang.String text, java.awt.Font font)
          Creates a new title, using default attributes where necessary.
TextTitle(java.lang.String text, java.awt.Font font, org.jfree.ui.HorizontalAlignment horizontalAlignment)
          Creates a new title, using default attributes where necessary.
TextTitle(java.lang.String text, java.awt.Font font, java.awt.Paint paint)
          Creates a new title, using default attributes where necessary.
TextTitle(java.lang.String text, java.awt.Font font, java.awt.Paint paint, org.jfree.ui.RectangleEdge position, org.jfree.ui.HorizontalAlignment horizontalAlignment, org.jfree.ui.VerticalAlignment 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).
 void drawHorizontal(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D area)
          Draws a horizontal title.
 void drawVertical(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D area)
          Draws a horizontal title.
 boolean equals(java.lang.Object obj)
          Tests this title for equality with another object.
 java.awt.Paint getBackgroundPaint()
          Returns the background paint.
 java.awt.Font getFont()
          Returns the font used to display the title string.
 java.awt.Paint getPaint()
          Returns the paint used to display the title string.
 float getPreferredHeight(java.awt.Graphics2D g2, float width)
          Returns the preferred height of the title.
 float getPreferredWidth(java.awt.Graphics2D g2, float height)
          Returns the preferred width of the title.
 java.lang.String getText()
          Returns the title text.
 void setBackgroundPaint(java.awt.Paint paint)
          Sets the background paint.
 void setFont(java.awt.Font font)
          Sets the font used to display the title string.
 void setPaint(java.awt.Paint paint)
          Sets the paint used to display the title string.
 void setText(java.lang.String text)
          Sets the title to the specified text.
 
Methods inherited from class org.jfree.chart.title.Title
addChangeListener, clone, getHorizontalAlignment, getNotify, getPosition, getSpacer, getVerticalAlignment, notifyListeners, removeChangeListener, setHorizontalAlignment, setNotify, setPosition, setSpacer, setVerticalAlignment
 
Methods inherited from class java.lang.Object
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()
Creates a new title, using default attributes where necessary.


TextTitle

public TextTitle(java.lang.String text)
Creates a new title, using default attributes where necessary.

Parameters:
text - the title text.

TextTitle

public TextTitle(java.lang.String text,
                 java.awt.Font font)
Creates a new title, 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)
Creates a new title, 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,
                 org.jfree.ui.HorizontalAlignment horizontalAlignment)
Creates a new title, using default attributes where necessary.

For the horizontal alignment, use the constants (LEFT, RIGHT and CENTER) defined in the Title class.

Parameters:
text - the title text.
font - the title font.
horizontalAlignment - the horizontal alignment.

TextTitle

public TextTitle(java.lang.String text,
                 java.awt.Font font,
                 java.awt.Paint paint,
                 org.jfree.ui.RectangleEdge position,
                 org.jfree.ui.HorizontalAlignment horizontalAlignment,
                 org.jfree.ui.VerticalAlignment verticalAlignment,
                 Spacer spacer)
Constructs a TextTitle with the specified properties.

For the titlePosition, horizontalAlignment and verticalAlignment, use the constants defined in the Title class.

Parameters:
text - the text for the title (not null).
font - the title font (not null).
paint - the title color (not null).
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

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.

getFont

public java.awt.Font getFont()
Returns the font used to display the title string.

Returns:
the font.

setFont

public void setFont(java.awt.Font font)
Sets the font used to display the title string. Registered listeners are notified that the title has been modified.

Parameters:
font - the new font (null not permitted).

getPaint

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

Returns:
the paint.

setPaint

public void setPaint(java.awt.Paint paint)
Sets the paint used to display the title string. Registered listeners are notified that the title has been modified.

Parameters:
paint - the new paint (null not permitted).

getBackgroundPaint

public java.awt.Paint getBackgroundPaint()
Returns the background paint.

Returns:
the paint.

setBackgroundPaint

public void setBackgroundPaint(java.awt.Paint paint)
Sets the background paint. Registered listeners are notified that the title has been modified.

Parameters:
paint - the new background paint.

getPreferredWidth

public float getPreferredWidth(java.awt.Graphics2D g2,
                               float height)
Returns the preferred width of the title.

Specified by:
getPreferredWidth in class Title
Parameters:
g2 - the graphics device.
height - the height.
Returns:
the preferred width of the title.

getPreferredHeight

public float getPreferredHeight(java.awt.Graphics2D g2,
                                float width)
Returns the preferred height of the title.

Specified by:
getPreferredHeight in class Title
Parameters:
g2 - the graphics device.
width - the width.
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).

Specified by:
draw in class Title
Parameters:
g2 - the graphics device.
area - the area allocated for the title.

drawHorizontal

public void drawHorizontal(java.awt.Graphics2D g2,
                           java.awt.geom.Rectangle2D area)
Draws a horizontal title.

Parameters:
g2 - the graphics device.
area - the area for the title.

drawVertical

public void drawVertical(java.awt.Graphics2D g2,
                         java.awt.geom.Rectangle2D area)
Draws a horizontal title.

Parameters:
g2 - the graphics device.
area - the area for the title.

equals

public boolean equals(java.lang.Object obj)
Tests this title for equality with another object.

Overrides:
equals in class Title
Parameters:
obj - the object.
Returns:
true or false.