|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.jrefinery.chart.Axis
The base class for all axes in JFreeChart.
CategoryAxis
,
ValueAxis
Field Summary | |
protected double |
fixedDimension
The fixed (horizontal or vertical) dimension for the axis. |
protected java.lang.String |
label
The label for the axis. |
protected java.awt.Font |
labelFont
The font for displaying the axis label. |
protected java.awt.Insets |
labelInsets
The insets for the axis label. |
protected java.awt.Paint |
labelPaint
The paint for drawing the axis label. |
protected Plot |
plot
A reference back to the plot that the axis is assigned to (can be null). |
protected java.awt.Font |
tickLabelFont
The font used to display the tick labels. |
protected java.awt.Insets |
tickLabelInsets
The blank space around each tick label. |
protected java.awt.Paint |
tickLabelPaint
The color used to display the tick labels. |
protected boolean |
tickLabelsVisible
A flag that indicates whether or not tick labels are visible for the axis. |
protected java.awt.Paint |
tickMarkPaint
The paint used to draw tick marks. |
protected java.awt.Stroke |
tickMarkStroke
The stroke used to draw tick marks. |
protected boolean |
tickMarksVisible
A flag that indicates whether or not tick marks are visible for the axis. |
protected java.util.List |
ticks
A working list of ticks - this list is refreshed as required. |
protected boolean |
visible
A flag indicating whether or not the axis is visible. |
Fields inherited from interface com.jrefinery.chart.AxisConstants |
DEFAULT_AXIS_LABEL_FONT, DEFAULT_AXIS_LABEL_INSETS, DEFAULT_AXIS_LABEL_PAINT, DEFAULT_TICK_LABEL_FONT, DEFAULT_TICK_LABEL_INSETS, DEFAULT_TICK_LABEL_PAINT, DEFAULT_TICK_PAINT, DEFAULT_TICK_STROKE |
Constructor Summary | |
protected |
Axis(java.lang.String label)
Constructs an axis, using default values where necessary. |
protected |
Axis(java.lang.String label,
java.awt.Font labelFont,
java.awt.Paint labelPaint,
java.awt.Insets labelInsets,
boolean tickLabelsVisible,
java.awt.Font tickLabelFont,
java.awt.Paint tickLabelPaint,
java.awt.Insets tickLabelInsets,
boolean tickMarksVisible,
java.awt.Stroke tickMarkStroke,
java.awt.Paint tickMarkPaint)
Constructs an axis. |
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 cuurent plot. |
abstract void |
draw(java.awt.Graphics2D g2,
java.awt.geom.Rectangle2D plotArea,
java.awt.geom.Rectangle2D dataArea)
Draws the axis on a Java 2D graphics device (such as the screen or a printer). |
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. |
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). |
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)
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 |
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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected boolean visible
protected java.lang.String label
protected java.awt.Font labelFont
protected java.awt.Paint labelPaint
protected java.awt.Insets labelInsets
protected boolean tickLabelsVisible
protected java.awt.Font tickLabelFont
protected java.awt.Paint tickLabelPaint
protected java.awt.Insets tickLabelInsets
protected boolean tickMarksVisible
protected java.awt.Stroke tickMarkStroke
protected java.awt.Paint tickMarkPaint
protected java.util.List ticks
protected Plot plot
protected double fixedDimension
Constructor Detail |
protected Axis(java.lang.String label)
label
- the axis label (null permitted).protected Axis(java.lang.String label, java.awt.Font labelFont, java.awt.Paint labelPaint, java.awt.Insets labelInsets, boolean tickLabelsVisible, java.awt.Font tickLabelFont, java.awt.Paint tickLabelPaint, java.awt.Insets tickLabelInsets, boolean tickMarksVisible, java.awt.Stroke tickMarkStroke, java.awt.Paint tickMarkPaint)
label
- the axis label.labelFont
- the font for displaying the axis label.labelPaint
- the paint used to draw the axis label.labelInsets
- determines the amount of blank space around the label.tickLabelsVisible
- a flag indicating whether or not the tick labels are visible.tickLabelFont
- the font used to display tick labels.tickLabelPaint
- the paint used to draw tick labels.tickLabelInsets
- determines the amount of blank space around tick labels.tickMarksVisible
- flag indicating whether or not tick marks are visible.tickMarkStroke
- the stroke used to draw tick marks (if visible).tickMarkPaint
- the paint used to draw tick marks (if visible).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 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 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 called by Plot in the setHorizontalAxis() and setVerticalAxis() methods. You shouldn't need to call the method yourself.
plot
- the plot that the axis belongs to.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)
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.public abstract void refreshTicks(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, java.awt.geom.Rectangle2D dataArea)
g2
- the graphics device.plotArea
- the area within which the axes and plot should be drawn.dataArea
- the area within which the plot should be drawn.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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |