Document model: borders

Author: michaeldemey

model/src/main/java/com/itextpdf/model/border/DashedBorder.java

@@ -3,15 +3,29 @@
 import com.itextpdf.core.pdf.canvas.PdfCanvas;
 import com.itextpdf.core.color.Color;
 
+/**
+ * Draws a border with dashes around the element it's been set to.
+ */
 public class DashedBorder extends Border {
 
     private static final float dashModifier = 5f;
     private static final float gapModifier = 3.5f;
 
+    /**
+     * Creates a DashedBorder with the specified width and sets the color to black.
+     *
+     * @param width width of the border
+     */
     public DashedBorder(float width) {
         super(width);
     }
-    
+
+    /**
+     * Creates a DashedBorder with the specified width and the specified color.
+     *
+     * @param color color of the border
+     * @param width width of the border
+     */
     public DashedBorder(Color color, float width) {
         super(color, width);
     }

model/src/main/java/com/itextpdf/model/border/DottedBorder.java

@@ -3,13 +3,28 @@
 import com.itextpdf.core.pdf.canvas.PdfCanvas;
 import com.itextpdf.core.color.Color;
 
+/**
+ * Draws a dotted border around the element it has been set to. Do note that this border draw square dots,
+ * if you want to draw round dots, see {@link com.itextpdf.model.border.RoundDotsBorder}.
+ */
 public class DottedBorder extends Border {
+
     private static final float gapModifier = 1.5f;
 
+    /**
+     * Creates a DotterBorder instance with the specified width. The color is set to the default: black.
+     * @param width width of the border
+     */
     public DottedBorder(float width) {
         super(width);
     }
 
+    /**
+     * Creates a DottedBorder instance with the specified width and color.
+     *
+     * @param color color of the border
+     * @param width width of the border
+     */
     public DottedBorder(Color color, float width) {
         super(color, width);
     }

model/src/main/java/com/itextpdf/model/border/DoubleBorder.java

@@ -3,12 +3,30 @@
 import com.itextpdf.core.pdf.canvas.PdfCanvas;
 import com.itextpdf.core.color.Color;
 
+/**
+ * Creates a double border around the element it's set to. The space between the two border lines has
+ * the same width as the two borders. If a background has been set on the element the color will show in
+ * between the two borders.
+ */
 public class DoubleBorder extends Border{
 
+    /**
+     * Creates a DoubleBorder with the specified width for both the two borders as the space in between them.
+     * The color is set to the default: black.
+     *
+     * @param width width of the borders and the space between them
+     */
     public DoubleBorder(float width) {
         super(width);
     }
 
+    /**
+     * Creates a DoubleBorder with the specified width for both the two borders as the space in between them and
+     * the specified color for the two borders. The space in between the two borders is either colorless or will
+     * be filled with the background color of the element, if a color has been set.
+     *
+     * @param width width of the borders and the space between them
+     */
     public DoubleBorder(Color color, float width) {
         super(color, width);
     }
@@ -106,16 +124,12 @@ public void draw(PdfCanvas canvas, float x1, float y1, float x2, float y2, float
 
     @Override
     public void drawCellBorder(PdfCanvas canvas, float x1, float y1, float x2, float y2) {
-//        float x3 = 0, y3 = 0;
-//        float x4 = 0, y4 = 0;
         float thirdOfWidth = width / 3;
 
         Border.Side borderSide = getBorderSide(x1, y1, x2, y2);
 
         switch (borderSide) {
             case TOP:
-                //x1 += thirdOfWidth;
-                //x2 += 2*thirdOfWidth;
                 y1 -= thirdOfWidth;
                 y2 = y1;
                 break;

model/src/main/java/com/itextpdf/model/border/RoundDotsBorder.java

@@ -4,13 +4,27 @@
 import com.itextpdf.core.pdf.canvas.PdfCanvasConstants;
 import com.itextpdf.core.color.Color;
 
+/**
+ * Draws a border with rounded dots aroudn the element it's been set to. For square dots see {@link com.itextpdf.model.border.DottedBorder}.
+ */
 public class RoundDotsBorder extends Border {
     private static final float gapModifier = 2.5f;
 
+    /**
+     * Creates a RoundDotsBorder with the specified witµdth and sets the color to black.
+     *
+     * @param width width of the border
+     */
     public RoundDotsBorder(float width) {
         super(width);
     }
 
+    /**
+     * Creates a RoundDotsBorder with the specified witµdth and the specified color.
+     *
+     * @param color color of the border
+     * @param width width of the border
+     */
     public RoundDotsBorder(Color color, float width) {
         super(color, width);
     }

model/src/main/java/com/itextpdf/model/border/SolidBorder.java

@@ -3,12 +3,26 @@
 import com.itextpdf.core.pdf.canvas.PdfCanvas;
 import com.itextpdf.core.color.Color;
 
+/**
+ * Draws a solid border around the element it's set to.
+ */
 public class SolidBorder extends Border {
 
+    /**
+     * Creates a SolidBorder with the specified width and sets the color to black.
+     *
+     * @param width width of the border
+     */
     public SolidBorder(float width) {
         super(width);
     }
 
+    /**
+     * Creates a SolidBorder with the specified width and the specified color.
+     *
+     * @param color color of the border
+     * @param width width of the border
+     */
     public SolidBorder(Color color, float width) {
         super(color, width);
     }