org.jfree.chart.plot
Class CategoryPlot

java.lang.Object
  extended by org.jfree.chart.plot.Plot
      extended by org.jfree.chart.plot.CategoryPlot
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.EventListener, AxisChangeListener, MarkerChangeListener, RendererChangeListener, LegendItemSource, ValueAxisPlot, Zoomable, DatasetChangeListener, org.jfree.util.PublicCloneable
Direct Known Subclasses:
CombinedDomainCategoryPlot, CombinedRangeCategoryPlot

public class CategoryPlot
extends Plot
implements ValueAxisPlot, Zoomable, RendererChangeListener, java.lang.Cloneable, org.jfree.util.PublicCloneable, java.io.Serializable

A general plotting class that uses data from a CategoryDataset and renders each data item using a CategoryItemRenderer.

See Also:
Serialized Form

Field Summary
static java.awt.Paint DEFAULT_CROSSHAIR_PAINT
          The default crosshair paint.
static java.awt.Stroke DEFAULT_CROSSHAIR_STROKE
          The default crosshair stroke.
static boolean DEFAULT_CROSSHAIR_VISIBLE
          The default crosshair visibility.
static boolean DEFAULT_DOMAIN_GRIDLINES_VISIBLE
          The default visibility of the grid lines plotted against the domain axis.
static java.awt.Paint DEFAULT_GRIDLINE_PAINT
          The default grid line paint.
static java.awt.Stroke DEFAULT_GRIDLINE_STROKE
          The default grid line stroke.
static boolean DEFAULT_RANGE_GRIDLINES_VISIBLE
          The default visibility of the grid lines plotted against the range axis.
static java.awt.Font DEFAULT_VALUE_LABEL_FONT
          The default value label font.
protected static java.util.ResourceBundle localizationResources
          The resourceBundle for the localization.
 
Fields inherited from class org.jfree.chart.plot.Plot
DEFAULT_BACKGROUND_ALPHA, DEFAULT_BACKGROUND_PAINT, DEFAULT_FOREGROUND_ALPHA, DEFAULT_INSETS, DEFAULT_LEGEND_ITEM_BOX, DEFAULT_LEGEND_ITEM_CIRCLE, DEFAULT_OUTLINE_PAINT, DEFAULT_OUTLINE_STROKE, MINIMUM_HEIGHT_TO_DRAW, MINIMUM_WIDTH_TO_DRAW, ZERO
 
Constructor Summary
CategoryPlot()
          Default constructor.
CategoryPlot(CategoryDataset dataset, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryItemRenderer renderer)
          Creates a new plot.
 
Method Summary
 void addAnnotation(CategoryAnnotation annotation)
          Adds an annotation to the plot and sends a PlotChangeEvent to all registered listeners.
 void addDomainMarker(CategoryMarker marker)
          Adds a marker for display (in the foreground) against the domain axis and sends a PlotChangeEvent to all registered listeners.
 void addDomainMarker(CategoryMarker marker, org.jfree.ui.Layer layer)
          Adds a marker for display against the domain axis and sends a PlotChangeEvent to all registered listeners.
 void addDomainMarker(int index, CategoryMarker marker, org.jfree.ui.Layer layer)
          Adds a marker for display by a particular renderer.
 void addRangeMarker(int index, Marker marker, org.jfree.ui.Layer layer)
          Adds a marker for display by a particular renderer.
 void addRangeMarker(Marker marker)
          Adds a marker for display (in the foreground) against the range axis and sends a PlotChangeEvent to all registered listeners.
 void addRangeMarker(Marker marker, org.jfree.ui.Layer layer)
          Adds a marker for display against the range axis and sends a PlotChangeEvent to all registered listeners.
protected  AxisSpace calculateAxisSpace(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea)
          Calculates the space required for the axes.
protected  AxisSpace calculateDomainAxisSpace(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, AxisSpace space)
          Calculates the space required for the domain axis/axes.
