Save This Page
Home » jcommon-1.0.13 » org.jfree » chart » renderer » xy » [javadoc | source]
org.jfree.chart.renderer.xy
abstract public class: AbstractXYItemRenderer [javadoc | source]
java.lang.Object
   org.jfree.chart.renderer.AbstractRenderer
      org.jfree.chart.renderer.xy.AbstractXYItemRenderer

All Implemented Interfaces:
    Cloneable, Serializable, XYItemRenderer

Direct Known Subclasses:
    XYBubbleRenderer, XYAreaRenderer, XYBoxAndWhiskerRenderer, XYBarRenderer, StackedXYAreaRenderer2, StandardXYItemRenderer, XYStepRenderer, SignalRenderer, WindItemRenderer, YIntervalRenderer, XYAreaRenderer2, ClusteredXYBarRenderer, XYSmoothLineAndShapeRenderer, DeviationRenderer, XYLineAndShapeRenderer, XYBlockRenderer, StackedXYAreaRenderer, StackedAreaXYRenderer, XYLine3DRenderer, StackedXYBarRenderer, XYDifferenceRenderer, XYStepAreaRenderer, XYDotRenderer, XYSplineRenderer, HighLowRenderer, DefaultXYItemRenderer, VectorRenderer, CyclicXYItemRenderer, XYErrorRenderer, CandlestickRenderer

A base class that can be used to create new XYItemRenderer implementations.
Fields inherited from org.jfree.chart.renderer.AbstractRenderer:
ZERO,  DEFAULT_PAINT,  DEFAULT_OUTLINE_PAINT,  DEFAULT_STROKE,  DEFAULT_OUTLINE_STROKE,  DEFAULT_SHAPE,  DEFAULT_VALUE_LABEL_FONT,  DEFAULT_VALUE_LABEL_PAINT
Constructor:
 protected AbstractXYItemRenderer() 
Method from org.jfree.chart.renderer.xy.AbstractXYItemRenderer Summary:
addAnnotation,   addAnnotation,   addEntity,   calculateDomainMarkerTextAnchorPoint,   clone,   drawAnnotations,   drawDomainGridLine,   drawDomainLine,   drawDomainMarker,   drawItemLabel,   drawRangeLine,   drawRangeMarker,   equals,   fillDomainGridBand,   fillRangeGridBand,   findDomainBounds,   findRangeBounds,   getBaseItemLabelGenerator,   getBaseToolTipGenerator,   getDefaultEntityRadius,   getDrawingSupplier,   getItemLabelGenerator,   getItemLabelGenerator,   getLegendItem,   getLegendItemLabelGenerator,   getLegendItemToolTipGenerator,   getLegendItemURLGenerator,   getLegendItems,   getPassCount,   getPlot,   getSeriesItemLabelGenerator,   getSeriesToolTipGenerator,   getToolTipGenerator,   getToolTipGenerator,   getURLGenerator,   initialise,   isPointInRect,   removeAnnotation,   removeAnnotations,   setBaseItemLabelGenerator,   setBaseToolTipGenerator,   setDefaultEntityRadius,   setItemLabelGenerator,   setLegendItemLabelGenerator,   setLegendItemToolTipGenerator,   setLegendItemURLGenerator,   setPlot,   setSeriesItemLabelGenerator,   setSeriesToolTipGenerator,   setToolTipGenerator,   setURLGenerator,   updateCrosshairValues,   updateCrosshairValues
Methods from org.jfree.chart.renderer.AbstractRenderer:
addChangeListener,   calculateLabelAnchorPoint,   clone,   equals,   fireChangeEvent,   getAutoPopulateSeriesFillPaint,   getAutoPopulateSeriesOutlinePaint,   getAutoPopulateSeriesOutlineStroke,   getAutoPopulateSeriesPaint,   getAutoPopulateSeriesShape,   getAutoPopulateSeriesStroke,   getBaseCreateEntities,   getBaseFillPaint,   getBaseItemLabelFont,   getBaseItemLabelPaint,   getBaseItemLabelsVisible,   getBaseNegativeItemLabelPosition,   getBaseOutlinePaint,   getBaseOutlineStroke,   getBasePaint,   getBasePositiveItemLabelPosition,   getBaseSeriesVisible,   getBaseSeriesVisibleInLegend,   getBaseShape,   getBaseStroke,   getCreateEntities,   getDrawingSupplier,   getItemCreateEntity,   getItemFillPaint,   getItemLabelAnchorOffset,   getItemLabelFont,   getItemLabelFont,   getItemLabelPaint,   getItemLabelPaint,   getItemOutlinePaint,   getItemOutlineStroke,   getItemPaint,   getItemShape,   getItemStroke,   getItemVisible,   getNegativeItemLabelPosition,   getNegativeItemLabelPosition,   getPositiveItemLabelPosition,   getPositiveItemLabelPosition,   getSeriesCreateEntities,   getSeriesFillPaint,   getSeriesItemLabelFont,   getSeriesItemLabelPaint,   getSeriesNegativeItemLabelPosition,   getSeriesOutlinePaint,   getSeriesOutlineStroke,   getSeriesPaint,   getSeriesPositiveItemLabelPosition,   getSeriesShape,   getSeriesStroke,   getSeriesVisible,   getSeriesVisible,   getSeriesVisibleInLegend,   getSeriesVisibleInLegend,   hasListener,   hashCode,   isItemLabelVisible,   isSeriesItemLabelsVisible,   isSeriesVisible,   isSeriesVisibleInLegend,   lookupSeriesFillPaint,   lookupSeriesOutlinePaint,   lookupSeriesOutlineStroke,   lookupSeriesPaint,   lookupSeriesShape,   lookupSeriesStroke,   notifyListeners,   removeChangeListener,   setAutoPopulateSeriesFillPaint,   setAutoPopulateSeriesOutlinePaint,   setAutoPopulateSeriesOutlineStroke,   setAutoPopulateSeriesPaint,   setAutoPopulateSeriesShape,   setAutoPopulateSeriesStroke,   setBaseCreateEntities,   setBaseCreateEntities,   setBaseFillPaint,   setBaseFillPaint,   setBaseItemLabelFont,   setBaseItemLabelFont,   setBaseItemLabelPaint,   setBaseItemLabelPaint,   setBaseItemLabelsVisible,   setBaseItemLabelsVisible,   setBaseItemLabelsVisible,   setBaseNegativeItemLabelPosition,   setBaseNegativeItemLabelPosition,   setBaseOutlinePaint,   setBaseOutlinePaint,   setBaseOutlineStroke,   setBaseOutlineStroke,   setBasePaint,   setBasePaint,   setBasePositiveItemLabelPosition,   setBasePositiveItemLabelPosition,   setBaseSeriesVisible,   setBaseSeriesVisible,   setBaseSeriesVisibleInLegend,   setBaseSeriesVisibleInLegend,   setBaseShape,   setBaseShape,   setBaseStroke,   setBaseStroke,   setCreateEntities,   setCreateEntities,   setFillPaint,   setFillPaint,   setItemLabelAnchorOffset,   setItemLabelFont,   setItemLabelFont,   setItemLabelPaint,   setItemLabelPaint,   setItemLabelsVisible,   setItemLabelsVisible,   setItemLabelsVisible,   setNegativeItemLabelPosition,   setNegativeItemLabelPosition,   setOutlinePaint,   setOutlinePaint,   setOutlineStroke,   setOutlineStroke,   setPaint,   setPaint,   setPositiveItemLabelPosition,   setPositiveItemLabelPosition,   setSeriesCreateEntities,   setSeriesCreateEntities,   setSeriesFillPaint,   setSeriesFillPaint,   setSeriesItemLabelFont,   setSeriesItemLabelFont,   setSeriesItemLabelPaint,   setSeriesItemLabelPaint,   setSeriesItemLabelsVisible,   setSeriesItemLabelsVisible,   setSeriesItemLabelsVisible,   setSeriesNegativeItemLabelPosition,   setSeriesNegativeItemLabelPosition,   setSeriesOutlinePaint,   setSeriesOutlinePaint,   setSeriesOutlineStroke,   setSeriesOutlineStroke,   setSeriesPaint,   setSeriesPaint,   setSeriesPositiveItemLabelPosition,   setSeriesPositiveItemLabelPosition,   setSeriesShape,   setSeriesShape,   setSeriesStroke,   setSeriesStroke,   setSeriesVisible,   setSeriesVisible,   setSeriesVisible,   setSeriesVisible,   setSeriesVisibleInLegend,   setSeriesVisibleInLegend,   setSeriesVisibleInLegend,   setSeriesVisibleInLegend,   setShape,   setShape,   setStroke,   setStroke
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.jfree.chart.renderer.xy.AbstractXYItemRenderer Detail:
 public  void addAnnotation(XYAnnotation annotation) 
    Adds an annotation and sends a RendererChangeEvent to all registered listeners. The annotation is added to the foreground layer.
 public  void addAnnotation(XYAnnotation annotation,
    Layer layer) 
    Adds an annotation to the specified layer and sends a RendererChangeEvent to all registered listeners.
 protected  void addEntity(EntityCollection entities,
    Shape area,
    XYDataset dataset,
    int series,
    int item,
    double entityX,
    double entityY) 
    Adds an entity to the collection.
 protected Point2D calculateDomainMarkerTextAnchorPoint(Graphics2D g2,
    PlotOrientation orientation,
    Rectangle2D dataArea,
    Rectangle2D markerArea,
    RectangleInsets markerOffset,
    LengthAdjustmentType labelOffsetType,
    RectangleAnchor anchor) 
    Calculates the (x, y) coordinates for drawing a marker label.
 protected Object clone() throws CloneNotSupportedException 
    Returns a clone of the renderer.
 public  void drawAnnotations(Graphics2D g2,
    Rectangle2D dataArea,
    ValueAxis domainAxis,
    ValueAxis rangeAxis,
    Layer layer,
    PlotRenderingInfo info) 
    Draws all the annotations for the specified layer.
 public  void drawDomainGridLine(Graphics2D g2,
    XYPlot plot,
    ValueAxis axis,
    Rectangle2D dataArea,
    double value) 
    Draws a grid line against the range axis.
 public  void drawDomainLine(Graphics2D g2,
    XYPlot plot,
    ValueAxis axis,
    Rectangle2D dataArea,
    double value,
    Paint paint,
    Stroke stroke) 
    Draws a line perpendicular to the domain axis.
 public  void drawDomainMarker(Graphics2D g2,
    XYPlot plot,
    ValueAxis domainAxis,
    Marker marker,
    Rectangle2D dataArea) 
    Draws a vertical line on the chart to represent a 'range marker'.
 protected  void drawItemLabel(Graphics2D g2,
    PlotOrientation orientation,
    XYDataset dataset,
    int series,
    int item,
    double x,
    double y,
    boolean negative) 
    Draws an item label.
 public  void drawRangeLine(Graphics2D g2,
    XYPlot plot,
    ValueAxis axis,
    Rectangle2D dataArea,
    double value,
    Paint paint,
    Stroke stroke) 
    Draws a line perpendicular to the range axis.
 public  void drawRangeMarker(Graphics2D g2,
    XYPlot plot,
    ValueAxis rangeAxis,
    Marker marker,
    Rectangle2D dataArea) 
    Draws a horizontal line across the chart to represent a 'range marker'.
 public boolean equals(Object obj) 
    Tests this renderer for equality with another object.
 public  void fillDomainGridBand(Graphics2D g2,
    XYPlot plot,
    ValueAxis axis,
    Rectangle2D dataArea,
    double start,
    double end) 
    Fills a band between two values on the axis. This can be used to color bands between the grid lines.
 public  void fillRangeGridBand(Graphics2D g2,
    XYPlot plot,
    ValueAxis axis,
    Rectangle2D dataArea,
    double start,
    double end) 
    Fills a band between two values on the range axis. This can be used to color bands between the grid lines.
 public Range findDomainBounds(XYDataset dataset) 
    Returns the lower and upper bounds (range) of the x-values in the specified dataset.
 public Range findRangeBounds(XYDataset dataset) 
    Returns the range of values the renderer requires to display all the items from the specified dataset.
 public XYItemLabelGenerator getBaseItemLabelGenerator() 
    Returns the base item label generator.
 public XYToolTipGenerator getBaseToolTipGenerator() 
    Returns the base tool tip generator.
 public int getDefaultEntityRadius() 
    Returns the radius of the circle used for the default entity area when no area is specified.
 public DrawingSupplier getDrawingSupplier() 
    Returns the drawing supplier from the plot.
 public XYItemLabelGenerator getItemLabelGenerator() 
