From 8a6adedd000f0c890c3c8c36b2b3b66bc1ddc224 Mon Sep 17 00:00:00 2001
From: Amit Kumar Mondal <mondal@fortiss.org>
Date: Wed, 16 Mar 2016 12:13:54 +0000
Subject: [PATCH] Added class level comments
---
.../spiderchart/gc/AbstractChartColor.java | 6 +++
.../spiderchart/gc/AbstractChartFont.java | 6 +++
.../spiderchart/gc/AbstractChartGraphics.java | 6 +++
.../spiderchart/gc/AbstractChartImage.java | 6 +++
.../gc/AbstractGraphicsSupplier.java | 6 +++
.../fortiss/tooling/spiderchart/gc/Fonts.java | 6 +++
.../fortiss/tooling/spiderchart/gc/Point.java | 6 +++
.../tooling/spiderchart/gc/Polygon.java | 8 +++-
.../gc/swt/SpiderChartSwtColor.java | 6 +++
.../gc/swt/SpiderChartSwtFont.java | 6 +++
.../gc/swt/SpiderChartSwtGraphics.java | 6 +++
.../gc/swt/SpiderChartSwtImage.java | 6 +++
.../gc/swt/SwtGraphicsProvider.java | 6 +++
.../spiderchart/label/SpiderChartLabel.java | 44 +++++++++++--------
.../spiderchart/legend/SpiderChartLegend.java | 12 +++--
15 files changed, 113 insertions(+), 23 deletions(-)
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartColor.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartColor.java
index 859d7c316..25fd8ee14 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartColor.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartColor.java
@@ -17,6 +17,12 @@ $Id: CLASS.java 11213 2016-03-04 16:27:08Z MONDAL $
+--------------------------------------------------------------------------*/
package org.fortiss.tooling.spiderchart.gc;
+/**
+ * Represents an abstract color
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public abstract class AbstractChartColor {
public static final String ALICEBLUE = "ALICEBLUE";
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartFont.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartFont.java
index 09d5d53ab..5f97fe632 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartFont.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartFont.java
@@ -17,6 +17,12 @@ $Id: CLASS.java 11213 2016-03-04 16:27:08Z MONDAL $
+--------------------------------------------------------------------------*/
package org.fortiss.tooling.spiderchart.gc;
+/**
+ * Represents an abstract font
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public abstract class AbstractChartFont {
public static int BOLD = 1;
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartGraphics.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartGraphics.java
index 70a2073c9..a372d03e6 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartGraphics.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartGraphics.java
@@ -17,6 +17,12 @@ $Id: CLASS.java 11213 2016-03-04 16:27:08Z MONDAL $
+--------------------------------------------------------------------------*/
package org.fortiss.tooling.spiderchart.gc;
+/**
+ * Represents an abstract graphics to be used in the chart
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public abstract class AbstractChartGraphics {
/** */
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartImage.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartImage.java
index df9c23c71..73c238a4a 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartImage.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractChartImage.java
@@ -17,6 +17,12 @@ $Id: CLASS.java 11213 2016-03-04 16:27:08Z MONDAL $
+--------------------------------------------------------------------------*/
package org.fortiss.tooling.spiderchart.gc;
+/**
+ * Represents an abstract image to be used in the chart
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public abstract class AbstractChartImage {
/** disposes the image */
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractGraphicsSupplier.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractGraphicsSupplier.java
index 33b62db7e..abe3b2389 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractGraphicsSupplier.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/AbstractGraphicsSupplier.java
@@ -24,6 +24,12 @@ import org.fortiss.tooling.spiderchart.gc.swt.SpiderChartSwtFont;
import org.fortiss.tooling.spiderchart.gc.swt.SpiderChartSwtGraphics;
import org.fortiss.tooling.spiderchart.gc.swt.SpiderChartSwtImage;
+/**
+ * Represents an abstract factory for graphics to be used in the chart
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class AbstractGraphicsSupplier {
/** Creates an image */
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/Fonts.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/Fonts.java
index d3afd9d5a..f6a35e09e 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/Fonts.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/Fonts.java
@@ -17,6 +17,12 @@ $Id: CLASS.java 11213 2016-03-04 16:27:08Z MONDAL $
+--------------------------------------------------------------------------*/
package org.fortiss.tooling.spiderchart.gc;
+/**
+ * Enumeration of the fonts to be used in the chart
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public enum Fonts {
ARIAL("Arial"), SERIF("Serif"), VERDANA("Verdana");
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/Point.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/Point.java
index a9bd220bb..ff8d2246c 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/Point.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/Point.java
@@ -17,6 +17,12 @@ $Id: CLASS.java 11213 2016-03-04 16:27:08Z MONDAL $
+--------------------------------------------------------------------------*/
package org.fortiss.tooling.spiderchart.gc;
+/**
+ * Represents a point with the given x and y-coordinate values
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class Point {
/** X coordinate */
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/Polygon.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/Polygon.java
index 643c571ba..f478ec3df 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/Polygon.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/Polygon.java
@@ -20,6 +20,12 @@ package org.fortiss.tooling.spiderchart.gc;
import java.util.ArrayList;
import java.util.List;
+/**
+ * Represents a polygon with the given list of points
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class Polygon {
/** list of points to draw the polygon */
@@ -50,7 +56,7 @@ public final class Polygon {
|| this.getY(j) <= y
&& y < this.getY(i)
&& x < (this.getX(j) - this.getX(i)) * (y - this.getY(i))
- / (this.getY(j) - this.getY(i)) + this.getX(i)) {
+ / (this.getY(j) - this.getY(i)) + this.getX(i)) {
c = !c;
}
}
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtColor.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtColor.java
index 50ed650ba..50bedf813 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtColor.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtColor.java
@@ -20,6 +20,12 @@ package org.fortiss.tooling.spiderchart.gc.swt;
import org.eclipse.swt.graphics.Color;
import org.fortiss.tooling.spiderchart.gc.AbstractChartColor;
+/**
+ * Represents a color to be used in SWT
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class SpiderChartSwtColor extends AbstractChartColor {
/** */
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtFont.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtFont.java
index f8954d047..5cd56edac 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtFont.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtFont.java
@@ -20,6 +20,12 @@ package org.fortiss.tooling.spiderchart.gc.swt;
import org.eclipse.swt.graphics.Font;
import org.fortiss.tooling.spiderchart.gc.AbstractChartFont;
+/**
+ * Represents a font to be used in SWT
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class SpiderChartSwtFont extends AbstractChartFont {
/** name of the font */
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtGraphics.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtGraphics.java
index 9205d2d7e..3cf7bd878 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtGraphics.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtGraphics.java
@@ -31,6 +31,12 @@ import org.fortiss.tooling.spiderchart.gc.AbstractChartFont;
import org.fortiss.tooling.spiderchart.gc.AbstractChartGraphics;
import org.fortiss.tooling.spiderchart.gc.AbstractChartImage;
+/**
+ * Represents a chart graphics to be used in SWT
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class SpiderChartSwtGraphics extends AbstractChartGraphics {
/** */
private float alphaValue = 1.0F;
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtImage.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtImage.java
index 9dc61b04d..154f51800 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtImage.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SpiderChartSwtImage.java
@@ -29,6 +29,12 @@ import org.fortiss.tooling.spiderchart.gc.AbstractChartColor;
import org.fortiss.tooling.spiderchart.gc.AbstractChartGraphics;
import org.fortiss.tooling.spiderchart.gc.AbstractChartImage;
+/**
+ * Represents a chart image to be used in SWT
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class SpiderChartSwtImage extends AbstractChartImage {
/** */
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SwtGraphicsProvider.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SwtGraphicsProvider.java
index e5feeb7d1..3f63a04a1 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SwtGraphicsProvider.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/gc/swt/SwtGraphicsProvider.java
@@ -20,6 +20,12 @@ package org.fortiss.tooling.spiderchart.gc.swt;
import org.eclipse.swt.graphics.Device;
import org.eclipse.swt.widgets.Display;
+/**
+ * Represents a factory for useful SWT operations
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class SwtGraphicsProvider {
/** SWT Device object */
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/label/SpiderChartLabel.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/label/SpiderChartLabel.java
index 635b03942..e4fbed6ef 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/label/SpiderChartLabel.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/label/SpiderChartLabel.java
@@ -25,6 +25,12 @@ import org.fortiss.tooling.spiderchart.label.api.IFloatingObject;
import org.fortiss.tooling.spiderchart.style.FillStyle;
import org.fortiss.tooling.spiderchart.style.LineStyle;
+/**
+ * Represents a label to be used on the spider chart
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class SpiderChartLabel implements IFloatingObject {
/** */
@@ -254,7 +260,7 @@ public final class SpiderChartLabel implements IFloatingObject {
if (this.anchorX <= this.positionX) {
this.lineToAnchor.draw(graphics, this.anchorX,
this.anchorY, this.positionX, this.positionY
- + this.requiredHeight - 1);
+ + this.requiredHeight - 1);
} else {
this.lineToAnchor.draw(graphics, this.anchorX,
this.anchorY, this.positionX + this.requiredWidth,
@@ -275,25 +281,25 @@ public final class SpiderChartLabel implements IFloatingObject {
if (this.borderShape == BORDER_RECT) {
this.background.draw(g, this.positionX, this.positionY,
this.positionX + this.requiredWidth - 1, this.positionY
- + this.requiredHeight - 1);
+ + this.requiredHeight - 1);
}
if (this.borderShape == BORDER_ROUNDRECT) {
this.background.drawRoundRect(g, this.positionX,
this.positionY,
this.positionX + this.requiredWidth - 1, this.positionY
- + this.requiredHeight - 1);
+ + this.requiredHeight - 1);
}
if (this.borderShape == BORDER_OVAL) {
this.background
- .drawArc(
- g,
- (int) (this.positionX - this.requiredWidth * 0.1D),
- (int) (this.positionY - this.requiredHeight * 0.1D),
- (int) (this.requiredWidth + this.requiredWidth
- * 0.2D - 1.0D),
+ .drawArc(
+ g,
+ (int) (this.positionX - this.requiredWidth * 0.1D),
+ (int) (this.positionY - this.requiredHeight * 0.1D),
+ (int) (this.requiredWidth + this.requiredWidth
+ * 0.2D - 1.0D),
(int) (this.requiredHeight
+ this.requiredHeight * 0.3D - 1.0D),
- 0, 360);
+ 0, 360);
}
g.setColor(c);
}
@@ -311,24 +317,24 @@ public final class SpiderChartLabel implements IFloatingObject {
if (this.borderShape == BORDER_RECT) {
this.border.drawRect(g, this.positionX, this.positionY,
this.positionX + this.requiredWidth - 1, this.positionY
- + this.requiredHeight - 1);
+ + this.requiredHeight - 1);
}
if (this.borderShape == BORDER_ROUNDRECT) {
this.border.drawRoundRect(g, this.positionX, this.positionY,
this.positionX + this.requiredWidth - 1, this.positionY
- + this.requiredHeight - 1);
+ + this.requiredHeight - 1);
}
if (this.borderShape == BORDER_OVAL) {
this.border
- .drawArc(
- g,
- (int) (this.positionX - this.requiredWidth * 0.1D),
- (int) (this.positionY - this.requiredHeight * 0.1D),
- (int) (this.requiredWidth + this.requiredWidth
- * 0.2D - 1.0D),
+ .drawArc(
+ g,
+ (int) (this.positionX - this.requiredWidth * 0.1D),
+ (int) (this.positionY - this.requiredHeight * 0.1D),
+ (int) (this.requiredWidth + this.requiredWidth
+ * 0.2D - 1.0D),
(int) (this.requiredHeight
+ this.requiredHeight * 0.3D - 1.0D),
- 0, 360);
+ 0, 360);
}
}
this.clickableArea = new Polygon();
diff --git a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/legend/SpiderChartLegend.java b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/legend/SpiderChartLegend.java
index 689e81205..bd08a005a 100644
--- a/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/legend/SpiderChartLegend.java
+++ b/org.fortiss.tooling.spiderchart.ui/trunk/src/org/fortiss/tooling/spiderchart/legend/SpiderChartLegend.java
@@ -39,6 +39,12 @@ import org.fortiss.tooling.spiderchart.label.SpiderChartLabel;
import org.fortiss.tooling.spiderchart.style.FillStyle;
import org.fortiss.tooling.spiderchart.style.LineStyle;
+/**
+ * Represents legend to be used on the spider chart
+ *
+ * @author AMIT KUMAR MONDAL
+ *
+ */
public final class SpiderChartLegend extends SpiderChartComponent {
/** Legend Background Style */
@@ -209,7 +215,7 @@ public final class SpiderChartLegend extends SpiderChartComponent {
final FillStyle f = (FillStyle) icon;
f.draw(g, toCenterX + this.x + offset, toCenterY + this.y,
toCenterX + this.x + offset + sidelentgh, toCenterY
- + this.y + sidelentgh);
+ + this.y + sidelentgh);
}
offset = offset + iconWidth + iconSeparator + textWidth
+ textSeparator;
@@ -290,8 +296,8 @@ public final class SpiderChartLegend extends SpiderChartComponent {
l.draw(g, toCenterX + this.x, toCenterY + this.y + iconHeight
/ 2 + (i - 1) * itemHeight + this.legendOffset,
toCenterX + this.x + iconWidth - 2, toCenterY + this.y
- + iconHeight / 2 + (i - 1) * itemHeight
- + this.legendOffset);
+ + iconHeight / 2 + (i - 1) * itemHeight
+ + this.legendOffset);
}
}
}
--
GitLab