protected  AxisSpace calculateRangeAxisSpace(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, AxisSpace space)
          Calculates the space required for the range axis/axes.
 void clearAnnotations()
          Clears all the annotations and sends a PlotChangeEvent to all registered listeners.
 void clearDomainAxes()
          Clears the domain axes from the plot and sends a PlotChangeEvent to all registered listeners.
 void clearDomainMarkers()
          Clears all the domain markers for the plot and sends a PlotChangeEvent to all registered listeners.
 void clearDomainMarkers(int index)
          Clears all the domain markers for the specified renderer.
 void clearRangeAxes()
          Clears the range axes from the plot and sends a PlotChangeEvent to all registered listeners.
 void clearRangeMarkers()
          Clears all the range markers for the plot and sends a PlotChangeEvent to all registered listeners.
 void clearRangeMarkers(int index)
          Clears all the range markers for the specified renderer.
 java.lang.Object clone()
          Returns a clone of the plot.
 void configureDomainAxes()
          Configures the domain axes.
 void configureRangeAxes()
          Configures the range axes.
 void datasetChanged(DatasetChangeEvent event)
          Receives notification of a change to the plot's dataset.
 void draw(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D area, java.awt.geom.Point2D anchor, PlotState parentState, PlotRenderingInfo state)
          Draws the plot on a Java 2D graphics device (such as the screen or a printer).
protected  void drawAnnotations(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea)
          Draws the annotations...
protected  java.util.Map drawAxes(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, java.awt.geom.Rectangle2D dataArea, PlotRenderingInfo plotState)
          A utility method for drawing the plot's axes.
 void drawBackground(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D area)
          Draws the plot background (the background color and/or image).
protected  void drawDomainGridlines(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea)
          Draws the gridlines for the plot.
protected  void drawDomainMarkers(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, int index, org.jfree.ui.Layer layer)
          Draws the domain markers (if any) for an axis and layer.
protected  void drawRangeCrosshair(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, PlotOrientation orientation, double value, ValueAxis axis, java.awt.Stroke stroke, java.awt.Paint paint)
          Draws a range crosshair.
protected  void drawRangeGridlines(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, java.util.List ticks)
          Draws the gridlines for the plot.
protected  void drawRangeLine(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, double value, java.awt.Stroke stroke, java.awt.Paint paint)
          Utility method for drawing a line perpendicular to the range axis (used for crosshairs).
