org.jfree.chart.axis
Class HorizontalMarkerAxisBand

java.lang.Object
  |
  +--org.jfree.chart.axis.HorizontalMarkerAxisBand

All Implemented Interfaces:

java.io.Serializable

public class HorizontalMarkerAxisBand

extends java.lang.Object

implements java.io.Serializable

A band that can be added to a horizontal axis to display regions.

Author:

David Gilbert

See Also:

Serialized Form

Constructor Summary

HorizontalMarkerAxisBand(HorizontalNumberAxis axis, double topOuterGap, double topInnerGap, double bottomOuterGap, double bottomInnerGap, java.awt.Font font)
Constructs a new axis band.

Method Summary

void	addMarker(IntervalMarker marker) Adds a marker to the band.
void	draw(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, java.awt.geom.Rectangle2D dataArea, double x, double y) Draws the band.
boolean	equals(java.lang.Object obj) Tests this axis for equality with another object.
double	getHeight(java.awt.Graphics2D g2) Returns the height of the band.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HorizontalMarkerAxisBand

public HorizontalMarkerAxisBand(HorizontalNumberAxis axis,
                                double topOuterGap,
                                double topInnerGap,
                                double bottomOuterGap,
                                double bottomInnerGap,
                                java.awt.Font font)

Constructs a new axis band.

Parameters:

axis - the owner.

topOuterGap - the top outer gap.

topInnerGap - the top inner gap.

bottomOuterGap - the bottom outer gap.

bottomInnerGap - the bottom inner gap.

font - the font.

Method Detail

addMarker

public void addMarker(IntervalMarker marker)

Adds a marker to the band.

Parameters:

marker - the marker.

getHeight

public double getHeight(java.awt.Graphics2D g2)

Returns the height of the band.

Parameters:

g2 - the graphics device.

Returns:

the height of the band.

draw

public void draw(java.awt.Graphics2D g2,
                 java.awt.geom.Rectangle2D plotArea,
                 java.awt.geom.Rectangle2D dataArea,
                 double x,
                 double y)

Draws the band.

Parameters:

g2 - the graphics device.

plotArea - the plot area.

dataArea - the data area.

x - the x-coordinate.

y - the y-coordinate.

equals

public boolean equals(java.lang.Object obj)

Tests this axis for equality with another object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object.

Returns:

true or false.