|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.jfree.chart.Legend | +--org.jfree.chart.StandardLegend
A chart legend shows the names and visual representations of the series that are plotted in a chart.
Field Summary | |
static java.awt.Paint |
DEFAULT_BACKGROUND_PAINT
The default background paint. |
static Spacer |
DEFAULT_INNER_GAP
The default inner gap. |
static java.awt.Font |
DEFAULT_ITEM_FONT
The default item font. |
static Spacer |
DEFAULT_OUTER_GAP
The default outer gap. |
static java.awt.Paint |
DEFAULT_OUTLINE_PAINT
The default outline paint. |
static java.awt.Stroke |
DEFAULT_OUTLINE_STROKE
The default outline stroke. |
static java.awt.Font |
DEFAULT_TITLE_FONT
The default title font. |
Fields inherited from class org.jfree.chart.Legend |
EAST, HORIZONTAL, INVERTED, NORTH, SOUTH, WEST |
Constructor Summary | |
StandardLegend(JFreeChart chart)
Constructs a new legend with default settings. |
Method Summary | |
java.awt.geom.Rectangle2D |
draw(java.awt.Graphics2D g2,
java.awt.geom.Rectangle2D available)
Draws the legend on a Java 2D graphics device (such as the screen or a printer). |
protected java.awt.geom.Rectangle2D |
draw(java.awt.Graphics2D g2,
java.awt.geom.Rectangle2D available,
boolean horizontal,
boolean inverted)
Draws the legend. |
boolean |
equals(java.lang.Object obj)
Tests an object for equality with this legend. |
java.awt.Paint |
getBackgroundPaint()
Returns the background color for the legend. |
java.awt.Font |
getItemFont()
Returns the series label font. |
java.awt.Paint |
getItemPaint()
Returns the series label color. |
Spacer |
getOuterGap()
Returns the outer gap for the legend. |
java.awt.Paint |
getOutlinePaint()
Returns the outline color. |
boolean |
getOutlineShapes()
Returns the flag that indicates whether or not outlines are drawn around shapes. |
java.awt.Stroke |
getOutlineStroke()
Returns the outline pen/brush. |
java.awt.Paint |
getShapeOutlinePaint()
Returns the paint used to outline shapes. |
java.awt.Stroke |
getShapeOutlineStroke()
Returns the stroke used to outline shapes. |
java.lang.String |
getTitle()
Gets the title for the legend. |
java.awt.Font |
getTitleFont()
Returns the title font. |
void |
setBackgroundPaint(java.awt.Paint paint)
Sets the background color of the legend. |
void |
setDisplaySeriesShapes(boolean flag)
Sets a flag that controls whether or not the legend displays the series shapes. |
void |
setItemFont(java.awt.Font font)
Sets the series label font. |
void |
setItemPaint(java.awt.Paint paint)
Sets the series label color. |
void |
setOuterGap(Spacer outerGap)
Sets the outer gap for the legend. |
void |
setOutlinePaint(java.awt.Paint paint)
Sets the outline color. |
void |
setOutlineShapes(boolean flag)
Sets the flag that controls whether or not outlines are drawn around shapes. |
void |
setOutlineStroke(java.awt.Stroke stroke)
Sets the outline pen/brush. |
void |
setShapeOutlinePaint(java.awt.Paint paint)
Sets the paint used to outline shapes. |
void |
setShapeOutlineStroke(java.awt.Stroke stroke)
Sets the stroke used to outline shapes. |
void |
setTitle(java.lang.String title)
Sets the title of the legend. |
void |
setTitleFont(java.awt.Font font)
Sets the title font. |
Methods inherited from class org.jfree.chart.Legend |
addChangeListener, createInstance, getAnchor, getChart, notifyListeners, removeChangeListener, setAnchor |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final Spacer DEFAULT_OUTER_GAP
public static final Spacer DEFAULT_INNER_GAP
public static final java.awt.Stroke DEFAULT_OUTLINE_STROKE
public static final java.awt.Paint DEFAULT_OUTLINE_PAINT
public static final java.awt.Paint DEFAULT_BACKGROUND_PAINT
public static final java.awt.Font DEFAULT_TITLE_FONT
public static final java.awt.Font DEFAULT_ITEM_FONT
Constructor Detail |
public StandardLegend(JFreeChart chart)
chart
- the chart that the legend belongs to.Method Detail |
public Spacer getOuterGap()
This is the amount of blank space around the outside of the legend.
public void setOuterGap(Spacer outerGap)
LegendChangeEvent
is sent to all
registered listeners.
outerGap
- the outer gap.public java.awt.Paint getBackgroundPaint()
public void setBackgroundPaint(java.awt.Paint paint)
Registered listeners are notified that the legend has changed.
paint
- the new background color.public java.awt.Stroke getOutlineStroke()
public void setOutlineStroke(java.awt.Stroke stroke)
Registered listeners are notified that the legend has changed.
stroke
- the new outline pen/brush.public java.awt.Paint getOutlinePaint()
public void setOutlinePaint(java.awt.Paint paint)
Registered listeners are notified that the legend has changed.
paint
- the new outline color.public java.lang.String getTitle()
public void setTitle(java.lang.String title)
title
- The title to use. Pass null
if you don't
want a title.public java.awt.Font getTitleFont()
public void setTitleFont(java.awt.Font font)
font
- the new font.public java.awt.Font getItemFont()
public void setItemFont(java.awt.Font font)
Registered listeners are notified that the legend has changed.
font
- the new series label font.public java.awt.Paint getItemPaint()
public void setItemPaint(java.awt.Paint paint)
Registered listeners are notified that the legend has changed.
paint
- the new series label color.public boolean getOutlineShapes()
public void setOutlineShapes(boolean flag)
flag
- The flag.public java.awt.Stroke getShapeOutlineStroke()
public void setShapeOutlineStroke(java.awt.Stroke stroke)
Registered listeners are notified of the change.
stroke
- the stroke.public java.awt.Paint getShapeOutlinePaint()
public void setShapeOutlinePaint(java.awt.Paint paint)
Registered listeners are notified of the change.
paint
- the paint.public void setDisplaySeriesShapes(boolean flag)
flag
- the new value of the flag.public java.awt.geom.Rectangle2D draw(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D available)
draw
in class Legend
g2
- the graphics device.available
- the area within which the legend, and afterwards the plot, should be
drawn.
protected java.awt.geom.Rectangle2D draw(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D available, boolean horizontal, boolean inverted)
g2
- the graphics device.available
- the area available for drawing the chart.horizontal
- a flag indicating whether the legend items are laid out horizontally.inverted
- ???
public boolean equals(java.lang.Object obj)
equals
in class Legend
obj
- the object.
true
or false
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |