public class

PaintScaleLegend

extends Title
implements AxisChangeListener

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

Class Overview

A legend that shows a range of values and their associated colors, driven by an underlying PaintScale implementation.

Summary

[Expand]

Inherited Fields

From class org.jfree.chart.title.Title

Public Constructors
	PaintScaleLegend(PaintScale scale, ValueAxis axis) Creates a new instance.

Public Methods
Size2D	arrange(Graphics2D g2, RectangleConstraint constraint) Arranges the contents of the block, within the given constraints, and returns the block size.
void	axisChanged(AxisChangeEvent event) Receives notification of an axis change event and responds by firing a title change event.
void	draw(Graphics2D g2, Rectangle2D area) Draws the legend within the specified area.
Object	draw(Graphics2D g2, Rectangle2D area, Object params) Draws the legend within the specified area.
boolean	equals(Object obj) Tests this legend for equality with an arbitrary object.
ValueAxis	getAxis() Returns the axis for the paint scale.
AxisLocation	getAxisLocation() Returns the axis location.
double	getAxisOffset() Returns the offset between the axis and the paint strip.
Paint	getBackgroundPaint() Returns the background paint.
PaintScale	getScale() Returns the scale used to convert values to colors.
Paint	getStripOutlinePaint() Returns the paint used to draw the outline of the paint strip.
Stroke	getStripOutlineStroke() Returns the stroke used to draw the outline around the paint strip.
double	getStripWidth() Returns the width of the paint strip, in Java2D units.
int	getSubdivisionCount() Returns the number of subdivisions used to draw the scale.
boolean	isStripOutlineVisible() Returns the flag that controls whether or not an outline is drawn around the paint strip.
void	setAxis(ValueAxis axis) Sets the axis for the paint scale and sends a `TitleChangeEvent` to all registered listeners.
void	setAxisLocation(AxisLocation location) Sets the axis location and sends a `TitleChangeEvent` to all registered listeners.
void	setAxisOffset(double offset) Sets the offset between the axis and the paint strip and sends a `TitleChangeEvent` to all registered listeners.
void	setBackgroundPaint(Paint paint) Sets the background paint and sends a `TitleChangeEvent` to all registered listeners.
void	setScale(PaintScale scale) Sets the scale and sends a `TitleChangeEvent` to all registered listeners.
void	setStripOutlinePaint(Paint paint) Sets the paint used to draw the outline of the paint strip, and sends a `TitleChangeEvent` to all registered listeners.
void	setStripOutlineStroke(Stroke stroke) Sets the stroke used to draw the outline around the paint strip and sends a `TitleChangeEvent` to all registered listeners.
void	setStripOutlineVisible(boolean visible) Sets the flag that controls whether or not an outline is drawn around the paint strip, and sends a `TitleChangeEvent` to all registered listeners.
void	setStripWidth(double width) Sets the width of the paint strip and sends a `TitleChangeEvent` to all registered listeners.
void	setSubdivisionCount(int count) Sets the subdivision count and sends a `TitleChangeEvent` to all registered listeners.

Protected Methods
Size2D	arrangeRR(Graphics2D g2, Range widthRange, Range heightRange) Returns the content size for the title.

[Expand]

Inherited Methods

From class org.jfree.chart.title.Title

void	addChangeListener(TitleChangeListener listener) Registers an object for notification of changes to the title.
Object	clone() Returns a clone of the title.
abstract void	draw(Graphics2D g2, Rectangle2D area) Draws the title on a Java 2D graphics device (such as the screen or a printer).
boolean	equals(Object obj) Tests an object for equality with this title.
HorizontalAlignment	getHorizontalAlignment() Returns the horizontal alignment of the title.
boolean	getNotify() Returns the flag that indicates whether or not the notification mechanism is enabled.
RectangleEdge	getPosition() Returns the position of the title.
VerticalAlignment	getVerticalAlignment() Returns the vertical alignment of the title.
int	hashCode() Returns a hashcode for the title.
boolean	isVisible() Returns a flag that controls whether or not the title should be drawn.
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(HorizontalAlignment alignment) Sets the horizontal alignment for the title and sends a `TitleChangeEvent` to all registered listeners.
void	setNotify(boolean flag) Sets the flag that indicates whether or not the notification mechanism is enabled.
void	setPosition(RectangleEdge position) Sets the position for the title and sends a `TitleChangeEvent` to all registered listeners.
void	setVerticalAlignment(VerticalAlignment alignment) Sets the vertical alignment for the title, and notifies any registered listeners of the change.
void	setVisible(boolean visible) Sets a flag that controls whether or not the title should be drawn, and sends a `TitleChangeEvent` to all registered listeners.

From class org.jfree.chart.block.AbstractBlock

