dive4elements/gnv-client: gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/PolygonPlot.java comparison

comparison gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/PolygonPlot.java @ 795:cdade5005cba

Added javadoc in jfreechart package. gnv-artifacts/trunk@877 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Ingo Weinzierl <ingo.weinzierl@intevation.de>
date	Wed, 31 Mar 2010 13:48:07 +0000
parents	c4156275c1e1
children	feae2f9d6c6f

comparison

equal deleted inserted replaced

-:d0967fdee36f
+:cdade5005cba
 import org.jfree.ui.RectangleInsets;
 import org.jfree.util.ObjectList;
 /**
+* A class for plotting polygons into a 2D chart. This plot makes use of <code>
+* PolygonRenderer</code>.
+*
 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
 */
 // TODO implement cloneable
 public class PolygonPlot
 extends      Plot
 {
+/**
+*
+*/
 public static final String PLOT_TYPE = "PolygonPlot";
+/**
+*
+*/
 public static final PlotOrientation DEFAULT_PLOT_ORIENTATION =
 PlotOrientation.VERTICAL;
 private PolygonDataset  dataset;
 private transient PolygonRenderer renderer;
 private ObjectList      rangeAxisLocation;
 private ObjectList      domainAxes;
 private ObjectList      rangeAxes;
+/**
+* Constructs a new PolygonPlot with a dataset and a renderer.
+*
+* @param dataset Dataset containing polygons.
+* @param renderer The renderer used to draw polygons.
+*/
 public PolygonPlot(PolygonDataset dataset, PolygonRenderer renderer) {
 this(dataset, renderer, null, null, PlotOrientation.HORIZONTAL);
 }
+/**
+*
+* @param dataset Dataset containing polygons.
+* @param renderer The renderer used to draw polygons.
+* @param orientation The orientation used for this plot.
+*/
 public PolygonPlot(
 PolygonDataset  dataset,
 PolygonRenderer renderer,
 PlotOrientation orientation
 ) {
 this(dataset, renderer, null, null, orientation);
 }
+/**
+*
+* @param dataset Dataset containing polygons.
+* @param renderer The renderer used to draw polygons.
+* @param domainAxis The x axis.
+* @param rangeAxis The y axis.
+* @param orientation The orientation used for this plot.
+*/
 public PolygonPlot(
 PolygonDataset  dataset,
 PolygonRenderer renderer,
 ValueAxis       domainAxis,
 ValueAxis       rangeAxis,
 configureDomainAxis();
 configureRangeAxis();
 }
+/**
+*
+*/
 public void configureDomainAxis() {
 // we just have 1 dataset
 Range domainAxisRange = getDataset().getDomainBounds();
 for (int i = 0; i < domainAxes.size(); i++) {
 axis.setRange(domainAxisRange);
 }
 }
 }
+/**
+*
+* @return
+*/
 public ValueAxis getDomainAxis() {
 return getDomainAxis(0);
 }
+/**
+*
+* @param index
+* @return
+*/
 public ValueAxis getDomainAxis(int index) {
 return index < domainAxes.size()
 ? (ValueAxis)domainAxes.get(index)
 : null;
 }
+/**
+*
+* @return
+*/
 public ValueAxis getRangeAxis() {
 return getRangeAxis(0);
 }
+/**
+*
+* @param index
+* @return
+*/
 public ValueAxis getRangeAxis(int index) {
 return index < rangeAxes.size()
 ? (ValueAxis)rangeAxes.get(index)
 : null;
 }
+/**
+*
+*/
 public  void configureRangeAxis() {
 // we just have 1 dataset
 Range rangeAxisRange = getDataset().getRangeBounds();
 for (int i = 0; i < rangeAxes.size(); i++) {
 }
 }
 }
+/**
+*
+* @return
+*/
 public PolygonDataset getDataset(){
 return this.dataset;
 }
+/**
+*
+* @return
+*/
 public String getPlotType() {
 return PLOT_TYPE;
 }
+/**
+*
+* @param dataset
+*/
 public  void setDataset(PolygonDataset dataset) {
 this.dataset = dataset;
 }
+/**
+* This is the major method to draw the into a given Graphic2D object.
+*
+* @param g2 Graphics object where the plot is drawn into.
+* @param area The bounds for drawing this plot.
+* @param anchor An anchor point.
+* @param parentState The plot state.
+* @param info
+*/
 public void draw(
 Graphics2D        g2,
 Rectangle2D       area,
 Point2D           anchor,
 PlotState         parentState,
 g2.setClip(savedClip);
 g2.setComposite(originalComposite);
 }
+/**
+* Method to draw the axis for this plot.
+*
+* @param g2
+* @param plotArea
+* @param dataArea
+* @param plotState
+*/
 private void drawAxes(
 Graphics2D        g2,
 Rectangle2D       plotArea,
 Rectangle2D       dataArea,
 PlotRenderingInfo plotState
 axisStateMap.put(axis, info);
 }
 }
+/**
+* Put some labels at data items into the plot. Uses PolygonRenderer to do
+* this job.
+*
+* @param g2
+* @param area
+* @param info
+*/
 private void drawLabels(
 Graphics2D        g2,
 Rectangle2D       area,
 PlotRenderingInfo info
 ) {
 renderer.drawLabels(g2, this, area, dataset);
 }
+/**
+* Plot the polygons. Uses PolygonRenderer to do this job.
+*
+* @param g2
+* @param area
+* @param info
+*/
 private void drawPolygons(
 Graphics2D        g2,
 Rectangle2D       area,
 PlotRenderingInfo info
 ) {
 renderer.drawPolygons(g2, this, area, dataset);
 }
+/**
+*
+* @param g2
+* @param plotArea
+* @return
+*/
 private AxisSpace calculateAxisSpace(Graphics2D  g2, Rectangle2D plotArea) {
 AxisSpace space         = new AxisSpace();
 space                   = calculateRangeAxisSpace(g2, plotArea, space);
 Rectangle2D tmpPlotArea = space.shrink(plotArea, null);
 space                   = calculateDomainAxisSpace(g2, plotArea, space);
 return space;
 }
+/**
+*
+* @param g2
+* @param plotArea
+* @param space
+* @return
+*/
 private AxisSpace calculateDomainAxisSpace(
 Graphics2D  g2,
 Rectangle2D plotArea,
 AxisSpace   space
 ) {
 return space;
 }
+/**
+*
+* @param g2
+* @param plotArea
+* @param space
+* @return
+*/
 private AxisSpace calculateRangeAxisSpace(
 Graphics2D  g2,
 Rectangle2D plotArea,
 AxisSpace   space
 ) {
 }
 return space;
 }
+/**
+*
+* @return
+*/
 public RectangleEdge getDomainAxisEdge() {
 return Plot.resolveDomainAxisLocation(
 getDomainAxisLocation(), orientation
 );
 }
+/**
+*
+* @param idx
+* @return
+*/
 public RectangleEdge getDomainAxisEdge(int idx) {
 AxisLocation  location = getDomainAxisLocation(idx);
 RectangleEdge result   = Plot.resolveDomainAxisLocation(
 location, orientation
 );
 return result;
 }
+/**
+*
+* @return
+*/
 public RectangleEdge getRangeAxisEdge() {
 return Plot.resolveRangeAxisLocation(
 getRangeAxisLocation(), orientation
 );
 }
+/**
+*
+* @param idx
+* @return
+*/
 public RectangleEdge getRangeAxisEdge(int idx) {
 AxisLocation  location = getRangeAxisLocation(idx);
 RectangleEdge result   = Plot.resolveRangeAxisLocation(
 location,
 orientation
 return result;
 }
+/**
+*
+* @return
+*/
 public AxisLocation getDomainAxisLocation() {
 return (AxisLocation) domainAxisLocation.get(0);
 }
+/**
+*
+* @param idx
+* @return
+*/
 public AxisLocation getDomainAxisLocation(int idx) {
 if (idx < domainAxisLocation.size())
 return (AxisLocation) domainAxisLocation.get(idx);
 return null;
 }
+/**
+*
+* @return
+*/
 public AxisLocation getRangeAxisLocation() {
 return (AxisLocation) rangeAxisLocation.get(0);
 }
+/**
+*
+* @param idx
+* @return
+*/
 public AxisLocation getRangeAxisLocation(int idx) {
 if (idx < rangeAxisLocation.size())
 return (AxisLocation) rangeAxisLocation.get(idx);
 return null;
 }
+/**
+*
+* @param dataset
+* @return true, if dataset is null or if it does not contain any
+* PolygonSeries, otherwise false.
+*/
 private boolean isEmptyOrNull(PolygonDataset dataset) {
 if (dataset != null) {
 int seriesCount = dataset.getSeriesCount();
 for (int s = 0; s < seriesCount; s++) {
 PolygonSeries series = dataset.getSeries(s);
 }
 }
 return true;
 }
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :

Mercurial > dive4elements > gnv-client

comparison gnv-artifacts/src/main/java/de/intevation/gnv/jfreechart/PolygonPlot.java @ 795:cdade5005cba