Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart.title

Class PaintScaleLegend

Implemented Interfaces:
Cloneable, Drawable, PublicCloneable, Block, Serializable
public class PaintScaleLegend
extends Title
implements PublicCloneable
A legend that shows a range of values and their associated colors, driven by an underlying PaintScale implementation.
Since:
1.0.4

Field Summary

Fields inherited from class org.jfree.chart.title.Title

DEFAULT_HORIZONTAL_ALIGNMENT, DEFAULT_PADDING, DEFAULT_POSITION, DEFAULT_VERTICAL_ALIGNMENT

Constructor Summary

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

Method Summary

Size2D
arrange(Graphics2D g2, RectangleConstraint constraint)
Arranges the contents of the block, within the given constraints, and returns the block size.
protected Size2D
arrangeRR(Graphics2D g2, Range widthRange, Range heightRange)
Returns the content size for the title.
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.
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.

Methods inherited from class org.jfree.chart.title.Title

addChangeListener, clone, draw, equals, getHorizontalAlignment, getNotify, getPosition, getVerticalAlignment, hashCode, notifyListeners, removeChangeListener, setHorizontalAlignment, setNotify, setPosition, setVerticalAlignment

Methods inherited from class 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

Constructor Details

PaintScaleLegend

public PaintScaleLegend(PaintScale scale,
                        ValueAxis axis)
Creates a new instance.
Parameters:
scale - the scale (null not permitted).
axis - the axis (null not permitted).

Method Details

arrange

public Size2D arrange(Graphics2D g2,
                      RectangleConstraint constraint)
Arranges the contents of the block, within the given constraints, and returns the block size.
Specified by:
arrange in interface Block
Overrides:
arrange in interface AbstractBlock
Parameters:
g2 - the graphics device.
constraint - the constraint (null not permitted).
Returns:
The block size (in Java2D units, never null).

arrangeRR

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.

draw

public void draw(Graphics2D g2,
                 Rectangle2D area)
Draws the legend within the specified area.
Overrides:
draw in interface Title
Parameters:
g2 - the graphics target (null not permitted).
area - the drawing area (null not permitted).

draw

public Object draw(Graphics2D g2,
                   Rectangle2D area,
                   Object params)
Draws the legend within the specified area.
Specified by:
draw in interface Block
Parameters:
g2 - the graphics target (null not permitted).
area - the drawing area (null not permitted).
params - drawing parameters (ignored here).
Returns:
null.

equals

public boolean equals(Object obj)
Tests this legend for equality with an arbitrary object.
Overrides:
equals in interface Title
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getAxis

public ValueAxis getAxis()
Returns the axis for the paint scale.
Returns:
The axis (never null).
See Also:
setAxis(ValueAxis)

getAxisLocation

public AxisLocation getAxisLocation()
Returns the axis location.
Returns:
The axis location (never null).
See Also:
setAxisLocation(AxisLocation)

getAxisOffset

public double getAxisOffset()
Returns the offset between the axis and the paint strip.
Returns:
The offset between the axis and the paint strip.
See Also:
setAxisOffset(double)

getBackgroundPaint

public Paint getBackgroundPaint()
Returns the background paint.
Returns:
The background paint.

getScale

public PaintScale getScale()
Returns the scale used to convert values to colors.
Returns:
The scale (never null).
See Also:
setScale(PaintScale)

getStripOutlinePaint

public Paint getStripOutlinePaint()
Returns the paint used to draw the outline of the paint strip.
Returns:
The paint (never null).
See Also:
setStripOutlinePaint(Paint)

getStripOutlineStroke

public Stroke getStripOutlineStroke()
Returns the stroke used to draw the outline around the paint strip.
Returns:
The stroke (never null).
See Also:
setStripOutlineStroke(Stroke)

getStripWidth

public double getStripWidth()
Returns the width of the paint strip, in Java2D units.
Returns:
The width of the paint strip.
See Also:
setStripWidth(double)

isStripOutlineVisible

public boolean isStripOutlineVisible()
Returns the flag that controls whether or not an outline is drawn around the paint strip.
Returns:
A boolean.
See Also:
setStripOutlineVisible(boolean)

setAxis

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).
See Also:
getAxis()

setAxisLocation

public void setAxisLocation(AxisLocation location)
Sets the axis location and sends a TitleChangeEvent to all registered listeners.
Parameters:
location - the location (null not permitted).
See Also:
getAxisLocation()

setAxisOffset

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.

setBackgroundPaint

public void setBackgroundPaint(Paint paint)
Sets the background paint and sends a TitleChangeEvent to all registered listeners.
Parameters:
paint - the paint (null permitted).

setScale

public void setScale(PaintScale scale)
Sets the scale and sends a TitleChangeEvent to all registered listeners.
Parameters:
scale - the scale (null not permitted).
See Also:
getScale()

setStripOutlinePaint

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).
See Also:
getStripOutlinePaint()

setStripOutlineStroke

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).
See Also:
getStripOutlineStroke()

setStripOutlineVisible

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.
See Also:
isStripOutlineVisible()

setStripWidth

public void setStripWidth(double width)
Sets the width of the paint strip and sends a TitleChangeEvent to all registered listeners.
Parameters:
width - the width.
See Also:
getStripWidth()

Overview Package Class Use Source Tree Index Deprecated About