Mercurial > dive4elements > river
comparison flys-artifacts/src/main/java/de/intevation/flys/exports/ChartGenerator.java @ 3270:4ac581062c40
Fix various documentation issues.
flys-artifacts/trunk@4913 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Felix Wolfsteller <felix.wolfsteller@intevation.de> |
|---|---|
| date | Tue, 10 Jul 2012 12:19:35 +0000 |
| parents | 2aca387333d6 |
| children | c27c4e06dd87 |
comparison
equal
deleted
inserted
replaced
| 3269:b2ea89a665bc | 3270:4ac581062c40 |
|---|---|
| 437 } | 437 } |
| 438 | 438 |
| 439 /** | 439 /** |
| 440 * Add the annotations (Sticky, Text and hyk zones) stored | 440 * Add the annotations (Sticky, Text and hyk zones) stored |
| 441 * in the annotations field. | 441 * in the annotations field. |
| 442 * @param plot Plot to add annotations to. | |
| 442 */ | 443 */ |
| 443 protected void addAnnotationsToRenderer(XYPlot plot) { | 444 protected void addAnnotationsToRenderer(XYPlot plot) { |
| 444 logger.debug("addAnnotationsToRenderer"); | 445 logger.debug("addAnnotationsToRenderer"); |
| 445 | 446 |
| 446 if (annotations == null || annotations.size() == 0) { | 447 if (annotations == null || annotations.size() == 0) { |
| 564 | 565 |
| 565 | 566 |
| 566 /** | 567 /** |
| 567 * Combines the ranges of the X axis at index <i>idx</i>. | 568 * Combines the ranges of the X axis at index <i>idx</i>. |
| 568 * | 569 * |
| 569 * @param range A new range. | 570 * @param bounds A new Bounds. |
| 570 * @param idx The index of the X axis that should be comined with | 571 * @param idx The index of the X axis that should be comined with |
| 571 * <i>range</i>. | 572 * <i>range</i>. |
| 572 */ | 573 */ |
| 573 protected abstract void combineXBounds(Bounds bounds, int idx); | 574 protected abstract void combineXBounds(Bounds bounds, int idx); |
| 574 | 575 |
| 575 | 576 |
| 576 /** | 577 /** |
| 577 * Combines the ranges of the Y axis at index <i>idx</i>. | 578 * Combines the ranges of the Y axis at index <i>idx</i>. |
| 578 * | 579 * |
| 579 * @param range A new range. | 580 * @param bounds A new Bounds. |
| 580 * @param idx The index of the Y axis that should be comined with | 581 * @param idx The index of the Y axis that should be comined with |
| 581 * <i>range</i>. | 582 * <i>range</i>. |
| 582 */ | 583 */ |
| 583 protected abstract void combineYBounds(Bounds bounds, int index); | 584 protected abstract void combineYBounds(Bounds bounds, int index); |
| 584 | 585 |
| 1606 | 1607 |
| 1607 /** | 1608 /** |
| 1608 * @param plot The plot. | 1609 * @param plot The plot. |
| 1609 * @param area A StyledAreaSeriesCollection object. | 1610 * @param area A StyledAreaSeriesCollection object. |
| 1610 * @param idx The index of the dataset. | 1611 * @param idx The index of the dataset. |
| 1611 * | |
| 1612 * @return | |
| 1613 */ | 1612 */ |
| 1614 protected void applyAreaTheme( | 1613 protected void applyAreaTheme( |
| 1615 XYPlot plot, | 1614 XYPlot plot, |
| 1616 StyledAreaSeriesCollection area, | 1615 StyledAreaSeriesCollection area, |
| 1617 int idx | 1616 int idx |
| 1653 | 1652 |
| 1654 | 1653 |
| 1655 /** | 1654 /** |
| 1656 * Expands a given range if it collapses into one point. | 1655 * Expands a given range if it collapses into one point. |
| 1657 * | 1656 * |
| 1658 * @param Range to be expanded if upper == lower bound. | 1657 * @param range Range to be expanded if upper == lower bound. |
| 1659 * | 1658 * |
| 1660 * @return Bounds of point plus 5 percent in each direction. | 1659 * @return Bounds of point plus 5 percent in each direction. |
| 1661 */ | 1660 */ |
| 1662 private Bounds expandPointRange(Range range) { | 1661 private Bounds expandPointRange(Range range) { |
| 1663 if (range == null) { | 1662 if (range == null) { |
| 1734 /** | 1733 /** |
| 1735 * Creates a new LegendItem with <i>name</i> and font provided by | 1734 * Creates a new LegendItem with <i>name</i> and font provided by |
| 1736 * <i>createLegendLabelFont()</i>. | 1735 * <i>createLegendLabelFont()</i>. |
| 1737 * | 1736 * |
| 1738 * @param theme The theme of the chart line. | 1737 * @param theme The theme of the chart line. |
| 1739 * @param The displayed name of the item. | 1738 * @param name The displayed name of the item. |
| 1740 * | 1739 * |
| 1741 * @return a new LegendItem instance. | 1740 * @return a new LegendItem instance. |
| 1742 */ | 1741 */ |
| 1743 public LegendItem createLegendItem(Document theme, String name) { | 1742 public LegendItem createLegendItem(Document theme, String name) { |
| 1744 // OPTIMIZE Pass font, parsed Theme items. | 1743 // OPTIMIZE Pass font, parsed Theme items. |