| java.lang.Object
 org.jfree.chart.block.AbstractBlock
org.jfree.chart.title.Title
All known Subclasses: org.jfree.chart.title.CompositeTitle, org.jfree.chart.title.TextTitle, org.jfree.chart.title.ImageTitle, org.jfree.chart.title.PaintScaleLegend, org.jfree.chart.title.LegendTitle,
| Title | | abstract public class Title extends AbstractBlock implements Block,Cloneable,Serializable(Code) | | 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.
|
| Constructor Summary | |
| protected | Title()
Creates a new title, using default attributes where necessary. | | protected | Title(RectangleEdge position, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment)
Creates a new title, using default attributes where necessary. | | protected | Title(RectangleEdge position, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment, RectangleInsets padding)
Creates a new title. |
| Method Summary | |
| public void | addChangeListener(TitleChangeListener listener)
Registers an object for notification of changes to the title. | | public Object | clone()
Returns a clone of the title. | | abstract public void | draw(Graphics2D g2, Rectangle2D area)
Draws the title on a Java 2D graphics device (such as the screen or a
printer). | | public boolean | equals(Object obj)
Tests an object for equality with this title.
Parameters:
obj - the object (null not permitted). | | public HorizontalAlignment | getHorizontalAlignment()
Returns the horizontal alignment of the title. | | public boolean | getNotify()
Returns the flag that indicates whether or not the notification
mechanism is enabled. | | public RectangleEdge | getPosition()
Returns the position of the title. | | public VerticalAlignment | getVerticalAlignment()
Returns the vertical alignment of the title. | | public int | hashCode()
Returns a hashcode for the title. | | protected void | notifyListeners(TitleChangeEvent event)
Notifies all registered listeners that the chart title has changed in
some way. | | public void | removeChangeListener(TitleChangeListener listener)
Unregisters an object for notification of changes to the chart title. | | public void | setHorizontalAlignment(HorizontalAlignment alignment)
Sets the horizontal alignment for the title and sends a
TitleChangeEvent to all registered listeners. | | public void | setNotify(boolean flag)
Sets the flag that indicates whether or not the notification mechanism
is enabled. | | public void | setPosition(RectangleEdge position)
Sets the position for the title and sends a
TitleChangeEvent to
all registered listeners. | | public void | setVerticalAlignment(VerticalAlignment alignment)
Sets the vertical alignment for the title, and notifies any registered
listeners of the change. |
| DEFAULT_HORIZONTAL_ALIGNMENT | | final public static HorizontalAlignment DEFAULT_HORIZONTAL_ALIGNMENT(Code) | | The default horizontal alignment.
|
| DEFAULT_PADDING | | final public static RectangleInsets DEFAULT_PADDING(Code) | | Default title padding.
|
| DEFAULT_POSITION | | final public static RectangleEdge DEFAULT_POSITION(Code) | | The default title position.
|
| DEFAULT_VERTICAL_ALIGNMENT | | final public static VerticalAlignment DEFAULT_VERTICAL_ALIGNMENT(Code) | | The default vertical alignment.
|
| Title | | protected Title()(Code) | | Creates a new title, using default attributes where necessary.
|
| Title | | protected Title(RectangleEdge position, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment)(Code) | | Creates a new title, using default attributes where necessary.
Parameters:
position - the position of the title (null not permitted).
Parameters:
horizontalAlignment - the horizontal alignment of the title (null not permitted).
Parameters:
verticalAlignment - the vertical alignment of the title (null not permitted). |
| Title | | protected Title(RectangleEdge position, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment, RectangleInsets padding)(Code) | | Creates a new title.
Parameters:
position - the position of the title (null not permitted).
Parameters:
horizontalAlignment - the horizontal alignment of the title (LEFT,CENTER or RIGHT, null not permitted).
Parameters:
verticalAlignment - the vertical alignment of the title (TOP, MIDDLE or BOTTOM, null not permitted).
Parameters:
padding - the amount of space to leave around the outside of the title (null not permitted). |
| addChangeListener | | public void addChangeListener(TitleChangeListener listener)(Code) | | Registers an object for notification of changes to the title.
Parameters:
listener - the object that is being registered. |
| clone | | public Object clone() throws CloneNotSupportedException(Code) | | Returns a clone of the title.
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.
A clone of the title.
throws:
CloneNotSupportedException - not thrown by this class, but it may be thrown by subclasses. |
| draw | | abstract public void draw(Graphics2D g2, Rectangle2D area)(Code) | | Draws the title on a Java 2D graphics device (such as the screen or a
printer).
Parameters:
g2 - the graphics device.
Parameters:
area - the area allocated for the title (subclasses should notdraw outside this area). |
| equals | | public boolean equals(Object obj)(Code) | | Tests an object for equality with this title.
Parameters:
obj - the object (null not permitted). true or false. |
| getHorizontalAlignment | | public HorizontalAlignment getHorizontalAlignment()(Code) | | Returns the horizontal alignment of the title.
The horizontal alignment (never null). |
| getNotify | | public boolean getNotify()(Code) | | Returns the flag that indicates whether or not the notification
mechanism is enabled.
The flag. |
| getPosition | | public RectangleEdge getPosition()(Code) | | Returns the position of the title.
The title position (never null). |
| getVerticalAlignment | | public VerticalAlignment getVerticalAlignment()(Code) | | Returns the vertical alignment of the title.
The vertical alignment (never null). |
| hashCode | | public int hashCode()(Code) | | Returns a hashcode for the title.
The hashcode. |
| notifyListeners | | protected void notifyListeners(TitleChangeEvent event)(Code) | | Notifies all registered listeners that the chart title has changed in
some way.
Parameters:
event - an object that contains information about the change to the title. |
| removeChangeListener | | public void removeChangeListener(TitleChangeListener listener)(Code) | | Unregisters an object for notification of changes to the chart title.
Parameters:
listener - the object that is being unregistered. |
| setHorizontalAlignment | | public void setHorizontalAlignment(HorizontalAlignment alignment)(Code) | | Sets the horizontal alignment for the title and sends a
TitleChangeEvent to all registered listeners.
Parameters:
alignment - the horizontal alignment (null not permitted). |
| setNotify | | public void setNotify(boolean flag)(Code) | | Sets the flag that indicates whether or not the notification mechanism
is enabled. There are certain situations (such as cloning) where you
want to turn notification off temporarily.
Parameters:
flag - the new value of the flag. |
| setPosition | | public void setPosition(RectangleEdge position)(Code) | | Sets the position for the title and sends a
TitleChangeEvent to
all registered listeners.
Parameters:
position - the position (null not permitted). |
| setVerticalAlignment | | public void setVerticalAlignment(VerticalAlignment alignment)(Code) | | Sets the vertical alignment for the title, and notifies any registered
listeners of the change.
Parameters:
alignment - the new vertical alignment (TOP, MIDDLE or BOTTOM, null not permitted). |
| Methods inherited from org.jfree.chart.block.AbstractBlock | public Size2D arrange(Graphics2D g2)(Code)(Java Doc)
public Size2D arrange(Graphics2D g2, RectangleConstraint constraint)(Code)(Java Doc)
protected double calculateTotalHeight(double contentHeight)(Code)(Java Doc)
protected double calculateTotalWidth(double contentWidth)(Code)(Java Doc)
public Object clone() throws CloneNotSupportedException(Code)(Java Doc)
protected void drawBorder(Graphics2D g2, Rectangle2D area)(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
public BlockBorder getBorder()(Code)(Java Doc)
public Rectangle2D getBounds()(Code)(Java Doc)
public double getContentXOffset()(Code)(Java Doc)
public double getContentYOffset()(Code)(Java Doc)
public BlockFrame getFrame()(Code)(Java Doc)
public double getHeight()(Code)(Java Doc)
public String getID()(Code)(Java Doc)
public RectangleInsets getMargin()(Code)(Java Doc)
public RectangleInsets getPadding()(Code)(Java Doc)
public double getWidth()(Code)(Java Doc)
public void setBorder(BlockBorder border)(Code)(Java Doc)
public void setBorder(double top, double left, double bottom, double right)(Code)(Java Doc)
public void setBounds(Rectangle2D bounds)(Code)(Java Doc)
public void setFrame(BlockFrame frame)(Code)(Java Doc)
public void setHeight(double height)(Code)(Java Doc)
public void setID(String id)(Code)(Java Doc)
public void setMargin(RectangleInsets margin)(Code)(Java Doc)
public void setMargin(double top, double left, double bottom, double right)(Code)(Java Doc)
public void setPadding(RectangleInsets padding)(Code)(Java Doc)
public void setPadding(double top, double left, double bottom, double right)(Code)(Java Doc)
public void setWidth(double width)(Code)(Java Doc)
protected RectangleConstraint toContentConstraint(RectangleConstraint c)(Code)(Java Doc)
protected Rectangle2D trimBorder(Rectangle2D area)(Code)(Java Doc)
protected Rectangle2D trimMargin(Rectangle2D area)(Code)(Java Doc)
protected Rectangle2D trimPadding(Rectangle2D area)(Code)(Java Doc)
protected double trimToContentHeight(double fixedHeight)(Code)(Java Doc)
protected double trimToContentWidth(double fixedWidth)(Code)(Java Doc)
|
|
|