Deprecated! As - of version 1.0.6, this override setting should not be used. You can use the base setting instead (#getBaseItemLabelGenerator() ).

    Returns the item label generator override.
 public XYItemLabelGenerator getItemLabelGenerator(int series,
    int item) 
    Returns the label generator for a data item. This implementation simply passes control to the #getSeriesItemLabelGenerator(int) method. If, for some reason, you want a different generator for individual items, you can override this method.
 public LegendItem getLegendItem(int datasetIndex,
    int series) 
    Returns a default legend item for the specified series. Subclasses should override this method to generate customised items.
 public XYSeriesLabelGenerator getLegendItemLabelGenerator() 
    Returns the legend item label generator.
 public XYSeriesLabelGenerator getLegendItemToolTipGenerator() 
    Returns the legend item tool tip generator.
 public XYSeriesLabelGenerator getLegendItemURLGenerator() 
    Returns the legend item URL generator.
 public LegendItemCollection getLegendItems() 
    Returns a (possibly empty) collection of legend items for the series that this renderer is responsible for drawing.
 public int getPassCount() 
    Returns the number of passes through the data that the renderer requires in order to draw the chart. Most charts will require a single pass, but some require two passes.
 public XYPlot getPlot() 
    Returns the plot that the renderer is assigned to.
 public XYItemLabelGenerator getSeriesItemLabelGenerator(int series) 
    Returns the item label generator for a series.
 public XYToolTipGenerator getSeriesToolTipGenerator(int series) 
    Returns the tool tip generator for a series.
 public XYToolTipGenerator getToolTipGenerator() 
Deprecated! As - of version 1.0.6, this override setting should not be used. You can use the base setting instead (#getBaseToolTipGenerator() ).

    Returns the override tool tip generator.
 public XYToolTipGenerator getToolTipGenerator(int series,
    int item) 
    Returns the tool tip generator for a data item. If, for some reason, you want a different generator for individual items, you can override this method.
 public XYURLGenerator getURLGenerator() 
    Returns the URL generator for HTML image maps.
 public XYItemRendererState initialise(Graphics2D g2,
    Rectangle2D dataArea,
    XYPlot plot,
    XYDataset data,
    PlotRenderingInfo info) 
    Initialises the renderer and returns a state object that should be passed to all subsequent calls to the drawItem() method.

    This method will be called before the first item is rendered, giving the renderer an opportunity to initialise any state information it wants to maintain. The renderer can do nothing if it chooses.

 public static boolean isPointInRect(Rectangle2D rect,
    double x,
    double y) 
    Returns true if the specified point (x, y) falls within or on the boundary of the specified rectangle.
 public boolean removeAnnotation(XYAnnotation annotation) 
 public  void removeAnnotations() 
 public  void setBaseItemLabelGenerator(XYItemLabelGenerator generator) 
    Sets the base item label generator and sends a RendererChangeEvent to all registered listeners.
 public  void setBaseToolTipGenerator(XYToolTipGenerator generator) 
 public  void setDefaultEntityRadius(int radius) 
    Sets the radius of the circle used for the default entity area when no area is specified.
 public  void setItemLabelGenerator(XYItemLabelGenerator generator) 
Deprecated! As - of version 1.0.6, this override setting should not be used. You can use the base setting instead (#setBaseItemLabelGenerator(XYItemLabelGenerator) ).

    Sets the item label generator for ALL series and sends a RendererChangeEvent to all registered listeners.
 public  void setLegendItemLabelGenerator(XYSeriesLabelGenerator generator) 
    Sets the legend item label generator and sends a RendererChangeEvent to all registered listeners.
 public  void setLegendItemToolTipGenerator(XYSeriesLabelGenerator generator) 
    Sets the legend item tool tip generator and sends a RendererChangeEvent to all registered listeners.
 public  void setLegendItemURLGenerator(XYSeriesLabelGenerator generator) 
    Sets the legend item URL generator and sends a RendererChangeEvent to all registered listeners.
 public  void setPlot(XYPlot plot) 
    Sets the plot that the renderer is assigned to.
 public  void setSeriesItemLabelGenerator(int series,
    XYItemLabelGenerator generator) 
    Sets the item label generator for a series and sends a RendererChangeEvent to all registered listeners.
 public  void setSeriesToolTipGenerator(int series,
    XYToolTipGenerator generator) 
    Sets the tool tip generator for a series and sends a RendererChangeEvent to all registered listeners.
 public  void setToolTipGenerator(XYToolTipGenerator generator) 
Deprecated! As - of version 1.0.6, this override setting should not be used. You can use the base setting instead (#setBaseToolTipGenerator(XYToolTipGenerator) ).

    Sets the tool tip generator for ALL series and sends a RendererChangeEvent to all registered listeners.
 public  void setURLGenerator(XYURLGenerator urlGenerator) 
    Sets the URL generator for HTML image maps and sends a RendererChangeEvent to all registered listeners.
 protected  void updateCrosshairValues(CrosshairState crosshairState,
    double x,
    double y,
    double transX,
    double transY,
    PlotOrientation orientation) 
Deprecated! Use - #updateCrosshairValues(CrosshairState, double, double, int, int, double, double, PlotOrientation) -- see bug report 1086307.

    Considers the current (x, y) coordinate and updates the crosshair point if it meets the criteria (usually means the (x, y) coordinate is the closest to the anchor point so far).
 protected  void updateCrosshairValues(CrosshairState crosshairState,
    double x,
    double y,
    int domainAxisIndex,
    int rangeAxisIndex,
    double transX,
    double transY,
    PlotOrientation orientation) 
    Considers the current (x, y) coordinate and updates the crosshair point if it meets the criteria (usually means the (x, y) coordinate is the closest to the anchor point so far).