protected  void drawRangeMarkers(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, int index, org.jfree.ui.Layer layer)
          Draws the range markers (if any) for an axis and layer.
 boolean equals(java.lang.Object obj)
          Tests the plot for equality with an arbitrary object.
 double getAnchorValue()
          Returns the anchor value.
 java.util.List getAnnotations()
          Returns the list of annotations.
 org.jfree.ui.RectangleInsets getAxisOffset()
          Returns the axis offset.
 java.util.List getCategories()
          Returns a list of the categories in the plot's primary dataset.
 java.util.List getCategoriesForAxis(CategoryAxis axis)
          Returns a list of the categories that should be displayed for the specified axis.
 org.jfree.util.SortOrder getColumnRenderingOrder()
          Returns the order in which the columns are rendered.
 Range getDataRange(ValueAxis axis)
          Returns the range of data values that will be plotted against the range axis.
 CategoryDataset getDataset()
          Returns the primary dataset for the plot.
 CategoryDataset getDataset(int index)
          Returns the dataset at the given index.
 int getDatasetCount()
          Returns the number of datasets.
 DatasetRenderingOrder getDatasetRenderingOrder()
          Returns the dataset rendering order.
 CategoryAxis getDomainAxis()
          Returns the domain axis for the plot.
 CategoryAxis getDomainAxis(int index)
          Returns a domain axis.
 int getDomainAxisCount()
          Returns the number of domain axes.
 org.jfree.ui.RectangleEdge getDomainAxisEdge()
          Returns the domain axis edge.
 org.jfree.ui.RectangleEdge getDomainAxisEdge(int index)
          Returns the edge for a domain axis.
 CategoryAxis getDomainAxisForDataset(int index)
          Returns the domain axis for a dataset.
 int getDomainAxisIndex(CategoryAxis axis)
          Returns the index of the specified axis, or -1 if the axis is not assigned to the plot.
 AxisLocation getDomainAxisLocation()
          Returns the domain axis location for the primary domain axis.
 AxisLocation getDomainAxisLocation(int index)
          Returns the location for a domain axis.
 java.awt.Paint getDomainGridlinePaint()
          Returns the paint used to draw grid-lines against the domain axis.
 CategoryAnchor getDomainGridlinePosition()
          Returns the position used for the domain gridlines.
 java.awt.Stroke getDomainGridlineStroke()
          Returns the stroke used to draw grid-lines against the domain axis.
 java.util.Collection getDomainMarkers(int index, org.jfree.ui.Layer layer)
          Returns a collection of domain markers for a particular renderer and layer.
 java.util.Collection getDomainMarkers(org.jfree.ui.Layer layer)
          Returns the list of domain markers (read only) for the specified layer.
 boolean getDrawSharedDomainAxis()
          Returns the flag that controls whether or not the shared domain axis is drawn for each subplot.
 AxisSpace getFixedDomainAxisSpace()
          Returns the fixed domain axis space.
 LegendItemCollection getFixedLegendItems()
          Returns the fixed legend items, if any.
 AxisSpace getFixedRangeAxisSpace()
          Returns the fixed range axis space.
 int getIndexOf(CategoryItemRenderer renderer)
          Returns the index of the specified renderer, or -1 if the renderer is not assigned to this plot.
 LegendItemCollection getLegendItems()
          Returns the legend items for the plot.
 PlotOrientation getOrientation()
          Returns the orientation of the plot.
 java.lang.String getPlotType()
          Returns a string describing the type of plot.
 ValueAxis getRangeAxis()
          Returns the range axis for the plot.
 ValueAxis getRangeAxis(int index)
          Returns a range axis.
 int getRangeAxisCount()
          Returns the number of range axes.
 org.jfree.ui.RectangleEdge getRangeAxisEdge()
          Returns the edge where the primary range axis is located.
 org.jfree.ui.RectangleEdge getRangeAxisEdge(int index)
          Returns the edge for a range axis.
 ValueAxis getRangeAxisForDataset(int index)
          Returns the range axis for a dataset.
 AxisLocation getRangeAxisLocation()
          Returns the range axis location.
 AxisLocation getRangeAxisLocation(int index)
          Returns the location for a range axis.
 java.awt.Paint getRangeCrosshairPaint()
          Returns the paint used to draw the range crosshair.
 java.awt.Stroke getRangeCrosshairStroke()
          Returns the pen-style (Stroke) used to draw the crosshair (if visible).
 double getRangeCrosshairValue()
          Returns the range crosshair value.
 java.awt.Paint getRangeGridlinePaint()
          Returns the paint used to draw the grid-lines against the range axis.
 java.awt.Stroke getRangeGridlineStroke()
          Returns the stroke used to draw the grid-lines against the range axis.
 java.util.Collection getRangeMarkers(int index, org.jfree.ui.Layer layer)
          Returns a collection of range markers for a particular renderer and layer.
 java.util.Collection getRangeMarkers(org.jfree.ui.Layer layer)
          Returns the list of range markers (read only) for the specified layer.
 CategoryItemRenderer getRenderer()
          Returns a reference to the renderer for the plot.
 CategoryItemRenderer getRenderer(int index)
          Returns the renderer at the given index.
 CategoryItemRenderer getRendererForDataset(CategoryDataset dataset)
          Returns the renderer for the specified dataset.
 org.jfree.util.SortOrder getRowRenderingOrder()
          Returns the order in which the rows should be rendered.
 int getWeight()
          Returns the weight for this plot when it is used as a subplot within a combined plot.
 void handleClick(int x, int y, PlotRenderingInfo info)
          Handles a 'click' on the plot by updating the anchor value.
 boolean isDomainGridlinesVisible()
          Returns the flag that controls whether the domain grid-lines are visible.
 boolean isDomainZoomable()
          Returns false to indicate that the domain axes are not zoomable.
 boolean isRangeCrosshairLockedOnData()
          Returns a flag indicating whether or not the crosshair should "lock-on" to actual data values.
 boolean isRangeCrosshairVisible()
          Returns a flag indicating whether or not the range crosshair is visible.
 boolean isRangeGridlinesVisible()
          Returns the flag that controls whether the range grid-lines are visible.
 boolean isRangeZoomable()
          Returns true to indicate that the range axes are zoomable.
 void mapDatasetToDomainAxis(int index, int axisIndex)
          Maps a dataset to a particular domain axis.
 void mapDatasetToRangeAxis(int index, int axisIndex)
          Maps a dataset to a particular range axis.
 boolean removeAnnotation(CategoryAnnotation annotation)
          Removes an annotation from the plot and sends a PlotChangeEvent to all registered listeners.
 boolean render(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, int index, PlotRenderingInfo info)
          Draws a representation of a dataset within the dataArea region using the appropriate renderer.
 void rendererChanged(RendererChangeEvent event)
          Receives notification of a renderer change event.
 void setAnchorValue(double value)
          Sets the anchor value and sends a PlotChangeEvent to all registered listeners.
 void setAnchorValue(double value, boolean notify)
          Sets the anchor value and, if requested, sends a PlotChangeEvent to all registered listeners.
 void setAxisOffset(org.jfree.ui.RectangleInsets offset)
          Sets the axis offsets (gap between the data area and the axes) and sends a PlotChangeEvent to all registered listeners.
 void setColumnRenderingOrder(org.jfree.util.SortOrder order)
          Sets the column order in which the items in each dataset should be rendered and sends a PlotChangeEvent to all registered listeners.
 void setDataset(CategoryDataset dataset)
          Sets the dataset for the plot, replacing the existing dataset, if there is one.
 void setDataset(int index, CategoryDataset dataset)
          Sets a dataset for the plot.
 void setDatasetRenderingOrder(DatasetRenderingOrder order)
          Sets the rendering order and sends a PlotChangeEvent to all registered listeners.
 void setDomainAxes(CategoryAxis[] axes)
          Sets the domain axes for this plot and sends a PlotChangeEvent to all registered listeners.
 void setDomainAxis(CategoryAxis axis)
          Sets the domain axis for the plot and sends a PlotChangeEvent to all registered listeners.
 void setDomainAxis(int index, CategoryAxis axis)
          Sets a domain axis and sends a PlotChangeEvent to all registered listeners.
 void setDomainAxis(int index, CategoryAxis axis, boolean notify)
          Sets a domain axis and, if requested, sends a PlotChangeEvent to all registered listeners.
 void setDomainAxisLocation(AxisLocation location)
          Sets the location of the domain axis and sends a PlotChangeEvent to all registered listeners.
 void setDomainAxisLocation(AxisLocation location, boolean notify)
          Sets the location of the domain axis and, if requested, sends a PlotChangeEvent to all registered listeners.
 void setDomainAxisLocation(int index, AxisLocation location)
          Sets the location for a domain axis and sends a PlotChangeEvent to all registered listeners.
 void setDomainAxisLocation(int index, AxisLocation location, boolean notify)
          Sets the location for a domain axis and sends a PlotChangeEvent to all registered listeners.
 void setDomainGridlinePaint(java.awt.Paint paint)
          Sets the paint used to draw the grid-lines (if any) against the domain axis and sends a PlotChangeEvent to all registered listeners.
 void setDomainGridlinePosition(CategoryAnchor position)
          Sets the position used for the domain gridlines and sends a PlotChangeEvent to all registered listeners.
 void setDomainGridlineStroke(java.awt.Stroke stroke)
          Sets the stroke used to draw grid-lines against the domain axis and sends a PlotChangeEvent to all registered listeners.
 void setDomainGridlinesVisible(boolean visible)
          Sets the flag that controls whether or not grid-lines are drawn against the domain axis.
 void setDrawSharedDomainAxis(boolean draw)
          Sets the flag that controls whether the shared domain axis is drawn when this plot is being used as a subplot.
 void setFixedDomainAxisSpace(AxisSpace space)
          Sets the fixed domain axis space.
 void setFixedLegendItems(LegendItemCollection items)
          Sets the fixed legend items for the plot.
 void setFixedRangeAxisSpace(AxisSpace space)
          Sets the fixed range axis space.
 void setOrientation(PlotOrientation orientation)
          Sets the orientation for the plot and sends a PlotChangeEvent to all registered listeners.
 void setRangeAxes(ValueAxis[] axes)
          Sets the range axes for this plot and sends a PlotChangeEvent to all registered listeners.
 void setRangeAxis(int index, ValueAxis axis)
          Sets a range axis and sends a PlotChangeEvent to all registered listeners.
 void setRangeAxis(int index, ValueAxis axis, boolean notify)
          Sets a range axis and, if requested, sends a PlotChangeEvent to all registered listeners.
 void setRangeAxis(ValueAxis axis)
          Sets the range axis for the plot and sends a PlotChangeEvent to all registered listeners.
 void setRangeAxisLocation(AxisLocation location)
          Sets the location of the range axis and sends a PlotChangeEvent to all registered listeners.
 void setRangeAxisLocation(AxisLocation location, boolean notify)
          Sets the location of the range axis and, if requested, sends a PlotChangeEvent to all registered listeners.
 void setRangeAxisLocation(int index, AxisLocation location)
          Sets the location for a range axis and sends a PlotChangeEvent to all registered listeners.
 void setRangeAxisLocation(int index, AxisLocation location, boolean notify)
          Sets the location for a range axis and sends a PlotChangeEvent to all registered listeners.
 void setRangeCrosshairLockedOnData(boolean flag)
          Sets the flag indicating whether or not the range crosshair should "lock-on" to actual data values.
 void setRangeCrosshairPaint(java.awt.Paint paint)
          Sets the paint used to draw the range crosshair (if visible) and sends a PlotChangeEvent to all registered listeners.
 void setRangeCrosshairStroke(java.awt.Stroke stroke)
          Sets the pen-style (Stroke) used to draw the range crosshair (if visible), and sends a PlotChangeEvent to all registered listeners.
 void setRangeCrosshairValue(double value)
          Sets the domain crosshair value.
 void setRangeCrosshairValue(double value, boolean notify)
          Sets the range crosshair value and, if requested, sends a PlotChangeEvent to all registered listeners (but only if the crosshair is visible).
 void setRangeCrosshairVisible(boolean flag)
          Sets the flag indicating whether or not the range crosshair is visible.
 void setRangeGridlinePaint(java.awt.Paint paint)
          Sets the paint used to draw the grid lines against the range axis and sends a PlotChangeEvent to all registered listeners.
 void setRangeGridlineStroke(java.awt.Stroke stroke)
          Sets the stroke used to draw the grid-lines against the range axis and sends a PlotChangeEvent to all registered listeners.
 void setRangeGridlinesVisible(boolean visible)
          Sets the flag that controls whether or not grid-lines are drawn against the range axis.
 void setRenderer(CategoryItemRenderer renderer)
          Sets the renderer at index 0 (sometimes referred to as the "primary" renderer) and sends a PlotChangeEvent to all registered listeners.
 void setRenderer(CategoryItemRenderer renderer, boolean notify)
          Sets the renderer at index 0 (sometimes referred to as the "primary" renderer) and, if requested, sends a PlotChangeEvent to all registered listeners.
 void setRenderer(int index, CategoryItemRenderer renderer)
          Sets the renderer at the specified index and sends a PlotChangeEvent to all registered listeners.
 void setRenderer(int index, CategoryItemRenderer renderer, boolean notify)
          Sets a renderer.
 void setRenderers(CategoryItemRenderer[] renderers)
          Sets the renderers for this plot and sends a PlotChangeEvent to all registered listeners.
 void setRowRenderingOrder(org.jfree.util.SortOrder order)
          Sets the row order in which the items in each dataset should be rendered and sends a PlotChangeEvent to all registered listeners.
 void setWeight(int weight)
          Sets the weight for the plot.
 void zoom(double percent)
          Zooms (in or out) on the plot's value axis.
 void zoomDomainAxes(double lowerPercent, double upperPercent, PlotRenderingInfo state, java.awt.geom.Point2D source)
          This method does nothing, because CategoryPlot doesn't support zooming on the domain.
 void zoomDomainAxes(double factor, PlotRenderingInfo state, java.awt.geom.Point2D source)
          This method does nothing, because CategoryPlot doesn't support zooming on the domain.
 void zoomRangeAxes(double lowerPercent, double upperPercent, PlotRenderingInfo state, java.awt.geom.Point2D source)
          Zooms in on the range axes.
 void zoomRangeAxes(double factor, PlotRenderingInfo state, java.awt.geom.Point2D source)
          Multiplies the range on the range axis/axes by the specified factor.
 
Methods inherited from class org.jfree.chart.plot.Plot
addChangeListener, axisChanged, drawBackgroundImage, drawNoDataMessage, drawOutline, fillBackground, fillBackground, getBackgroundAlpha, getBackgroundImage, getBackgroundImageAlignment, getBackgroundImageAlpha, getBackgroundPaint, getDatasetGroup, getDrawingSupplier, getForegroundAlpha, getInsets, getNoDataMessage, getNoDataMessageFont, getNoDataMessagePaint, getOutlinePaint, getOutlineStroke, getParent, getRectX, getRectY, getRootPlot, isOutlineVisible, isSubplot, markerChanged, notifyListeners, removeChangeListener, resolveDomainAxisLocation, resolveRangeAxisLocation, setBackgroundAlpha, setBackgroundImage, setBackgroundImageAlignment, setBackgroundImageAlpha, setBackgroundPaint, setDatasetGroup, setDrawingSupplier, setForegroundAlpha, setInsets, setInsets, setNoDataMessage, setNoDataMessageFont, setNoDataMessagePaint, setOutlinePaint, setOutlineStroke, setOutlineVisible, setParent
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_DOMAIN_GRIDLINES_VISIBLE

public static final boolean DEFAULT_DOMAIN_GRIDLINES_VISIBLE
The default visibility of the grid lines plotted against the domain axis.

See Also:
Constant Field Values

DEFAULT_RANGE_GRIDLINES_VISIBLE

public static final boolean DEFAULT_RANGE_GRIDLINES_VISIBLE
The default visibility of the grid lines plotted against the range axis.

See Also:
Constant Field Values

DEFAULT_GRIDLINE_STROKE

public static final java.awt.Stroke DEFAULT_GRIDLINE_STROKE
The default grid line stroke.


DEFAULT_GRIDLINE_PAINT

public static final java.awt.Paint DEFAULT_GRIDLINE_PAINT
The default grid line paint.


DEFAULT_VALUE_LABEL_FONT

public static final java.awt.Font DEFAULT_VALUE_LABEL_FONT
The default value label font.


DEFAULT_CROSSHAIR_VISIBLE

public static final boolean DEFAULT_CROSSHAIR_VISIBLE
The default crosshair visibility.

Since:
1.0.5
See Also:
Constant Field Values

DEFAULT_CROSSHAIR_STROKE

public static final java.awt.Stroke DEFAULT_CROSSHAIR_STROKE
The default crosshair stroke.

Since:
1.0.5

DEFAULT_CROSSHAIR_PAINT

public static final java.awt.Paint DEFAULT_CROSSHAIR_PAINT
The default crosshair paint.

