|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jfree.chart.Legend
A chart legend shows the names and visual representations of the series that are plotted in a chart.
StandardLegend
,
Serialized FormField Summary | |
static int |
EAST
Constant anchor value for legend position EAST. |
static int |
EAST_NORTHEAST
Constant anchor value for legend position EAST_NORTHEAST. |
static int |
EAST_SOUTHEAST
Constant anchor value for legend position EAST_SOUTHEAST. |
protected static int |
HORIZONTAL
Internal value indicating the bit holding the value of interest in the anchor value. |
protected static int |
INVERTED
Internal value indicating the bit holding the value of interest in the anchor value. |
static int |
NORTH
Constant anchor value for legend position NORTH. |
static int |
NORTH_NORTHEAST
Constant anchor value for legend position NORTH_NORTHEAST. |
static int |
NORTH_NORTHWEST
Constant anchor value for legend position NORTH_NORTHWEST. |
static int |
SOUTH
Constant anchor value for legend position SOUTH. |
static int |
SOUTH_SOUTHEAST
Constant anchor value for legend position SOUTH_SOUTHEAST. |
static int |
SOUTH_SOUTHWEST
Constant anchor value for legend position SOUTH_SOUTHWEST. |
static int |
WEST
Constant anchor value for legend position WEST. |
static int |
WEST_NORTHWEST
Constant anchor value for legend position WEST_NORTHWEST. |
static int |
WEST_SOUTHWEST
Constant anchor value for legend position WEST_SOUTHWEST. |
Constructor Summary | |
Legend()
Default constructor. |
Method Summary | |
void |
addChangeListener(LegendChangeListener listener)
Registers an object for notification of changes to the legend. |
protected java.lang.Object |
clone()
Clones the legend, and takes care of listeners. |
static Legend |
createInstance(JFreeChart chart)
Static factory method that returns a concrete subclass of Legend. |
abstract java.awt.geom.Rectangle2D |
draw(java.awt.Graphics2D g2,
java.awt.geom.Rectangle2D available,
ChartRenderingInfo info)
Draws the legend on a Java 2D graphics device (such as the screen or a printer). |
boolean |
equals(java.lang.Object obj)
Tests this legend for equality with another object. |
int |
getAnchor()
Returns the current anchor of this legend. |
JFreeChart |
getChart()
Returns the chart that this legend belongs to. |
protected boolean |
isAnchoredToBottom()
Returns true if and only if this legend is anchored to bottom. |
protected boolean |
isAnchoredToCenter()
Returns true if and only if this legend is anchored to center. |
protected boolean |
isAnchoredToLeft()
Returns true if and only if this legend is anchored to left. |
protected boolean |
isAnchoredToMiddle()
Returns true if and only if this legend is anchored to middle. |
protected boolean |
isAnchoredToRight()
Returns true if and only if this legend is anchored to right. |
protected boolean |
isAnchoredToTop()
Returns true if and only if this legend is anchored to top. |
protected void |
notifyListeners(LegendChangeEvent event)
Notifies all registered listeners that the chart legend has changed in some way. |
protected void |
registerChart(JFreeChart chart)
Internal maintenance method to update the reference to the central JFreeChart object. |
void |
removeChangeListener(LegendChangeListener listener)
Deregisters an object for notification of changes to the legend. |
void |
setAnchor(int anchor)
Sets the current anchor of this legend. |
Methods inherited from class java.lang.Object |
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int WEST
public static final int WEST_NORTHWEST
public static final int WEST_SOUTHWEST
public static final int NORTH
public static final int NORTH_NORTHWEST
public static final int NORTH_NORTHEAST
public static final int EAST
public static final int EAST_NORTHEAST
public static final int EAST_SOUTHEAST
public static final int SOUTH
public static final int SOUTH_SOUTHWEST
public static final int SOUTH_SOUTHEAST
protected static final int INVERTED
protected static final int HORIZONTAL
Constructor Detail |
public Legend()
Method Detail |
public static Legend createInstance(JFreeChart chart)
chart
- the chart that the legend belongs to.
public JFreeChart getChart()
protected void registerChart(JFreeChart chart)
chart
- the chart, may be null, if the legend gets removed from
the chart.public abstract java.awt.geom.Rectangle2D draw(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D available, ChartRenderingInfo info)
g2
- the graphics device.available
- the area within which the legend (and plot) should be drawn.info
- a carrier for returning information about the entities in the legend.
public void addChangeListener(LegendChangeListener listener)
listener
- the object that is being registered.public void removeChangeListener(LegendChangeListener listener)
listener
- the object that is being deregistered.protected void notifyListeners(LegendChangeEvent event)
event
- information about the change to the legend.public int getAnchor()
The default anchor for this legend is SOUTH
.
public void setAnchor(int anchor)
The anchor can be one of: NORTH
, SOUTH
, EAST
,
WEST
. If a valid anchor value is provided, the current anchor is set and an
update event is triggered. Otherwise, no change is made.
anchor
- the new anchor value.protected boolean isAnchoredToTop()
true
if and only if this legend is anchored to top.
true
if and only if this legend is anchored to top.protected boolean isAnchoredToMiddle()
true
if and only if this legend is anchored to middle.
true
if and only if this legend is anchored to middle.protected boolean isAnchoredToBottom()
true
if and only if this legend is anchored to bottom.
true
if and only if this legend is anchored to bottom.protected boolean isAnchoredToLeft()
true
if and only if this legend is anchored to left.
true
if and only if this legend is anchored to left.protected boolean isAnchoredToRight()
true
if and only if this legend is anchored to right.
true
if and only if this legend is anchored to right.protected boolean isAnchoredToCenter()
true
if and only if this legend is anchored to center.
true
if and only if this legend is anchored to center.public boolean equals(java.lang.Object obj)
obj
- the object.
true
or false
.protected java.lang.Object clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException
- if the object cannot be cloned.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |