Home » jcommon-1.0.13 » org.jfree » chart » title » [javadoc | source]

org.jfree.chart.title
abstract public class: Title [javadoc | source]

java.lang.Object
   org.jfree.chart.block.AbstractBlock
      org.jfree.chart.title.Title

All Implemented Interfaces:
    Cloneable, Serializable, Block

Direct Known Subclasses:
    TextTitle, ImageTitle, CompositeTitle, ShortTextTitle, PaintScaleLegend, LegendTitle, DateTitle

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
public static final  RectangleEdge	DEFAULT_POSITION	The default title position.
public static final  HorizontalAlignment	DEFAULT_HORIZONTAL_ALIGNMENT	The default horizontal alignment.
public static final  VerticalAlignment	DEFAULT_VERTICAL_ALIGNMENT	The default vertical alignment.
public static final  RectangleInsets	DEFAULT_PADDING	Default title padding.

Constructor:
protected Title() { this(Title.DEFAULT_POSITION, Title.DEFAULT_HORIZONTAL_ALIGNMENT, Title.DEFAULT_VERTICAL_ALIGNMENT, Title.DEFAULT_PADDING); } Creates a new title, using default attributes where necessary.
protected Title(RectangleEdge position, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment) { this(position, horizontalAlignment, verticalAlignment, Title.DEFAULT_PADDING); } Creates a new title, using default attributes where necessary. Parameters: position - the position of the title (null not permitted). horizontalAlignment - the horizontal alignment of the title (null not permitted). verticalAlignment - the vertical alignment of the title (null not permitted).
protected Title(RectangleEdge position, HorizontalAlignment horizontalAlignment, VerticalAlignment verticalAlignment, RectangleInsets padding) { // check arguments... if (position == null) { throw new IllegalArgumentException("Null 'position' argument."); } if (horizontalAlignment == null) { throw new IllegalArgumentException( "Null 'horizontalAlignment' argument."); } if (verticalAlignment == null) { throw new IllegalArgumentException( "Null 'verticalAlignment' argument."); } if (padding == null) { throw new IllegalArgumentException("Null 'spacer' argument."); } this.position = position; this.horizontalAlignment = horizontalAlignment; this.verticalAlignment = verticalAlignment; setPadding(padding); this.listenerList = new EventListenerList(); this.notify = true; } Creates a new title. Parameters: position - the position of the title (null not permitted). horizontalAlignment - the horizontal alignment of the title (LEFT, CENTER or RIGHT, null not permitted). verticalAlignment - the vertical alignment of the title (TOP, MIDDLE or BOTTOM, null not permitted). padding - the amount of space to leave around the outside of the title (null not permitted).

Method from org.jfree.chart.title.Title Summary:
addChangeListener,   clone,   draw,   equals,   getHorizontalAlignment,   getNotify,   getPosition,   getVerticalAlignment,   hashCode,   notifyListeners,   removeChangeListener,   setHorizontalAlignment,   setNotify,   setPosition,   setVerticalAlignment

Methods from org.jfree.chart.block.AbstractBlock:

arrange,   arrange,   calculateTotalHeight,   calculateTotalWidth,   clone,   drawBorder,   equals,   getBorder,   getBounds,   getContentXOffset,   getContentYOffset,   getFrame,   getHeight,   getID,   getMargin,   getPadding,   getWidth,   setBorder,   setBorder,   setBounds,   setFrame,   setHeight,   setID,   setMargin,   setMargin,   setPadding,   setPadding,   setWidth,   toContentConstraint,   trimBorder,   trimMargin,   trimPadding,   trimToContentHeight,   trimToContentWidth

Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

Method from org.jfree.chart.title.Title Detail:
public void addChangeListener(TitleChangeListener listener) { this.listenerList.add(TitleChangeListener.class, listener); } Registers an object for notification of changes to the title.
public Object clone() throws CloneNotSupportedException { Title duplicate = (Title) super.clone(); duplicate.listenerList = new EventListenerList(); // RectangleInsets is immutable = > same reference in clone OK return duplicate; } 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.
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) { if (obj == this) { return true; } if (!(obj instanceof Title)) { return false; } if (!super.equals(obj)) { return false; } Title that = (Title) obj; if (this.position != that.position) { return false; } if (this.horizontalAlignment != that.horizontalAlignment) { return false; } if (this.verticalAlignment != that.verticalAlignment) { return false; } if (this.notify != that.notify) { return false; } return true; } Tests an object for equality with this title.
public HorizontalAlignment getHorizontalAlignment() { return this.horizontalAlignment; } Returns the horizontal alignment of the title.
public boolean getNotify() { return this.notify; } Returns the flag that indicates whether or not the notification mechanism is enabled.
public RectangleEdge getPosition() { return this.position; } Returns the position of the title.
public VerticalAlignment getVerticalAlignment() { return this.verticalAlignment; } Returns the vertical alignment of the title.
public int hashCode() { int result = 193; result = 37 * result + ObjectUtilities.hashCode(this.position); result = 37 * result + ObjectUtilities.hashCode(this.horizontalAlignment); result = 37 * result + ObjectUtilities.hashCode(this.verticalAlignment); return result; } Returns a hashcode for the title.
protected void notifyListeners(TitleChangeEvent event) { if (this.notify) { Object[] listeners = this.listenerList.getListenerList(); for (int i = listeners.length - 2; i >= 0; i -= 2) { if (listeners[i] == TitleChangeListener.class) { ((TitleChangeListener) listeners[i + 1]).titleChanged( event); } } } } Notifies all registered listeners that the chart title has changed in some way.
public void removeChangeListener(TitleChangeListener listener) { this.listenerList.remove(TitleChangeListener.class, listener); } Unregisters an object for notification of changes to the chart title.
public void setHorizontalAlignment(HorizontalAlignment alignment) { if (alignment == null) { throw new IllegalArgumentException("Null 'alignment' argument."); } if (this.horizontalAlignment != alignment) { this.horizontalAlignment = alignment; notifyListeners(new TitleChangeEvent(this)); } } Sets the horizontal alignment for the title and sends a TitleChangeEvent to all registered listeners.
public void setNotify(boolean flag) { this.notify = flag; if (flag) { notifyListeners(new TitleChangeEvent(this)); } } 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.
public void setPosition(RectangleEdge position) { if (position == null) { throw new IllegalArgumentException("Null 'position' argument."); } if (this.position != position) { this.position = position; notifyListeners(new TitleChangeEvent(this)); } } Sets the position for the title and sends a TitleChangeEvent to all registered listeners.
public void setVerticalAlignment(VerticalAlignment alignment) { if (alignment == null) { throw new IllegalArgumentException("Null 'alignment' argument."); } if (this.verticalAlignment != alignment) { this.verticalAlignment = alignment; notifyListeners(new TitleChangeEvent(this)); } } Sets the vertical alignment for the title, and notifies any registered listeners of the change.