Since:
1.0.5

localizationResources

protected static java.util.ResourceBundle localizationResources
The resourceBundle for the localization.

Constructor Detail

CategoryPlot

public CategoryPlot()
Default constructor.


CategoryPlot

public CategoryPlot(CategoryDataset dataset,
                    CategoryAxis domainAxis,
                    ValueAxis rangeAxis,
                    CategoryItemRenderer renderer)
Creates a new plot.

Parameters:
dataset - the dataset (null permitted).
domainAxis - the domain axis (null permitted).
rangeAxis - the range axis (null permitted).
renderer - the item renderer (null permitted).
Method Detail

getPlotType

public java.lang.String getPlotType()
Returns a string describing the type of plot.

Specified by:
getPlotType in class Plot
Returns:
The type.

getOrientation

public PlotOrientation getOrientation()
Returns the orientation of the plot.

Specified by:
getOrientation in interface Zoomable
Returns:
The orientation of the plot (never null).
See Also:
setOrientation(PlotOrientation)

setOrientation

public void setOrientation(PlotOrientation orientation)
Sets the orientation for the plot and sends a PlotChangeEvent to all registered listeners.

Parameters:
orientation - the orientation (null not permitted).
See Also:
getOrientation()

getAxisOffset

public org.jfree.ui.RectangleInsets getAxisOffset()
Returns the axis offset.

Returns:
The axis offset (never null).
See Also:
setAxisOffset(RectangleInsets)

setAxisOffset

public void setAxisOffset(org.jfree.ui.RectangleInsets offset)
Sets the axis offsets (gap between the data area and the axes) and sends a PlotChangeEvent to all registered listeners.

Parameters:
offset - the offset (null not permitted).
See Also:
getAxisOffset()

getDomainAxis

public CategoryAxis getDomainAxis()
Returns the domain axis for the plot. If the domain axis for this plot is null, then the method will return the parent plot's domain axis (if there is a parent plot).

Returns:
The domain axis (null permitted).
See Also:
setDomainAxis(CategoryAxis)

getDomainAxis

public CategoryAxis getDomainAxis(int index)
Returns a domain axis.

Parameters:
index - the axis index.
Returns:
The axis (null possible).
See Also:
setDomainAxis(int, CategoryAxis)

setDomainAxis

public void setDomainAxis(CategoryAxis axis)
Sets the domain axis for the plot and sends a PlotChangeEvent to all registered listeners.

Parameters:
axis - the axis (null permitted).
See Also:
getDomainAxis()

setDomainAxis

public void setDomainAxis(int index,
                          CategoryAxis axis)
Sets a domain axis and sends a PlotChangeEvent to all registered listeners.

Parameters:
index - the axis index.
axis - the axis (null permitted).
See Also:
getDomainAxis(int)

setDomainAxis

public void setDomainAxis(int index,
                          CategoryAxis axis,
                          boolean notify)
Sets a domain axis and, if requested, sends a PlotChangeEvent to all registered listeners.

Parameters:
index - the axis index.
axis - the axis (null permitted).
notify - notify listeners?

setDomainAxes

public void setDomainAxes(CategoryAxis[] axes)
Sets the domain axes for this plot and sends a PlotChangeEvent to all registered listeners.

Parameters:
axes - the axes (null not permitted).
See Also:
setRangeAxes(ValueAxis[])

getDomainAxisIndex

public int getDomainAxisIndex(CategoryAxis axis)
Returns the index of the specified axis, or -1 if the axis is not assigned to the plot.

Parameters:
axis - the axis.
Returns:
The axis index.
Since:
1.0.3

getDomainAxisLocation

public AxisLocation getDomainAxisLocation()
Returns the domain axis location for the primary domain axis.

Returns:
The location (never null).
See Also:
getRangeAxisLocation()

getDomainAxisLocation

public AxisLocation getDomainAxisLocation(int index)
Returns the location for a domain axis.

Parameters:
index - the axis index.
Returns:
The location.
See Also:
setDomainAxisLocation(int, AxisLocation)

setDomainAxisLocation

public void setDomainAxisLocation(AxisLocation location)
Sets the location of the domain axis and sends a PlotChangeEvent to all registered listeners.

Parameters:
location - the axis location (null not permitted).
See Also:
getDomainAxisLocation(), setDomainAxisLocation(int, AxisLocation)

setDomainAxisLocation

public void setDomainAxisLocation(AxisLocation location,
                                  boolean notify)
Sets the location of the domain axis and, if requested, sends a PlotChangeEvent to all registered listeners.

Parameters:
location - the axis location (null not permitted).
notify - a flag that controls whether listeners are notified.

setDomainAxisLocation

public void setDomainAxisLocation(int index,
                                  AxisLocation location)
Sets the location for a domain axis and sends a PlotChangeEvent to all registered listeners.

Parameters:
index - the axis index.
location - the location.
See Also:
getDomainAxisLocation(int), setRangeAxisLocation(int, AxisLocation)

setDomainAxisLocation

public void setDomainAxisLocation(int index,
                                  AxisLocation location,
                                  boolean notify)
Sets the location for a domain axis and sends a PlotChangeEvent to all registered listeners.

Parameters:
index - the axis index.
location - the location.
notify - notify listeners?
Since:
1.0.5
See Also:
getDomainAxisLocation(int), setRangeAxisLocation(int, AxisLocation, boolean)

getDomainAxisEdge

public org.jfree.ui.RectangleEdge