moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Replace the single method JavaDoc copied from the JDK with our own documentation, which is possibly also easier to grok

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@544197 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2007-06-04 18:22:18 +00:00
parent b813444d47
commit d2a19f329c
2 changed files with 34 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java
View File

@ -351,6 +351,25 @@ public class EscherGraphics
shape.setLineStyleColor(foreground.getRed(), foreground.getGreen(), foreground.getBlue()); shape.setLineStyleColor(foreground.getRed(), foreground.getGreen(), foreground.getBlue());
} }
/**
* Fills a (closed) polygon, as defined by a pair of arrays, which
* hold the <i>x</i> and <i>y</i> coordinates.
* <p>
* This draws the polygon, with <code>nPoint</code> line segments.
* The first <code>nPoint&nbsp;-&nbsp;1</code> line segments are
* drawn between sequential points
* (<code>xPoints[i],yPoints[i],xPoints[i+1],yPoints[i+1]</code>).
* The final line segment is a closing one, from the last point to
* the first (assuming they are different).
* <p>
* The area inside of the polygon is defined by using an
* even-odd fill rule (also known as the alternating rule), and
* the area inside of it is filled.
* @param xPoints array of the <code>x</code> coordinates.
* @param yPoints array of the <code>y</code> coordinates.
* @param nPoints the total number of points in the polygon.
* @see java.awt.Graphics#drawPolygon(int[], int[], int)
*/
public void fillPolygon(int xPoints[], int yPoints[], public void fillPolygon(int xPoints[], int yPoints[],
int nPoints) int nPoints)
{ {

31
src/java/org/apache/poi/hssf/usermodel/EscherGraphics2d.java
View File

@ -329,24 +329,23 @@ public class EscherGraphics2d extends Graphics2D
} }
/** /**
* Fills a closed polygon defined by * Fills a (closed) polygon, as defined by a pair of arrays, which
* arrays of <i>x</i> and <i>y</i> coordinates. * hold the <i>x</i> and <i>y</i> coordinates.
* <p> * <p>
* This method draws the polygon defined by <code>nPoint</code> line * This draws the polygon, with <code>nPoint</code> line segments.
* segments, where the first <code>nPoint&nbsp;-&nbsp;1</code> * The first <code>nPoint&nbsp;-&nbsp;1</code> line segments are
* line segments are line segments from * drawn between sequential points
* <code>(xPoints[i&nbsp;-&nbsp;1],&nbsp;yPoints[i&nbsp;-&nbsp;1])</code> * (<code>xPoints[i],yPoints[i],xPoints[i+1],yPoints[i+1]</code>).
* to <code>(xPoints[i],&nbsp;yPoints[i])</code>, for * The final line segment is a closing one, from the last point to
* 1&nbsp;&le;&nbsp;<i>i</i>&nbsp;&le;&nbsp;<code>nPoints</code>. * the first (assuming they are different).
* The figure is automatically closed by drawing a line connecting
* the final point to the first point, if those points are different.
* <p> * <p>
* The area inside the polygon is defined using an * The area inside of the polygon is defined by using an
* even-odd fill rule, also known as the alternating rule. * even-odd fill rule (also known as the alternating rule), and
* @param xPoints a an array of <code>x</code> coordinates. * the area inside of it is filled.
* @param yPoints a an array of <code>y</code> coordinates. * @param xPoints array of the <code>x</code> coordinates.
* @param nPoints a the total number of points. * @param yPoints array of the <code>y</code> coordinates.
* @see java.awt.Graphics#drawPolygon(int[], int[], int) * @param nPoints the total number of points in the polygon.
* @see java.awt.Graphics#drawPolygon(int[], int[], int)
*/ */
public void fillPolygon(int xPoints[], int yPoints[], int nPoints) public void fillPolygon(int xPoints[], int yPoints[], int nPoints)
{ {