Size2D	arrange(Graphics2D g2) Arranges the contents of the block, with no constraints, and returns the block size.
Size2D	arrange(Graphics2D g2, RectangleConstraint constraint) Arranges the contents of the block, within the given constraints, and returns the block size.
double	calculateTotalHeight(double contentHeight) Adds the margin, border and padding to the specified content height.
double	calculateTotalWidth(double contentWidth) Adds the margin, border and padding to the specified content width.
Object	clone() Returns a clone of this block.
void	drawBorder(Graphics2D g2, Rectangle2D area) Draws the border around the perimeter of the specified area.
boolean	equals(Object obj) Tests this block for equality with an arbitrary object.
BlockBorder	getBorder() This method is deprecated. Use `getFrame()` instead.
Rectangle2D	getBounds() Returns the current bounds of the block.
double	getContentXOffset() Returns the x-offset for the content within the block.
double	getContentYOffset() Returns the y-offset for the content within the block.
BlockFrame	getFrame() Returns the current frame (border).
double	getHeight() Returns the natural height of the block, if this is known in advance.
String	getID() Returns the id.
RectangleInsets	getMargin() Returns the margin.
RectangleInsets	getPadding() Returns the padding.
double	getWidth() Returns the natural width of the block, if this is known in advance.
void	setBorder(BlockBorder border) This method is deprecated. Use `setFrame(BlockFrame)` instead.
void	setBorder(double top, double left, double bottom, double right) Sets a black border with the specified line widths.
void	setBounds(Rectangle2D bounds) Sets the bounds of the block.
void	setFrame(BlockFrame frame) Sets the frame (or border).
void	setHeight(double height) Sets the natural width of the block, if this is known in advance.
void	setID(String id) Sets the id for the block.
void	setMargin(RectangleInsets margin) Sets the margin (use RectangleInsets#ZERO_INSETS for no padding).
void	setMargin(double top, double left, double bottom, double right) Sets the margin.
void	setPadding(double top, double left, double bottom, double right) Sets the padding.
void	setPadding(RectangleInsets padding) Sets the padding (use RectangleInsets#ZERO_INSETS for no padding).
void	setWidth(double width) Sets the natural width of the block, if this is known in advance.
RectangleConstraint	toContentConstraint(RectangleConstraint c) Returns a constraint for the content of this block that will result in the bounds of the block matching the specified constraint.
Rectangle2D	trimBorder(Rectangle2D area) Reduces the specified area by the amount of space consumed by the border.
Rectangle2D	trimMargin(Rectangle2D area) Reduces the specified area by the amount of space consumed by the margin.
Rectangle2D	trimPadding(Rectangle2D area) Reduces the specified area by the amount of space consumed by the padding.
double	trimToContentHeight(double fixedHeight) Calculate the height available for content after subtracting the margin, border and padding space from the specified fixed height.
double	trimToContentWidth(double fixedWidth) Calculate the width available for content after subtracting the margin, border and padding space from the specified fixed width.

From class java.lang.Object

From interface org.jfree.chart.block.Block

From interface org.jfree.chart.event.AxisChangeListener

Public Constructors

public PaintScaleLegend (PaintScale scale, ValueAxis axis)

Creates a new instance.

Parameters

scale	the scale (`null` not permitted).
axis	the axis (`null` not permitted).

Public Methods

public Size2D arrange (Graphics2D g2, RectangleConstraint constraint)

Arranges the contents of the block, within the given constraints, and returns the block size.

Parameters

g2	the graphics device.
constraint	the constraint (`null` not permitted).

Returns

The block size (in Java2D units, never null).

public void axisChanged (AxisChangeEvent event)

Receives notification of an axis change event and responds by firing a title change event.

Parameters

event	the event.

public void draw (Graphics2D g2, Rectangle2D area)

Draws the legend within the specified area.

Parameters

g2	the graphics target (`null` not permitted).
area	the drawing area (`null` not permitted).

public Object draw (Graphics2D g2, Rectangle2D area, Object params)

Draws the legend within the specified area.

Parameters

g2	the graphics target (`null` not permitted).
area	the drawing area (`null` not permitted).
params	drawing parameters (ignored here).

Returns

null.

public boolean equals (Object obj)

Tests this legend for equality with an arbitrary object.

Parameters

obj	the object (`null` permitted).

Returns

A boolean.

public ValueAxis getAxis ()

Returns the axis for the paint scale.

Returns

The axis (never null).

public AxisLocation getAxisLocation ()

Returns the axis location.

Returns

The axis location (never null).

public double getAxisOffset ()

Returns the offset between the axis and the paint strip.

Returns

The offset between the axis and the paint strip.

public Paint getBackgroundPaint ()

Returns the background paint.

Returns

The background paint.

public PaintScale getScale ()

Returns the scale used to convert values to colors.

Returns

The scale (never null).

public Paint getStripOutlinePaint ()

Returns the paint used to draw the outline of the paint strip.

Returns

The paint (never null).

public Stroke getStripOutlineStroke ()

Returns the stroke used to draw the outline around the paint strip.

Returns

The stroke (never null).

public double getStripWidth ()

Returns the width of the paint strip, in Java2D units.

Returns

The width of the paint strip.

public int getSubdivisionCount ()

Returns the number of subdivisions used to draw the scale.

Returns

The subdivision count.

public boolean isStripOutlineVisible ()

Returns the flag that controls whether or not an outline is drawn around the paint strip.

Returns

A boolean.

public void setAxis (ValueAxis axis)

Sets the axis for the paint scale and sends a TitleChangeEvent to all registered listeners.

Parameters

axis	the axis (`null` not permitted).

public void setAxisLocation (AxisLocation location)

Sets the axis location and sends a TitleChangeEvent to all registered listeners.

Parameters

location	the location (`null` not permitted).

public void setAxisOffset (double offset)

Sets the offset between the axis and the paint strip and sends a TitleChangeEvent to all registered listeners.

Parameters

offset	the offset.

public void setBackgroundPaint (Paint paint)

Sets the background paint and sends a TitleChangeEvent to all registered listeners.

Parameters

paint	the paint (`null` permitted).

public void setScale (PaintScale scale)

Sets the scale and sends a TitleChangeEvent to all registered listeners.

Parameters

scale	the scale (`null` not permitted).

public void setStripOutlinePaint (Paint paint)

Sets the paint used to draw the outline of the paint strip, and sends a TitleChangeEvent to all registered listeners.

Parameters

paint	the paint (`null` not permitted).

public void setStripOutlineStroke (Stroke stroke)

Sets the stroke used to draw the outline around the paint strip and sends a TitleChangeEvent to all registered listeners.

Parameters

stroke	the stroke (`null` not permitted).

public void setStripOutlineVisible (boolean visible)

Sets the flag that controls whether or not an outline is drawn around the paint strip, and sends a TitleChangeEvent to all registered listeners.

Parameters

visible	the flag.

public void setStripWidth (double width)

Sets the width of the paint strip and sends a TitleChangeEvent to all registered listeners.

Parameters

width	the width.

public void setSubdivisionCount (int count)

Sets the subdivision count and sends a TitleChangeEvent to all registered listeners.

Parameters

count	the count.

Protected Methods

protected Size2D arrangeRR (Graphics2D g2, Range widthRange, Range heightRange)

Returns the content size for the title. This will reflect the fact that a text title positioned on the left or right of a chart will be rotated 90 degrees.

Parameters

g2	the graphics device.
widthRange	the width range.
heightRange	the height range.

Returns

The content size.

Classes

PaintScaleLegend

Class Overview

Summary

Public Constructors

public PaintScaleLegend (PaintScale scale, ValueAxis axis)

Parameters

Public Methods

public Size2D arrange (Graphics2D g2, RectangleConstraint constraint)

Parameters

Returns

public void axisChanged (AxisChangeEvent event)

Parameters

public void draw (Graphics2D g2, Rectangle2D area)

Parameters

public Object draw (Graphics2D g2, Rectangle2D area, Object params)

Parameters

Returns

public boolean equals (Object obj)

Parameters

Returns

public ValueAxis getAxis ()

Returns

See Also

public AxisLocation getAxisLocation ()

Returns

See Also

public double getAxisOffset ()

Returns

See Also

public Paint getBackgroundPaint ()

Returns

public PaintScale getScale ()

Returns

See Also

public Paint getStripOutlinePaint ()

Returns

See Also

public Stroke getStripOutlineStroke ()

Returns

See Also

public double getStripWidth ()

Returns

See Also

public int getSubdivisionCount ()

Returns

public boolean isStripOutlineVisible ()

Returns

See Also

public void setAxis (ValueAxis axis)

Parameters

See Also

public void setAxisLocation (AxisLocation location)

Parameters

See Also

public void setAxisOffset (double offset)

Parameters

public void setBackgroundPaint (Paint paint)

Parameters

public void setScale (PaintScale scale)

Parameters

See Also

public void setStripOutlinePaint (Paint paint)

Parameters

See Also

public void setStripOutlineStroke (Stroke stroke)

Parameters

See Also

public void setStripOutlineVisible (boolean visible)

Parameters

See Also

public void setStripWidth (double width)

Parameters

See Also

public void setSubdivisionCount (int count)

Parameters

Protected Methods

protected Size2D arrangeRR (Graphics2D g2, Range widthRange, Range heightRange)

Parameters

Returns