|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.jfree.chart.axis.Axis
The base class for all axes in JFreeChart. Subclasses are divided into those that display
values (ValueAxis
) and those that display categories (CategoryAxis
).
Field Summary |
Constructor Summary | |
protected |
Axis(java.lang.String label)
Constructs an axis, using default values where necessary. |
Method Summary | |
void |
addChangeListener(AxisChangeListener listener)
Registers an object for notification of changes to the axis. |
abstract void |
configure()
Configures the axis to work with the current plot. |
abstract void |
draw(java.awt.Graphics2D g2,
java.awt.geom.Rectangle2D plotArea,
java.awt.geom.Rectangle2D dataArea,
int location)
Draws the axis on a Java 2D graphics device (such as the screen or a printer). |
protected double |
drawHorizontalLabel(java.lang.String label,
java.awt.Graphics2D g2,
java.awt.geom.Rectangle2D plotArea,
java.awt.geom.Rectangle2D dataArea,
int location,
double cursorY)
A utility method intended for use by subclasses that are 'horizontal' axes (for example, HorizontalCategoryAxis , HorizontalCategoryAxis3D ,
HorizontalNumberAxis , HorizontalNumberAxis3D and HorizontalDateAxis ). |
protected void |
drawVerticalLabel(java.lang.String label,
boolean vertical,
java.awt.Graphics2D g2,
java.awt.geom.Rectangle2D plotArea,
java.awt.geom.Rectangle2D dataArea,
int location)
A utility method intended for use by subclasses that are 'vertical' axes (for example, VerticalCategoryAxis, VerticalNumberAxis and VerticalDateAxis. |
boolean |
equals(java.lang.Object obj)
Tests this axis for equality with another object. |
double |
getFixedDimension()
Returns the fixed dimension for the axis. |
java.lang.String |
getLabel()
Returns the label for the axis. |
java.awt.Font |
getLabelFont()
Returns the font for the axis label. |
java.awt.Insets |
getLabelInsets()
Returns the insets for the label (that is, the amount of blank space that should be left around the label). |
java.awt.Paint |
getLabelPaint()
Returns the color/shade used to draw the axis label. |
protected double |
getMaxTickLabelWidth(java.awt.Graphics2D g2,
java.awt.geom.Rectangle2D plotArea)
Returns the maximum width of the ticks in the working list (that is set up by refreshTicks()). |
Plot |
getPlot()
Returns the plot that the axis is assigned to. |
java.awt.Font |
getTickLabelFont()
Returns the font used for the tick labels (if showing). |
java.awt.Insets |
getTickLabelInsets()
Returns the insets for the tick labels. |
java.awt.Paint |
getTickLabelPaint()
Returns the color/shade used for the tick labels. |
float |
getTickMarkInsideLength()
Returns the inside length of the tick marks. |
float |
getTickMarkOutsideLength()
Returns the outside length of the tick marks. |
java.awt.Paint |
getTickMarkPaint()
Returns the paint used to draw tick marks (if they are showing). |
java.awt.Stroke |
getTickMarkStroke()
Returns the pen/brush used to draw tick marks (if they are showing). |
java.util.List |
getTicks()
Returns the current list of ticks. |
protected abstract boolean |
isCompatiblePlot(Plot plot)
Returns true if the plot is compatible with the axis. |
boolean |
isTickLabelsVisible()
Returns a flag indicating whether or not the tick labels are visible. |
boolean |
isTickMarksVisible()
Returns the flag that indicates whether or not the tick marks are showing. |
boolean |
isVisible()
Returns true if the axis is visible, and false otherwise. |
protected void |
notifyListeners(AxisChangeEvent event)
Notifies all registered listeners that the axis has changed. |
abstract void |
refreshTicks(java.awt.Graphics2D g2,
java.awt.geom.Rectangle2D plotArea,
java.awt.geom.Rectangle2D dataArea,
int location)
Calculates the positions of the ticks for the axis, storing the results in the tick list (ready for drawing). |
void |
removeChangeListener(AxisChangeListener listener)
Deregisters an object for notification of changes to the axis. |
void |
setFixedDimension(double dimension)
Sets the fixed dimension for the axis. |
void |
setLabel(java.lang.String label)
Sets the label for the axis (null permitted). |
void |
setLabelFont(java.awt.Font font)
Sets the font for the axis label. |
void |
setLabelInsets(java.awt.Insets insets)
Sets the insets for the axis label, and notifies registered listeners that the axis has been modified. |
void |
setLabelPaint(java.awt.Paint paint)
Sets the color/shade used to draw the axis label. |
void |
setPlot(Plot plot)
Sets a reference to the plot that the axis is assigned to. |
void |
setTickLabelFont(java.awt.Font font)
Sets the font for the tick labels. |
void |
setTickLabelInsets(java.awt.Insets insets)
Sets the insets for the tick labels, and notifies registered listeners that the axis has been modified. |
void |
setTickLabelPaint(java.awt.Paint paint)
Sets the color/shade used to draw tick labels (if they are showing). |
void |
setTickLabelsVisible(boolean flag)
Sets the flag that determines whether or not the tick labels are visible. |
void |
setTickMarkInsideLength(float length)
Sets the inside length of the tick marks. |
void |
setTickMarkOutsideLength(float length)
Sets the outside length of the tick marks. |
void |
setTickMarkPaint(java.awt.Paint paint)
Sets the paint used to draw tick marks (if they are showing). |
void |
setTickMarkStroke(java.awt.Stroke stroke)
Sets the pen/brush used to draw tick marks (if they are showing). |
void |
setTickMarksVisible(boolean flag)
Sets the flag that indicates whether or not the tick marks are showing. |
void |
setVisible(boolean flag)
Sets a flag that controls whether or not the axis is drawn on the chart. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected Axis(java.lang.String label)
label
- the axis label (null
permitted).Method Detail |
public boolean isVisible()
public void setVisible(boolean flag)
flag
- the flag.public java.lang.String getLabel()
public void setLabel(java.lang.String label)
Registered listeners are notified of a general change to the axis.
label
- the new label.public java.awt.Font getLabelFont()
public void setLabelFont(java.awt.Font font)
Registered listeners are notified of a general change to the axis.
font
- the new label font.public java.awt.Paint getLabelPaint()
public void setLabelPaint(java.awt.Paint paint)
Registered listeners are notified of a general change to the axis.
paint
- the new color/shade for the axis label.public java.awt.Insets getLabelInsets()
public void setLabelInsets(java.awt.Insets insets)
insets
- the new label insets.public boolean isTickLabelsVisible()
public void setTickLabelsVisible(boolean flag)
Registered listeners are notified of a general change to the axis.
flag
- the flag.public java.awt.Font getTickLabelFont()
public void setTickLabelFont(java.awt.Font font)
Registered listeners are notified of a general change to the axis.
font
- the new tick label font.public java.awt.Paint getTickLabelPaint()
public void setTickLabelPaint(java.awt.Paint paint)
Registered listeners are notified of a general change to the axis.
paint
- the new color/shade.public java.awt.Insets getTickLabelInsets()
public void setTickLabelInsets(java.awt.Insets insets)
insets
- the new tick label insets.public boolean isTickMarksVisible()
public void setTickMarksVisible(boolean flag)
Registered listeners are notified of a general change to the axis.
flag
- the flag.public float getTickMarkInsideLength()
public void setTickMarkInsideLength(float length)
length
- the new length.public float getTickMarkOutsideLength()
public void setTickMarkOutsideLength(float length)
length
- the new length.public java.awt.Stroke getTickMarkStroke()
public void setTickMarkStroke(java.awt.Stroke stroke)
Registered listeners are notified of a general change to the axis.
stroke
- the new pen/brush (null not permitted).public java.awt.Paint getTickMarkPaint()
public void setTickMarkPaint(java.awt.Paint paint)
Registered listeners are notified of a general change to the axis.
paint
- the new paint (null not permitted).public java.util.List getTicks()
public Plot getPlot()
This method will return null if the axis is not currently assigned to a plot.
public void setPlot(Plot plot) throws PlotNotCompatibleException
This method is used internally, you shouldn't need to call it yourself.
plot
- the plot.
PlotNotCompatibleException
- if plot is not compatible.public double getFixedDimension()
public void setFixedDimension(double dimension)
This is used when combining more than one plot on a chart. In this case, there may be several axes that need to have the same height or width so that they are aligned. This method is used to fix a dimension for the axis (the context determines whether the dimension is horizontal or vertical).
dimension
- the fixed dimension.public abstract void draw(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, java.awt.geom.Rectangle2D dataArea, int location)
g2
- the graphics device.plotArea
- the area within which the axes and plot should be drawn.dataArea
- the area within which the data should be drawn.location
- the axis location (TOP, BOTTOM, RIGHT or LEFT).public abstract void refreshTicks(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, java.awt.geom.Rectangle2D dataArea, int location)
g2
- the graphics device.plotArea
- the area within which the axes and plot should be drawn.dataArea
- the area inside the axes.location
- the axis location.public abstract void configure()
protected double getMaxTickLabelWidth(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea)
g2
- the graphics device.plotArea
- the area within which the plot is to be drawn.
protected abstract boolean isCompatiblePlot(Plot plot)
plot
- the plot.
true
if the plot is compatible with the axis.public void addChangeListener(AxisChangeListener listener)
listener
- the object that is being registered.public void removeChangeListener(AxisChangeListener listener)
listener
- the object to deregister.protected void notifyListeners(AxisChangeEvent event)
event
- information about the change to the axis.protected double drawHorizontalLabel(java.lang.String label, java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, java.awt.geom.Rectangle2D dataArea, int location, double cursorY)
HorizontalCategoryAxis
, HorizontalCategoryAxis3D
,
HorizontalNumberAxis
, HorizontalNumberAxis3D
and HorizontalDateAxis
).
label
- the label.g2
- the graphics device.plotArea
- the plot area.dataArea
- the data area.location
- the axis location (TOP or BOTTOM).cursorY
- the Y cursor.
protected void drawVerticalLabel(java.lang.String label, boolean vertical, java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, java.awt.geom.Rectangle2D dataArea, int location)
label
- the label.vertical
- rotate the label to vertical?g2
- the graphics device.plotArea
- the plot area.dataArea
- the data area.location
- the axis location (TOP or BOTTOM).public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- the object.
true
or false
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |