|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jfree.chart.title.Title
The base class for all chart titles. A chart can have multiple titles, appearing at the top, bottom, left or right of the chart.
Concrete implementations of this class will render text and images, and hence do the actual work of drawing titles.
Field Summary | |
static int |
BOTTOM
Useful constant for the title position (also used for vertical alignment). |
static int |
CENTER
Useful constant for the title alignment (horizontal or vertical). |
static org.jfree.ui.HorizontalAlignment |
DEFAULT_HORIZONTAL_ALIGNMENT
The default horizontal alignment. |
static org.jfree.ui.RectangleEdge |
DEFAULT_POSITION
The default title position. |
static Spacer |
DEFAULT_SPACER
Default title spacer. |
static org.jfree.ui.VerticalAlignment |
DEFAULT_VERTICAL_ALIGNMENT
The default vertical alignment. |
static int |
EAST
Useful constant for the title position. |
static int |
LEFT
Useful constant for the title position (also used for horizontal alignment). |
static int |
MIDDLE
Useful constant for the title alignment (horizontal or vertical). |
static int |
NORTH
Useful constant for the title position. |
static int |
RIGHT
Useful constant for the title position (also used for horizontal alignment). |
static int |
SOUTH
Useful constant for the title position. |
static int |
TOP
Useful constant for the title position (also used for vertical alignment). |
static int |
WEST
Useful constant for the title position. |
Constructor Summary | |
protected |
Title()
Creates a new title, using default attributes where necessary. |
protected |
Title(org.jfree.ui.RectangleEdge position,
org.jfree.ui.HorizontalAlignment horizontalAlignment,
org.jfree.ui.VerticalAlignment verticalAlignment)
Creates a new title, using default attributes where necessary. |
protected |
Title(org.jfree.ui.RectangleEdge position,
org.jfree.ui.HorizontalAlignment horizontalAlignment,
org.jfree.ui.VerticalAlignment verticalAlignment,
Spacer spacer)
Constructs a new Title. |
Method Summary | |
void |
addChangeListener(TitleChangeListener listener)
Registers an object for notification of changes to the title. |
java.lang.Object |
clone()
Returns a clone of the title. |
abstract 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). |
boolean |
equals(java.lang.Object obj)
Tests an object for equality with this title. |
org.jfree.ui.HorizontalAlignment |
getHorizontalAlignment()
Returns the horizontal alignment of the title. |
boolean |
getNotify()
Returns the flag that indicates whether or not the notification mechanism is enabled. |
org.jfree.ui.RectangleEdge |
getPosition()
Returns the relative position of the title. |
abstract float |
getPreferredHeight(java.awt.Graphics2D g2,
float width)
Returns the preferred height of the title. |
abstract float |
getPreferredWidth(java.awt.Graphics2D g2,
float height)
Returns the preferred width of the title. |
Spacer |
getSpacer()
Returns the spacer which determines the blank space around the edges of the title. |
org.jfree.ui.VerticalAlignment |
getVerticalAlignment()
Returns the vertical alignment of the title. |
protected void |
notifyListeners(TitleChangeEvent event)
Notifies all registered listeners that the chart title has changed in some way. |
void |
removeChangeListener(TitleChangeListener listener)
Unregisters an object for notification of changes to the chart title. |
void |
setHorizontalAlignment(org.jfree.ui.HorizontalAlignment alignment)
Sets the horizontal alignment for the title, and notifies any registered listeners of the change. |
void |
setNotify(boolean flag)
Sets the flag that indicates whether or not the notification mechanism is enabled. |
void |
setPosition(org.jfree.ui.RectangleEdge position)
Sets the position for the title. |
void |
setSpacer(Spacer spacer)
Sets the spacer for the title, and notifies registered listeners of the change. |
void |
setVerticalAlignment(org.jfree.ui.VerticalAlignment alignment)
Sets the vertical alignment for the title, and notifies any registered listeners of the change. |
Methods inherited from class java.lang.Object |
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int TOP
public static final int BOTTOM
public static final int RIGHT
public static final int LEFT
public static final int NORTH
public static final int SOUTH
public static final int EAST
public static final int WEST
public static final int CENTER
public static final int MIDDLE
public static final org.jfree.ui.RectangleEdge DEFAULT_POSITION
public static final org.jfree.ui.HorizontalAlignment DEFAULT_HORIZONTAL_ALIGNMENT
public static final org.jfree.ui.VerticalAlignment DEFAULT_VERTICAL_ALIGNMENT
public static final Spacer DEFAULT_SPACER
Constructor Detail |
protected Title()
protected Title(org.jfree.ui.RectangleEdge position, org.jfree.ui.HorizontalAlignment horizontalAlignment, org.jfree.ui.VerticalAlignment verticalAlignment)
position
- the position of the title.horizontalAlignment
- the horizontal alignment of the title.verticalAlignment
- the vertical alignment of the title.protected Title(org.jfree.ui.RectangleEdge position, org.jfree.ui.HorizontalAlignment horizontalAlignment, org.jfree.ui.VerticalAlignment verticalAlignment, Spacer spacer)
This class defines constants for the valid position and alignment values --- an IllegalArgumentException will be thrown if invalid values are passed to this constructor.
position
- the position of the title.horizontalAlignment
- the horizontal alignment of the title (LEFT, CENTER or RIGHT).verticalAlignment
- the vertical alignment of the title (TOP, MIDDLE or BOTTOM).spacer
- the amount of space to leave around the outside of the title.Method Detail |
public org.jfree.ui.RectangleEdge getPosition()
public void setPosition(org.jfree.ui.RectangleEdge position)
position
- the relative position of the title.public org.jfree.ui.HorizontalAlignment getHorizontalAlignment()
public void setHorizontalAlignment(org.jfree.ui.HorizontalAlignment alignment)
alignment
- the new horizontal alignment.public org.jfree.ui.VerticalAlignment getVerticalAlignment()
public void setVerticalAlignment(org.jfree.ui.VerticalAlignment alignment)
alignment
- the new vertical alignment (TOP, MIDDLE or BOTTOM).public Spacer getSpacer()
null
).public void setSpacer(Spacer spacer)
spacer
- the new spacer.public boolean getNotify()
public void setNotify(boolean flag)
flag
- the new value of the flag.public abstract float getPreferredWidth(java.awt.Graphics2D g2, float height)
g2
- the graphics device.height
- the height.
public abstract float getPreferredHeight(java.awt.Graphics2D g2, float width)
g2
- the graphics device.width
- the width.
public abstract void draw(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D area)
g2
- the graphics device.area
- the area allocated for the title.public java.lang.Object clone()
One situation when this is useful is when editing the title properties - you can edit a clone, and then it is easier to cancel the changes if necessary.
public void addChangeListener(TitleChangeListener listener)
listener
- the object that is being registered.public void removeChangeListener(TitleChangeListener listener)
listener
- the object that is being unregistered.protected void notifyListeners(TitleChangeEvent event)
event
- an object that contains information about the change to the title.public boolean equals(java.lang.Object obj)
obj
- the object.
true
or false
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |