Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFHyperlinkRun.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFHyperlinkRun.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFHyperlinkRun.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFHyperlinkRun.html Sun May 31 21:20:33 2015 @@ -171,7 +171,7 @@ extends <a href="../../../../../org/apac <td class="colFirst"><code><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFHyperlink.html" title="class in org.apache.poi.xwpf.usermodel">XWPFHyperlink</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFHyperlinkRun.html#getHyperlink(org.apache.poi.xwpf.usermodel.XWPFDocument)">getHyperlink</a></strong>(<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html" title="class in org.apache.poi.xwpf.usermodel">XWPFDocument</a> document)</code> <div class="block">If this Hyperlink is an external reference hyperlink, - return the object for it.</div> + return the object for it.</div> </td> </tr> <tr class="rowColor"> @@ -277,7 +277,7 @@ extends <a href="../../../../../org/apac <h4>getHyperlink</h4> <pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFHyperlink.html" title="class in org.apache.poi.xwpf.usermodel">XWPFHyperlink</a> getHyperlink(<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html" title="class in org.apache.poi.xwpf.usermodel">XWPFDocument</a> document)</pre> <div class="block">If this Hyperlink is an external reference hyperlink, - return the object for it.</div> + return the object for it.</div> </li> </ul> </li>
Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFNum.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFNum.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFNum.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFNum.html Sun May 31 21:20:33 2015 @@ -271,22 +271,22 @@ extends java.lang.Object</pre> <pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFNumbering.html" title="class in org.apache.poi.xwpf.usermodel">XWPFNumbering</a> getNumbering()</pre> </li> </ul> -<a name="getCTNum()"> +<a name="setNumbering(org.apache.poi.xwpf.usermodel.XWPFNumbering)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getCTNum</h4> -<pre>public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTNum getCTNum()</pre> +<h4>setNumbering</h4> +<pre>public void setNumbering(<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFNumbering.html" title="class in org.apache.poi.xwpf.usermodel">XWPFNumbering</a> numbering)</pre> </li> </ul> -<a name="setNumbering(org.apache.poi.xwpf.usermodel.XWPFNumbering)"> +<a name="getCTNum()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setNumbering</h4> -<pre>public void setNumbering(<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFNumbering.html" title="class in org.apache.poi.xwpf.usermodel">XWPFNumbering</a> numbering)</pre> +<h4>getCTNum</h4> +<pre>public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTNum getCTNum()</pre> </li> </ul> <a name="setCTNum(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTNum)"> Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFNumbering.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFNumbering.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFNumbering.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFNumbering.html Sun May 31 21:20:33 2015 @@ -217,8 +217,8 @@ extends <a href="../../../../../org/apac <td class="colFirst"><code>java.math.BigInteger</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFNumbering.html#getAbstractNumID(java.math.BigInteger)">getAbstractNumID</a></strong>(java.math.BigInteger numID)</code> <div class="block">return the abstractNumID -If the AbstractNumID not exists -return null</div> + If the AbstractNumID not exists + return null</div> </td> </tr> <tr class="rowColor"> @@ -398,7 +398,7 @@ return null</div> <pre>public boolean numExist(java.math.BigInteger numID)</pre> <div class="block">Checks whether number with numID exists</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>numID</code> - </dd> -<dt><span class="strong">Returns:</span></dt><dd>boolean true if num exist, false if num not exist</dd></dl> +<dt><span class="strong">Returns:</span></dt><dd>boolean true if num exist, false if num not exist</dd></dl> </li> </ul> <a name="addNum(org.apache.poi.xwpf.usermodel.XWPFNum)"> @@ -444,8 +444,8 @@ return null</div> <pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFNum.html" title="class in org.apache.poi.xwpf.usermodel">XWPFNum</a> getNum(java.math.BigInteger numID)</pre> <div class="block">get Num by NumID</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>numID</code> - </dd> -<dt><span class="strong">Returns:</span></dt><dd>abstractNum with NumId if no Num exists with that NumID - null will be returned</dd></dl> +<dt><span class="strong">Returns:</span></dt><dd>abstractNum with NumId if no Num exists with that NumID + null will be returned</dd></dl> </li> </ul> <a name="getAbstractNum(java.math.BigInteger)"> @@ -457,8 +457,8 @@ return null</div> <pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFAbstractNum.html" title="class in org.apache.poi.xwpf.usermodel">XWPFAbstractNum</a> getAbstractNum(java.math.BigInteger abstractNumID)</pre> <div class="block">get AbstractNum by abstractNumID</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>abstractNumID</code> - </dd> -<dt><span class="strong">Returns:</span></dt><dd>abstractNum with abstractNumId if no abstractNum exists with that abstractNumID - null will be returned</dd></dl> +<dt><span class="strong">Returns:</span></dt><dd>abstractNum with abstractNumId if no abstractNum exists with that abstractNumID + null will be returned</dd></dl> </li> </ul> <a name="getIdOfAbstractNum(org.apache.poi.xwpf.usermodel.XWPFAbstractNum)"> @@ -497,7 +497,7 @@ return null</div> <div class="block">remove an existing abstractNum</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>abstractNumID</code> - </dd> <dt><span class="strong">Returns:</span></dt><dd>true if abstractNum with abstractNumID exists in NumberingArray, - false if abstractNum with abstractNumID not exists</dd></dl> + false if abstractNum with abstractNumID not exists</dd></dl> </li> </ul> <a name="getAbstractNumID(java.math.BigInteger)"> @@ -508,8 +508,8 @@ return null</div> <h4>getAbstractNumID</h4> <pre>public java.math.BigInteger getAbstractNumID(java.math.BigInteger numID)</pre> <div class="block">return the abstractNumID -If the AbstractNumID not exists -return null</div> + If the AbstractNumID not exists + return null</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>numID</code> - </dd> <dt><span class="strong">Returns:</span></dt><dd>abstractNumID</dd></dl> </li> Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFParagraph.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFParagraph.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFParagraph.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFParagraph.html Sun May 31 21:20:33 2015 @@ -101,11 +101,11 @@ <pre>public class <span class="strong">XWPFParagraph</span> extends java.lang.Object implements <a href="../../../../../org/apache/poi/xwpf/usermodel/IBodyElement.html" title="interface in org.apache.poi.xwpf.usermodel">IBodyElement</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/IRunBody.html" title="interface in org.apache.poi.xwpf.usermodel">IRunBody</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/ISDTContents.html" title="interface in org.apache.poi.xwpf.usermodel">ISDTContents</a>, <a href="../../../../../org/apache/poi/wp/usermodel/Paragraph.html" title="interface in org.apache.poi.wp.usermodel">Paragraph</a></pre> -<div class="block"><p>A Paragraph within a Document, Table, Header etc.</p> - +<div class="block"><p>A Paragraph within a Document, Table, Header etc.</p> + <p/> <p>A paragraph has a lot of styling information, but the - actual text (possibly along with more styling) is held on - the child <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFRun.html" title="class in org.apache.poi.xwpf.usermodel"><code>XWPFRun</code></a>s.</p></div> + actual text (possibly along with more styling) is held on + the child <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFRun.html" title="class in org.apache.poi.xwpf.usermodel"><code>XWPFRun</code></a>s.</p></div> </li> </ul> </div> @@ -178,7 +178,7 @@ implements <a href="../../../../../org/a <tr class="altColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#addRun(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR)">addRun</a></strong>(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR run)</code> -<div class="block">add a new run at the end of the position of +<div class="block">add a new run at the end of the position of the content of parameter run</div> </td> </tr> @@ -323,7 +323,7 @@ implements <a href="../../../../../org/a <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#getNumFmt()">getNumFmt</a></strong>()</code> <div class="block">Returns numbering format for this paragraph, eg bullet or - lowerLetter.</div> + lowerLetter.</div> </td> </tr> <tr class="altColor"> @@ -842,6 +842,17 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Returns:</span></dt><dd>NumID as BigInteger</dd></dl> </li> </ul> +<a name="setNumID(java.math.BigInteger)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setNumID</h4> +<pre>public void setNumID(java.math.BigInteger numPos)</pre> +<div class="block">setNumID of Paragraph</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>numPos</code> - </dd></dl> +</li> +</ul> <a name="getNumIlvl()"> <!-- --> </a> @@ -862,7 +873,7 @@ public org.openxmlformats.schemas.w <h4>getNumFmt</h4> <pre>public java.lang.String getNumFmt()</pre> <div class="block">Returns numbering format for this paragraph, eg bullet or - lowerLetter. + lowerLetter. Returns null if this paragraph does not have numeric style.</div> </li> </ul> @@ -888,17 +899,6 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Returns:</span></dt><dd>returns the overridden start number or null if there is no override for this paragraph.</dd></dl> </li> </ul> -<a name="setNumID(java.math.BigInteger)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setNumID</h4> -<pre>public void setNumID(java.math.BigInteger numPos)</pre> -<div class="block">setNumID of Paragraph</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>numPos</code> - </dd></dl> -</li> -</ul> <a name="getParagraphText()"> <!-- --> </a> @@ -1046,6 +1046,19 @@ public org.openxmlformats.schemas.w paragraph.</dd></dl> </li> </ul> +<a name="getBorderTop()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBorderTop</h4> +<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel">Borders</a> getBorderTop()</pre> +<div class="block">Specifies the border which shall be displayed above a set of paragraphs + which have the same set of paragraph border settings.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>paragraphBorder - the top border for the paragraph</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setBorderTop(org.apache.poi.xwpf.usermodel.Borders)"><code>setBorderTop(Borders)</code></a>, +<a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel"><code>a list of all types of borders</code></a></dd></dl> +</li> +</ul> <a name="setBorderTop(org.apache.poi.xwpf.usermodel.Borders)"> <!-- --> </a> @@ -1078,16 +1091,16 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Parameters:</span></dt><dd><code>border</code> - </dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel"><code>for a list of all types of borders</code></a></dd></dl> </li> </ul> -<a name="getBorderTop()"> +<a name="getBorderBottom()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getBorderTop</h4> -<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel">Borders</a> getBorderTop()</pre> -<div class="block">Specifies the border which shall be displayed above a set of paragraphs - which have the same set of paragraph border settings.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>paragraphBorder - the top border for the paragraph</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setBorderTop(org.apache.poi.xwpf.usermodel.Borders)"><code>setBorderTop(Borders)</code></a>, +<h4>getBorderBottom</h4> +<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel">Borders</a> getBorderBottom()</pre> +<div class="block">Specifies the border which shall be displayed below a set of + paragraphs which have the same set of paragraph border settings.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>paragraphBorder - the bottom border for the paragraph</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setBorderBottom(org.apache.poi.xwpf.usermodel.Borders)"><code>setBorderBottom(Borders)</code></a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel"><code>a list of all types of borders</code></a></dd></dl> </li> </ul> @@ -1123,17 +1136,17 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Parameters:</span></dt><dd><code>border</code> - </dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel"><code>a list of all types of borders</code></a></dd></dl> </li> </ul> -<a name="getBorderBottom()"> +<a name="getBorderLeft()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getBorderBottom</h4> -<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel">Borders</a> getBorderBottom()</pre> -<div class="block">Specifies the border which shall be displayed below a set of - paragraphs which have the same set of paragraph border settings.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>paragraphBorder - the bottom border for the paragraph</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setBorderBottom(org.apache.poi.xwpf.usermodel.Borders)"><code>setBorderBottom(Borders)</code></a>, -<a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel"><code>a list of all types of borders</code></a></dd></dl> +<h4>getBorderLeft</h4> +<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel">Borders</a> getBorderLeft()</pre> +<div class="block">Specifies the border which shall be displayed on the left side of the + page around the specified paragraph.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>ParagraphBorder - the left border for the paragraph</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setBorderLeft(org.apache.poi.xwpf.usermodel.Borders)"><code>setBorderLeft(Borders)</code></a>, +<a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel"><code>for a list of all possible borders</code></a></dd></dl> </li> </ul> <a name="setBorderLeft(org.apache.poi.xwpf.usermodel.Borders)"> @@ -1163,16 +1176,16 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Parameters:</span></dt><dd><code>border</code> - </dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel"><code>for a list of all possible borders</code></a></dd></dl> </li> </ul> -<a name="getBorderLeft()"> +<a name="getBorderRight()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getBorderLeft</h4> -<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel">Borders</a> getBorderLeft()</pre> -<div class="block">Specifies the border which shall be displayed on the left side of the +<h4>getBorderRight</h4> +<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel">Borders</a> getBorderRight()</pre> +<div class="block">Specifies the border which shall be displayed on the right side of the page around the specified paragraph.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>ParagraphBorder - the left border for the paragraph</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setBorderLeft(org.apache.poi.xwpf.usermodel.Borders)"><code>setBorderLeft(Borders)</code></a>, +<dl><dt><span class="strong">Returns:</span></dt><dd>ParagraphBorder - the right border for the paragraph</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setBorderRight(org.apache.poi.xwpf.usermodel.Borders)"><code>setBorderRight(Borders)</code></a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel"><code>for a list of all possible borders</code></a></dd></dl> </li> </ul> @@ -1203,16 +1216,16 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Parameters:</span></dt><dd><code>border</code> - </dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel"><code>for a list of all possible borders</code></a></dd></dl> </li> </ul> -<a name="getBorderRight()"> +<a name="getBorderBetween()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getBorderRight</h4> -<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel">Borders</a> getBorderRight()</pre> -<div class="block">Specifies the border which shall be displayed on the right side of the - page around the specified paragraph.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>ParagraphBorder - the right border for the paragraph</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setBorderRight(org.apache.poi.xwpf.usermodel.Borders)"><code>setBorderRight(Borders)</code></a>, +<h4>getBorderBetween</h4> +<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel">Borders</a> getBorderBetween()</pre> +<div class="block">Specifies the border which shall be displayed between each paragraph in a + set of paragraphs which have the same set of paragraph border settings.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>ParagraphBorder - the between border for the paragraph</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setBorderBetween(org.apache.poi.xwpf.usermodel.Borders)"><code>setBorderBetween(Borders)</code></a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel"><code>for a list of all possible borders</code></a></dd></dl> </li> </ul> @@ -1247,26 +1260,13 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Parameters:</span></dt><dd><code>border</code> - </dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel"><code>for a list of all possible borders</code></a></dd></dl> </li> </ul> -<a name="getBorderBetween()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getBorderBetween</h4> -<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel">Borders</a> getBorderBetween()</pre> -<div class="block">Specifies the border which shall be displayed between each paragraph in a - set of paragraphs which have the same set of paragraph border settings.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>ParagraphBorder - the between border for the paragraph</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setBorderBetween(org.apache.poi.xwpf.usermodel.Borders)"><code>setBorderBetween(Borders)</code></a>, -<a href="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel"><code>for a list of all possible borders</code></a></dd></dl> -</li> -</ul> -<a name="setPageBreak(boolean)"> +<a name="isPageBreak()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setPageBreak</h4> -<pre>public void setPageBreak(boolean pageBreak)</pre> +<h4>isPageBreak</h4> +<pre>public boolean isPageBreak()</pre> <div class="block">Specifies that when rendering this document in a paginated view, the contents of this paragraph are rendered on the start of a new page in the document. @@ -1278,17 +1278,16 @@ public org.openxmlformats.schemas.w shall not be applied. Since the paragraph is specified to start on a new page, it begins page two even though it could have fit on page one. </p></div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pageBreak</code> - - - boolean value</dd></dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>boolean - if page break is set</dd></dl> </li> </ul> -<a name="isPageBreak()"> +<a name="setPageBreak(boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>isPageBreak</h4> -<pre>public boolean isPageBreak()</pre> +<h4>setPageBreak</h4> +<pre>public void setPageBreak(boolean pageBreak)</pre> <div class="block">Specifies that when rendering this document in a paginated view, the contents of this paragraph are rendered on the start of a new page in the document. @@ -1300,7 +1299,20 @@ public org.openxmlformats.schemas.w shall not be applied. Since the paragraph is specified to start on a new page, it begins page two even though it could have fit on page one. </p></div> -<dl><dt><span class="strong">Returns:</span></dt><dd>boolean - if page break is set</dd></dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pageBreak</code> - - + boolean value</dd></dl> +</li> +</ul> +<a name="getSpacingAfter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSpacingAfter</h4> +<pre>public int getSpacingAfter()</pre> +<div class="block">Specifies the spacing that should be added after the last line in this + paragraph in the document in absolute units.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>int - value representing the spacing after the paragraph</dd></dl> </li> </ul> <a name="setSpacingAfter(int)"> @@ -1321,16 +1333,16 @@ public org.openxmlformats.schemas.w measurement in twentieths of a point.</dd></dl> </li> </ul> -<a name="getSpacingAfter()"> +<a name="getSpacingAfterLines()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getSpacingAfter</h4> -<pre>public int getSpacingAfter()</pre> +<h4>getSpacingAfterLines</h4> +<pre>public int getSpacingAfterLines()</pre> <div class="block">Specifies the spacing that should be added after the last line in this paragraph in the document in absolute units.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>int - value representing the spacing after the paragraph</dd></dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>bigInteger - value representing the spacing after the paragraph</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setSpacingAfterLines(int)"><code>setSpacingAfterLines(int)</code></a></dd></dl> </li> </ul> <a name="setSpacingAfterLines(int)"> @@ -1356,16 +1368,16 @@ public org.openxmlformats.schemas.w measurement in twentieths of a</dd></dl> </li> </ul> -<a name="getSpacingAfterLines()"> +<a name="getSpacingBefore()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getSpacingAfterLines</h4> -<pre>public int getSpacingAfterLines()</pre> -<div class="block">Specifies the spacing that should be added after the last line in this +<h4>getSpacingBefore</h4> +<pre>public int getSpacingBefore()</pre> +<div class="block">Specifies the spacing that should be added above the first line in this paragraph in the document in absolute units.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>bigInteger - value representing the spacing after the paragraph</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setSpacingAfterLines(int)"><code>setSpacingAfterLines(int)</code></a></dd></dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>the spacing that should be added above the first line</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setSpacingBefore(int)"><code>setSpacingBefore(int)</code></a></dd></dl> </li> </ul> <a name="setSpacingBefore(int)"> @@ -1384,16 +1396,17 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Parameters:</span></dt><dd><code>spaces</code> - </dd></dl> </li> </ul> -<a name="getSpacingBefore()"> +<a name="getSpacingBeforeLines()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getSpacingBefore</h4> -<pre>public int getSpacingBefore()</pre> -<div class="block">Specifies the spacing that should be added above the first line in this - paragraph in the document in absolute units.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the spacing that should be added above the first line</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setSpacingBefore(int)"><code>setSpacingBefore(int)</code></a></dd></dl> +<h4>getSpacingBeforeLines</h4> +<pre>public int getSpacingBeforeLines()</pre> +<div class="block">Specifies the spacing that should be added before the first line in this paragraph in the + document in line units. + The value of this attribute is specified in one hundredths of a line.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the spacing that should be added before the first line in this paragraph</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setSpacingBeforeLines(int)"><code>setSpacingBeforeLines(int)</code></a></dd></dl> </li> </ul> <a name="setSpacingBeforeLines(int)"> @@ -1414,17 +1427,18 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Parameters:</span></dt><dd><code>spaces</code> - </dd></dl> </li> </ul> -<a name="getSpacingBeforeLines()"> +<a name="getSpacingLineRule()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getSpacingBeforeLines</h4> -<pre>public int getSpacingBeforeLines()</pre> -<div class="block">Specifies the spacing that should be added before the first line in this paragraph in the - document in line units. - The value of this attribute is specified in one hundredths of a line.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the spacing that should be added before the first line in this paragraph</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setSpacingBeforeLines(int)"><code>setSpacingBeforeLines(int)</code></a></dd></dl> +<h4>getSpacingLineRule</h4> +<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/LineSpacingRule.html" title="enum in org.apache.poi.xwpf.usermodel">LineSpacingRule</a> getSpacingLineRule()</pre> +<div class="block">Specifies how the spacing between lines is calculated as stored in the + line attribute. If this attribute is omitted, then it shall be assumed to + be of a value auto if a line attribute value is present.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>rule</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/LineSpacingRule.html" title="enum in org.apache.poi.xwpf.usermodel"><code>LineSpacingRule</code></a>, +<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setSpacingLineRule(org.apache.poi.xwpf.usermodel.LineSpacingRule)"><code>setSpacingLineRule(LineSpacingRule)</code></a></dd></dl> </li> </ul> <a name="setSpacingLineRule(org.apache.poi.xwpf.usermodel.LineSpacingRule)"> @@ -1440,18 +1454,23 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Parameters:</span></dt><dd><code>rule</code> - </dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/LineSpacingRule.html" title="enum in org.apache.poi.xwpf.usermodel"><code>LineSpacingRule</code></a></dd></dl> </li> </ul> -<a name="getSpacingLineRule()"> +<a name="getIndentationLeft()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getSpacingLineRule</h4> -<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/LineSpacingRule.html" title="enum in org.apache.poi.xwpf.usermodel">LineSpacingRule</a> getSpacingLineRule()</pre> -<div class="block">Specifies how the spacing between lines is calculated as stored in the - line attribute. If this attribute is omitted, then it shall be assumed to - be of a value auto if a line attribute value is present.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>rule</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/LineSpacingRule.html" title="enum in org.apache.poi.xwpf.usermodel"><code>LineSpacingRule</code></a>, -<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFParagraph.html#setSpacingLineRule(org.apache.poi.xwpf.usermodel.LineSpacingRule)"><code>setSpacingLineRule(LineSpacingRule)</code></a></dd></dl> +<h4>getIndentationLeft</h4> +<pre>public int getIndentationLeft()</pre> +<div class="block">Specifies the indentation which shall be placed between the left text + margin for this paragraph and the left edge of that paragraph's content + in a left to right paragraph, and the right text margin and the right + edge of that paragraph's text in a right to left paragraph + <p/> + If this attribute is omitted, its value shall be assumed to be zero. + Negative values are defined such that the text is moved past the text margin, + positive values move the text inside the text margin. + </p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>indentation or null if indentation is not set</dd></dl> </li> </ul> <a name="setIndentationLeft(int)"> @@ -1473,15 +1492,15 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Parameters:</span></dt><dd><code>indentation</code> - </dd></dl> </li> </ul> -<a name="getIndentationLeft()"> +<a name="getIndentationRight()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getIndentationLeft</h4> -<pre>public int getIndentationLeft()</pre> -<div class="block">Specifies the indentation which shall be placed between the left text - margin for this paragraph and the left edge of that paragraph's content +<h4>getIndentationRight</h4> +<pre>public int getIndentationRight()</pre> +<div class="block">Specifies the indentation which shall be placed between the right text + margin for this paragraph and the right edge of that paragraph's content in a left to right paragraph, and the right text margin and the right edge of that paragraph's text in a right to left paragraph <p/> @@ -1511,22 +1530,22 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Parameters:</span></dt><dd><code>indentation</code> - </dd></dl> </li> </ul> -<a name="getIndentationRight()"> +<a name="getIndentationHanging()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getIndentationRight</h4> -<pre>public int getIndentationRight()</pre> -<div class="block">Specifies the indentation which shall be placed between the right text - margin for this paragraph and the right edge of that paragraph's content - in a left to right paragraph, and the right text margin and the right - edge of that paragraph's text in a right to left paragraph - <p/> - If this attribute is omitted, its value shall be assumed to be zero. - Negative values are defined such that the text is moved past the text margin, - positive values move the text inside the text margin. - </p></div> +<h4>getIndentationHanging</h4> +<pre>public int getIndentationHanging()</pre> +<div class="block">Specifies the indentation which shall be removed from the first line of + the parent paragraph, by moving the indentation on the first line back + towards the beginning of the direction of text flow. + This indentation is + specified relative to the paragraph indentation which is specified for + all other lines in the parent paragraph. + The firstLine and hanging + attributes are mutually exclusive, if both are specified, then the + firstLine value is ignored.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>indentation or null if indentation is not set</dd></dl> </li> </ul> @@ -1549,32 +1568,13 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Parameters:</span></dt><dd><code>indentation</code> - </dd></dl> </li> </ul> -<a name="getIndentationHanging()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getIndentationHanging</h4> -<pre>public int getIndentationHanging()</pre> -<div class="block">Specifies the indentation which shall be removed from the first line of - the parent paragraph, by moving the indentation on the first line back - towards the beginning of the direction of text flow. - This indentation is - specified relative to the paragraph indentation which is specified for - all other lines in the parent paragraph. - The firstLine and hanging - attributes are mutually exclusive, if both are specified, then the - firstLine value is ignored.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>indentation or null if indentation is not set</dd></dl> -</li> -</ul> -<a name="setIndentationFirstLine(int)"> +<a name="getIndentationFirstLine()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setIndentationFirstLine</h4> -<pre>public void setIndentationFirstLine(int indentation)</pre> +<h4>getIndentationFirstLine</h4> +<pre>public int getIndentationFirstLine()</pre> <div class="block">Specifies the additional indentation which shall be applied to the first line of the parent paragraph. This additional indentation is specified relative to the paragraph indentation which is specified for all other @@ -1583,18 +1583,19 @@ public org.openxmlformats.schemas.w mutually exclusive, if both are specified, then the firstLine value is ignored. If the firstLineChars attribute is also specified, then this - value is ignored. If this attribute is omitted, then its value shall be + value is ignored. + If this attribute is omitted, then its value shall be assumed to be zero (if needed).</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indentation</code> - </dd></dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>indentation or null if indentation is not set</dd></dl> </li> </ul> -<a name="getIndentationFirstLine()"> +<a name="setIndentationFirstLine(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getIndentationFirstLine</h4> -<pre>public int getIndentationFirstLine()</pre> +<h4>setIndentationFirstLine</h4> +<pre>public void setIndentationFirstLine(int indentation)</pre> <div class="block">Specifies the additional indentation which shall be applied to the first line of the parent paragraph. This additional indentation is specified relative to the paragraph indentation which is specified for all other @@ -1603,10 +1604,9 @@ public org.openxmlformats.schemas.w mutually exclusive, if both are specified, then the firstLine value is ignored. If the firstLineChars attribute is also specified, then this - value is ignored. - If this attribute is omitted, then its value shall be + value is ignored. If this attribute is omitted, then its value shall be assumed to be zero (if needed).</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>indentation or null if indentation is not set</dd></dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>indentation</code> - </dd></dl> </li> </ul> <a name="getIndentFromLeft()"> @@ -1687,49 +1687,38 @@ public org.openxmlformats.schemas.w </dl> </li> </ul> -<a name="setWordWrapped(boolean)"> +<a name="isWordWrapped()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setWordWrapped</h4> -<pre>public void setWordWrapped(boolean wrap)</pre> +<h4>isWordWrapped</h4> +<pre>public boolean isWordWrapped()</pre> <div class="block">This element specifies whether a consumer shall break Latin text which exceeds the text extents of a line by breaking the word across two lines (breaking on the character level) or by moving the word to the following line (breaking on the word level).</div> <dl> <dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/wp/usermodel/Paragraph.html#setWordWrapped(boolean)">setWordWrapped</a></code> in interface <code><a href="../../../../../org/apache/poi/wp/usermodel/Paragraph.html" title="interface in org.apache.poi.wp.usermodel">Paragraph</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>wrap</code> - - boolean</dd></dl> -</li> -</ul> -<a name="setWordWrap(boolean)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setWordWrap</h4> -<pre>@Deprecated -public void setWordWrap(boolean wrap)</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> +<dd><code><a href="../../../../../org/apache/poi/wp/usermodel/Paragraph.html#isWordWrapped()">isWordWrapped</a></code> in interface <code><a href="../../../../../org/apache/poi/wp/usermodel/Paragraph.html" title="interface in org.apache.poi.wp.usermodel">Paragraph</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>boolean</dd></dl> </li> </ul> -<a name="isWordWrapped()"> +<a name="setWordWrapped(boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>isWordWrapped</h4> -<pre>public boolean isWordWrapped()</pre> +<h4>setWordWrapped</h4> +<pre>public void setWordWrapped(boolean wrap)</pre> <div class="block">This element specifies whether a consumer shall break Latin text which exceeds the text extents of a line by breaking the word across two lines (breaking on the character level) or by moving the word to the following line (breaking on the word level).</div> <dl> <dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/wp/usermodel/Paragraph.html#isWordWrapped()">isWordWrapped</a></code> in interface <code><a href="../../../../../org/apache/poi/wp/usermodel/Paragraph.html" title="interface in org.apache.poi.wp.usermodel">Paragraph</a></code></dd> -<dt><span class="strong">Returns:</span></dt><dd>boolean</dd></dl> +<dd><code><a href="../../../../../org/apache/poi/wp/usermodel/Paragraph.html#setWordWrapped(boolean)">setWordWrapped</a></code> in interface <code><a href="../../../../../org/apache/poi/wp/usermodel/Paragraph.html" title="interface in org.apache.poi.wp.usermodel">Paragraph</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>wrap</code> - - boolean</dd></dl> </li> </ul> <a name="isWordWrap()"> @@ -1741,16 +1730,15 @@ public void setWordWrap(boolea <pre>public boolean isWordWrap()</pre> </li> </ul> -<a name="setStyle(java.lang.String)"> +<a name="setWordWrap(boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setStyle</h4> -<pre>public void setStyle(java.lang.String newStyle)</pre> -<div class="block">This method provides a style to the paragraph - This is useful when, e.g. an Heading style has to be assigned</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newStyle</code> - </dd></dl> +<h4>setWordWrap</h4> +<pre>@Deprecated +public void setWordWrap(boolean wrap)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> </li> </ul> <a name="getStyle()"> @@ -1763,6 +1751,18 @@ public void setWordWrap(boolea <dl><dt><span class="strong">Returns:</span></dt><dd>the style of the paragraph</dd></dl> </li> </ul> +<a name="setStyle(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStyle</h4> +<pre>public void setStyle(java.lang.String newStyle)</pre> +<div class="block">This method provides a style to the paragraph + This is useful when, e.g. an Heading style has to be assigned</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newStyle</code> - </dd></dl> +</li> +</ul> <a name="addRun(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR)"> <!-- --> </a> @@ -1770,7 +1770,7 @@ public void setWordWrap(boolea <li class="blockList"> <h4>addRun</h4> <pre>protected void addRun(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR run)</pre> -<div class="block">add a new run at the end of the position of +<div class="block">add a new run at the end of the position of the content of parameter run</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>run</code> - </dd></dl> </li> Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFPictureData.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFPictureData.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFPictureData.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFPictureData.html Sun May 31 21:20:33 2015 @@ -216,7 +216,7 @@ extends <a href="../../../../../org/apac <tr class="rowColor"> <td class="colFirst"><code>protected void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFPictureData.html#prepareForCommit()">prepareForCommit</a></strong>()</code> -<div class="block">*PictureData objects store the actual content in the part directly without keeping a +<div class="block">*PictureData objects store the actual content in the part directly without keeping a copy like all others therefore we need to handle them differently.</div> </td> </tr> @@ -293,7 +293,7 @@ extends <a href="../../../../../org/apac <a href="../../../../../org/apache/poi/openxml4j/opc/PackageRelationship.html" title="class in org.apache.poi.openxml4j.opc">PackageRelationship</a> rel)</pre> <div class="block">Construct XWPFPictureData from a package part</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>part</code> - the package part holding the drawing data,</dd><dd><code>rel</code> - the package relationship holding this drawing, - the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</dd></dl> + the relationship type must be http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</dd></dl> </li> </ul> </li> @@ -421,7 +421,7 @@ extends <a href="../../../../../org/apac <li class="blockList"> <h4>prepareForCommit</h4> <pre>protected void prepareForCommit()</pre> -<div class="block">*PictureData objects store the actual content in the part directly without keeping a +<div class="block">*PictureData objects store the actual content in the part directly without keeping a copy like all others therefore we need to handle them differently.</div> <dl> <dt><strong>Overrides:</strong></dt> Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFRun.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFRun.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFRun.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFRun.html Sun May 31 21:20:33 2015 @@ -210,8 +210,8 @@ implements <a href="../../../../../org/a <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFRun.html#addTab()">addTab</a></strong>()</code> -<div class="block">Specifies that a tab shall be placed at the current location in - the run content.</div> +<div class="block">Specifies that a tab shall be placed at the current location in + the run content.</div> </td> </tr> <tr class="altColor"> @@ -522,7 +522,7 @@ implements <a href="../../../../../org/a <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFRun.html#text()">text</a></strong>()</code> <div class="block">Returns the string version of the text, with tabs and - carriage returns in place of their xml equivalents.</div> + carriage returns in place of their xml equivalents.</div> </td> </tr> <tr class="altColor"> @@ -625,7 +625,7 @@ public org.openxmlformats.schemas.w <h4>getDocument</h4> <pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html" title="class in org.apache.poi.xwpf.usermodel">XWPFDocument</a> getDocument()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>The <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFDocument.html" title="class in org.apache.poi.xwpf.usermodel"><code>XWPFDocument</code></a> instance, this run belongs to, or - <code>null</code> if parent structure (paragraph > document) is not properly set.</dd></dl> + <code>null</code> if parent structure (paragraph > document) is not properly set.</dd></dl> </li> </ul> <a name="isBold()"> @@ -651,7 +651,7 @@ public org.openxmlformats.schemas.w <h4>setBold</h4> <pre>public void setBold(boolean value)</pre> <div class="block">Whether the bold property shall be applied to all non-complex script - characters in the contents of this run when displayed in a document. + characters in the contents of this run when displayed in a document. <p> This formatting property is a toggle property, which specifies that its behavior differs between its use within a style definition and its use as @@ -837,32 +837,6 @@ public org.openxmlformats.schemas.w <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the strike property is applied</dd></dl> </li> </ul> -<a name="isStrike()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>isStrike</h4> -<pre>@Deprecated -public boolean isStrike()</pre> -<div class="block"><span class="strong">Deprecated.</span> </div> -</li> -</ul> -<a name="isDoubleStrikeThrough()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>isDoubleStrikeThrough</h4> -<pre>public boolean isDoubleStrikeThrough()</pre> -<div class="block">Specifies that the contents of this run shall be displayed with a double - horizontal line through the center of the line.</div> -<dl> -<dt><strong>Specified by:</strong></dt> -<dd><code><a href="../../../../../org/apache/poi/wp/usermodel/CharacterRun.html#isDoubleStrikeThrough()">isDoubleStrikeThrough</a></code> in interface <code><a href="../../../../../org/apache/poi/wp/usermodel/CharacterRun.html" title="interface in org.apache.poi.wp.usermodel">CharacterRun</a></code></dd> -<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the double strike property is applied</dd></dl> -</li> -</ul> <a name="setStrikeThrough(boolean)"> <!-- --> </a> @@ -896,6 +870,17 @@ public boolean isStrike()</pre this run</dd></dl> </li> </ul> +<a name="isStrike()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isStrike</h4> +<pre>@Deprecated +public boolean isStrike()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> <a name="setStrike(boolean)"> <!-- --> </a> @@ -907,6 +892,21 @@ public void setStrike(boolean& <div class="block"><span class="strong">Deprecated.</span> </div> </li> </ul> +<a name="isDoubleStrikeThrough()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDoubleStrikeThrough</h4> +<pre>public boolean isDoubleStrikeThrough()</pre> +<div class="block">Specifies that the contents of this run shall be displayed with a double + horizontal line through the center of the line.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/poi/wp/usermodel/CharacterRun.html#isDoubleStrikeThrough()">isDoubleStrikeThrough</a></code> in interface <code><a href="../../../../../org/apache/poi/wp/usermodel/CharacterRun.html" title="interface in org.apache.poi.wp.usermodel">CharacterRun</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the double strike property is applied</dd></dl> +</li> +</ul> <a name="setDoubleStrikethrough(boolean)"> <!-- --> </a> @@ -1152,6 +1152,21 @@ public void setStrike(boolean& <dl><dt><span class="strong">Returns:</span></dt><dd>a string representing the font family</dd></dl> </li> </ul> +<a name="setFontFamily(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFontFamily</h4> +<pre>public void setFontFamily(java.lang.String fontFamily)</pre> +<div class="block">Specifies the fonts which shall be used to display the text contents of + this run. Specifies a font which shall be used to format all characters + in the ASCII range (0 - 127) within the parent run. + <p/> + Also sets the other font ranges, if they haven't been set before</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fontFamily</code> - </dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFRun.FontCharRange.html" title="enum in org.apache.poi.xwpf.usermodel"><code>XWPFRun.FontCharRange</code></a></dd></dl> +</li> +</ul> <a name="getFontName()"> <!-- --> </a> @@ -1179,21 +1194,6 @@ public void setStrike(boolean& <dt><span class="strong">Returns:</span></dt><dd>a string representing the font famil</dd></dl> </li> </ul> -<a name="setFontFamily(java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setFontFamily</h4> -<pre>public void setFontFamily(java.lang.String fontFamily)</pre> -<div class="block">Specifies the fonts which shall be used to display the text contents of - this run. Specifies a font which shall be used to format all characters - in the ASCII range (0 - 127) within the parent run. - - Also sets the other font ranges, if they haven't been set before</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fontFamily</code> - </dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFRun.FontCharRange.html" title="enum in org.apache.poi.xwpf.usermodel"><code>XWPFRun.FontCharRange</code></a></dd></dl> -</li> -</ul> <a name="setFontFamily(java.lang.String, org.apache.poi.xwpf.usermodel.XWPFRun.FontCharRange)"> <!-- --> </a> @@ -1304,7 +1304,7 @@ public void setStrike(boolean& <h4>addBreak</h4> <pre>public void addBreak()</pre> <div class="block">Specifies that a break shall be placed at the current location in the run - content. + content. A break is a special character which is used to override the normal line breaking that would be performed based on the normal layout of the document's contents.</div> @@ -1357,8 +1357,8 @@ public void setStrike(boolean& <li class="blockList"> <h4>addTab</h4> <pre>public void addTab()</pre> -<div class="block">Specifies that a tab shall be placed at the current location in - the run content.</div> +<div class="block">Specifies that a tab shall be placed at the current location in + the run content.</div> </li> </ul> <a name="removeTab()"> @@ -1412,7 +1412,7 @@ public void setStrike(boolean& throws <a href="../../../../../org/apache/poi/openxml4j/exceptions/InvalidFormatException.html" title="class in org.apache.poi.openxml4j.exceptions">InvalidFormatException</a>, java.io.IOException</pre> <div class="block">Adds a picture to the run. This method handles - attaching the picture data to the overall file.</div> + attaching the picture data to the overall file.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pictureData</code> - The raw picture data</dd><dd><code>pictureType</code> - The type of the picture, eg <a href="../../../../../org/apache/poi/xwpf/usermodel/Document.html#PICTURE_TYPE_JPEG"><code>Document.PICTURE_TYPE_JPEG</code></a></dd><dd><code>width</code> - width in EMUs. To convert to / from points use <a href="../../../../../org/apache/poi/util/Units.html" title="class in org.apache.poi.util"><code>Units</code></a></dd><dd><code>height</code> - height in EMUs. To convert to / from points use <a href="../../../../../org/apache/poi/util/Units.html" title="class in org.apache.poi.util"><code>Units</code></a></dd> <dt><span class="strong">Throws:</span></dt> <dd><code><a href="../../../../../org/apache/poi/openxml4j/exceptions/InvalidFormatException.html" title="class in org.apache.poi.openxml4j.exceptions">InvalidFormatException</a></code></dd> @@ -1432,8 +1432,8 @@ public void setStrike(boolean& <h4>getEmbeddedPictures</h4> <pre>public java.util.List<<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFPicture.html" title="class in org.apache.poi.xwpf.usermodel">XWPFPicture</a>> getEmbeddedPictures()</pre> <div class="block">Returns the embedded pictures of the run. These - are pictures which reference an external, - embedded picture image such as a .png or .jpg</div> + are pictures which reference an external, + embedded picture image such as a .png or .jpg</div> </li> </ul> <a name="toString()"> @@ -1458,7 +1458,7 @@ public void setStrike(boolean& <h4>text</h4> <pre>public java.lang.String text()</pre> <div class="block">Returns the string version of the text, with tabs and - carriage returns in place of their xml equivalents.</div> + carriage returns in place of their xml equivalents.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/poi/wp/usermodel/CharacterRun.html#text()">text</a></code> in interface <code><a href="../../../../../org/apache/poi/wp/usermodel/CharacterRun.html" title="interface in org.apache.poi.wp.usermodel">CharacterRun</a></code></dd> Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDT.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDT.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDT.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDT.html Sun May 31 21:20:33 2015 @@ -106,9 +106,9 @@ <pre>public class <span class="strong">XWPFSDT</span> extends <a href="../../../../../org/apache/poi/xwpf/usermodel/AbstractXWPFSDT.html" title="class in org.apache.poi.xwpf.usermodel">AbstractXWPFSDT</a> implements <a href="../../../../../org/apache/poi/xwpf/usermodel/IBodyElement.html" title="interface in org.apache.poi.xwpf.usermodel">IBodyElement</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/IRunBody.html" title="interface in org.apache.poi.xwpf.usermodel">IRunBody</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/ISDTContents.html" title="interface in org.apache.poi.xwpf.usermodel">ISDTContents</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/IRunElement.html" title="interface in org.apache.poi.xwpf.usermodel">IRunElement</a></pre> -<div class="block">Experimental class to offer rudimentary read-only processing of - of StructuredDocumentTags/ContentControl - +<div class="block">Experimental class to offer rudimentary read-only processing of + of StructuredDocumentTags/ContentControl + <p/> WARNING - APIs expected to change rapidly</div> </li> </ul> Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDTCell.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDTCell.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDTCell.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDTCell.html Sun May 31 21:20:33 2015 @@ -106,12 +106,12 @@ <pre>public class <span class="strong">XWPFSDTCell</span> extends <a href="../../../../../org/apache/poi/xwpf/usermodel/AbstractXWPFSDT.html" title="class in org.apache.poi.xwpf.usermodel">AbstractXWPFSDT</a> implements <a href="../../../../../org/apache/poi/xwpf/usermodel/ICell.html" title="interface in org.apache.poi.xwpf.usermodel">ICell</a></pre> -<div class="block">Experimental class to offer rudimentary read-only processing of - of StructuredDocumentTags/ContentControl that can appear - in a table row as if a table cell. - <p> - These can contain one or more cells or other SDTs within them. - +<div class="block">Experimental class to offer rudimentary read-only processing of + of StructuredDocumentTags/ContentControl that can appear + in a table row as if a table cell. + <p/> + These can contain one or more cells or other SDTs within them. + <p/> WARNING - APIs expected to change rapidly</div> </li> </ul> Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDTContent.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDTContent.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDTContent.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDTContent.html Sun May 31 21:20:33 2015 @@ -101,11 +101,11 @@ <pre>public class <span class="strong">XWPFSDTContent</span> extends java.lang.Object implements <a href="../../../../../org/apache/poi/xwpf/usermodel/ISDTContent.html" title="interface in org.apache.poi.xwpf.usermodel">ISDTContent</a></pre> -<div class="block">Experimental class to offer rudimentary read-only processing of - of the contentblock of an SDT/ContentControl. - - - +<div class="block">Experimental class to offer rudimentary read-only processing of + of the contentblock of an SDT/ContentControl. + <p/> + <p/> + <p/> WARNING - APIs expected to change rapidly</div> </li> </ul> Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDTContentCell.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDTContentCell.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDTContentCell.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSDTContentCell.html Sun May 31 21:20:33 2015 @@ -101,9 +101,9 @@ <pre>public class <span class="strong">XWPFSDTContentCell</span> extends java.lang.Object implements <a href="../../../../../org/apache/poi/xwpf/usermodel/ISDTContent.html" title="interface in org.apache.poi.xwpf.usermodel">ISDTContent</a></pre> -<div class="block">Experimental class to offer rudimentary read-only processing of - of the XWPFSDTCellContent. - +<div class="block">Experimental class to offer rudimentary read-only processing of + of the XWPFSDTCellContent. + <p/> WARNING - APIs expected to change rapidly</div> </li> </ul> Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSettings.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSettings.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSettings.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFSettings.html Sun May 31 21:20:33 2015 @@ -177,7 +177,7 @@ extends <a href="../../../../../org/apac <div class="block">Verifies the documentProtection tag inside settings.xml file <br/> if the protection is enforced (w:enforcement="1") <br/> and if the kind of protection equals to passed (STDocProtect.Enum editValue) <br/> - + <p/> <br/> sample snippet from settings.xml</div> </td> @@ -357,9 +357,9 @@ extends <a href="../../../../../org/apac In the zoom tag inside settings.xml file <br/> it sets the value of zoom <br/> - sample snippet from settings.xml + sample snippet from settings.xml <pre> - <w:zoom w:percent="50" /> + <w:zoom w:percent="50" /> <pre></div> </li> </ul> @@ -373,7 +373,7 @@ extends <a href="../../../../../org/apac <div class="block">Verifies the documentProtection tag inside settings.xml file <br/> if the protection is enforced (w:enforcement="1") <br/> and if the kind of protection equals to passed (STDocProtect.Enum editValue) <br/> - + <p/> <br/> sample snippet from settings.xml <pre> @@ -416,14 +416,14 @@ extends <a href="../../../../../org/apac <br/> sample snippet from settings.xml <pre> - <w:documentProtection w:edit="[passed editValue]" w:enforcement="1" + <w:documentProtection w:edit="[passed editValue]" w:enforcement="1" w:cryptProviderType="rsaAES" w:cryptAlgorithmClass="hash" w:cryptAlgorithmType="typeAny" w:cryptAlgorithmSid="14" w:cryptSpinCount="100000" w:hash="..." w:salt="...." /> </pre></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>editValue</code> - the protection type</dd><dd><code>password</code> - the plaintext password, if null no password will be applied</dd><dd><code>hashAlgo</code> - the hash algorithm - only md2, m5, sha1, sha256, sha384 and sha512 are supported. - if null, it will default default to sha1</dd></dl> + if null, it will default default to sha1</dd></dl> </li> </ul> <a name="validateProtectionPassword(java.lang.String)"> @@ -460,13 +460,13 @@ extends <a href="../../../../../org/apac <div class="block">Enforces fields update on document open (in Word). In the settings.xml file <br/> sets the updateSettings value to true (w:updateSettings w:val="true") - - NOTICES: - <ul> - <li>Causing Word to ask on open: "This document contains fields that may refer to other files. Do you want to update the fields in this document?" - (if "Update automatic links at open" is enabled)</li> - <li>Flag is removed after saving with changes in Word </li> - </ul></div> + <p/> + NOTICES: + <ul> + <li>Causing Word to ask on open: "This document contains fields that may refer to other files. Do you want to update the fields in this document?" + (if "Update automatic links at open" is enabled)</li> + <li>Flag is removed after saving with changes in Word </li> + </ul></div> </li> </ul> <a name="isTrackRevisions()"> Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFStyle.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFStyle.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFStyle.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFStyle.html Sun May 31 21:20:33 2015 @@ -306,7 +306,18 @@ extends java.lang.Object</pre> <h4>getStyleId</h4> <pre>public java.lang.String getStyleId()</pre> <div class="block">get StyleID of the style</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>styleID StyleID of the style</dd></dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>styleID StyleID of the style</dd></dl> +</li> +</ul> +<a name="setStyleId(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setStyleId</h4> +<pre>public void setStyleId(java.lang.String styleId)</pre> +<div class="block">set styleID</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>styleId</code> - </dd></dl> </li> </ul> <a name="getType()"> @@ -320,6 +331,17 @@ extends java.lang.Object</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>ctType</dd></dl> </li> </ul> +<a name="setType(org.openxmlformats.schemas.wordprocessingml.x2006.main.STStyleType.Enum)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setType</h4> +<pre>public void setType(org.openxmlformats.schemas.wordprocessingml.x2006.main.STStyleType.Enum type)</pre> +<div class="block">set styleType</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - </dd></dl> +</li> +</ul> <a name="setStyle(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTStyle)"> <!-- --> </a> @@ -342,28 +364,6 @@ extends java.lang.Object</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>ctStyle</dd></dl> </li> </ul> -<a name="setStyleId(java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setStyleId</h4> -<pre>public void setStyleId(java.lang.String styleId)</pre> -<div class="block">set styleID</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>styleId</code> - </dd></dl> -</li> -</ul> -<a name="setType(org.openxmlformats.schemas.wordprocessingml.x2006.main.STStyleType.Enum)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setType</h4> -<pre>public void setType(org.openxmlformats.schemas.wordprocessingml.x2006.main.STStyleType.Enum type)</pre> -<div class="block">set styleType</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - </dd></dl> -</li> -</ul> <a name="getStyles()"> <!-- --> </a> @@ -372,7 +372,7 @@ extends java.lang.Object</pre> <h4>getStyles</h4> <pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFStyles.html" title="class in org.apache.poi.xwpf.usermodel">XWPFStyles</a> getStyles()</pre> <div class="block">get styles</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>styles the styles to which this style belongs</dd></dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>styles the styles to which this style belongs</dd></dl> </li> </ul> <a name="getBasisStyleID()"> Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFStyles.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFStyles.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFStyles.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFStyles.html Sun May 31 21:20:33 2015 @@ -102,9 +102,9 @@ <pre>public class <span class="strong">XWPFStyles</span> extends <a href="../../../../../org/apache/poi/POIXMLDocumentPart.html" title="class in org.apache.poi">POIXMLDocumentPart</a></pre> <div class="block">Holds details of built-in, default and user styles, which - apply to tables / paragraphs / lists etc. + apply to tables / paragraphs / lists etc. Text within one of those with custom stylings has the style - information stored in the <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFRun.html" title="class in org.apache.poi.xwpf.usermodel"><code>XWPFRun</code></a></div> + information stored in the <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFRun.html" title="class in org.apache.poi.xwpf.usermodel"><code>XWPFRun</code></a></div> </li> </ul> </div> @@ -236,7 +236,7 @@ extends <a href="../../../../../org/apac <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFStyles.html#setDefaultFonts(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFonts)">setDefaultFonts</a></strong>(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFonts fonts)</code> <div class="block">Sets the default font on ctStyles DocDefaults parameter TODO Replace this with specific setters for each type, possibly - on XWPFDefaultRunStyle</div> + on XWPFDefaultRunStyle</div> </td> </tr> <tr class="rowColor"> @@ -493,7 +493,7 @@ extends <a href="../../../../../org/apac <pre>public void setDefaultFonts(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTFonts fonts)</pre> <div class="block">Sets the default font on ctStyles DocDefaults parameter TODO Replace this with specific setters for each type, possibly - on XWPFDefaultRunStyle</div> + on XWPFDefaultRunStyle</div> </li> </ul> <a name="getStyleWithSameName(org.apache.poi.xwpf.usermodel.XWPFStyle)"> Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFTable.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFTable.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFTable.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFTable.html Sun May 31 21:20:33 2015 @@ -512,7 +512,7 @@ public org.openxmlformats.schemas.w <div class="block">Convenience method to extract text in cells. This does not extract text recursively in cells, and it does not currently include text in SDT (form) components. - <p> + <p/> To get all text within a table, see XWPFWordExtractor's appendTableText as an example.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>text</dd></dl> @@ -560,24 +560,24 @@ public org.openxmlformats.schemas.w <dt><span class="strong">Returns:</span></dt><dd>the row at the position specified or null if no rows is defined or if the position is greather than the max size of rows array</dd></dl> </li> </ul> -<a name="setWidth(int)"> +<a name="getWidth()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setWidth</h4> -<pre>public void setWidth(int width)</pre> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>width</code> - </dd></dl> +<h4>getWidth</h4> +<pre>public int getWidth()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>width value</dd></dl> </li> </ul> -<a name="getWidth()"> +<a name="setWidth(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getWidth</h4> -<pre>public int getWidth()</pre> -<dl><dt><span class="strong">Returns:</span></dt><dd>width value</dd></dl> +<h4>setWidth</h4> +<pre>public void setWidth(int width)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>width</code> - </dd></dl> </li> </ul> <a name="getNumberOfRows()"> Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFTableCell.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFTableCell.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFTableCell.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFTableCell.html Sun May 31 21:20:33 2015 @@ -102,7 +102,7 @@ extends java.lang.Object implements <a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a>, <a href="../../../../../org/apache/poi/xwpf/usermodel/ICell.html" title="interface in org.apache.poi.xwpf.usermodel">ICell</a></pre> <div class="block">Represents a Cell within a <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel"><code>XWPFTable</code></a>. The - Cell is the thing that holds the actual content (paragraphs etc)</div> + Cell is the thing that holds the actual content (paragraphs etc)</div> </li> </ul> </div> @@ -279,8 +279,8 @@ implements <a href="../../../../../org/a <td class="colFirst"><code>java.util.List<<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTableCell.html#getTables()">getTables</a></strong>()</code> <div class="block">Return the table(s) that holds the text - of the IBodyPart, for complex cases - where a paragraph isn't used.</div> + of the IBodyPart, for complex cases + where a paragraph isn't used.</div> </td> </tr> <tr class="rowColor"> @@ -531,25 +531,27 @@ public org.openxmlformats.schemas.w <dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getParagraph(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP)">getParagraph</a></code> in interface <code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - is instance of CTP and is searching for an XWPFParagraph</dd> <dt><span class="strong">Returns:</span></dt><dd>null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this table - XWPFParagraph with the correspondig CTP p</dd></dl> + XWPFParagraph with the correspondig CTP p</dd></dl> </li> </ul> -<a name="setText(java.lang.String)"> +<a name="getTableRow()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setText</h4> -<pre>public void setText(java.lang.String text)</pre> +<h4>getTableRow</h4> +<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTableRow.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTableRow</a> getTableRow()</pre> </li> </ul> -<a name="getTableRow()"> +<a name="getColor()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getTableRow</h4> -<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTableRow.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTableRow</a> getTableRow()</pre> +<h4>getColor</h4> +<pre>public java.lang.String getColor()</pre> +<div class="block">Get cell color. Note that this method only returns the "fill" value.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>RGB string of cell color</dd></dl> </li> </ul> <a name="setColor(java.lang.String)"> @@ -564,15 +566,15 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Parameters:</span></dt><dd><code>rgbStr</code> - - the desired cell color, in the hex form "RRGGBB".</dd></dl> </li> </ul> -<a name="getColor()"> +<a name="getVerticalAlignment()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getColor</h4> -<pre>public java.lang.String getColor()</pre> -<div class="block">Get cell color. Note that this method only returns the "fill" value.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>RGB string of cell color</dd></dl> +<h4>getVerticalAlignment</h4> +<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTableCell.XWPFVertAlign.html" title="enum in org.apache.poi.xwpf.usermodel">XWPFTableCell.XWPFVertAlign</a> getVerticalAlignment()</pre> +<div class="block">Get the vertical alignment of the cell.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the cell alignment enum value</dd></dl> </li> </ul> <a name="setVerticalAlignment(org.apache.poi.xwpf.usermodel.XWPFTableCell.XWPFVertAlign)"> @@ -586,17 +588,6 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Parameters:</span></dt><dd><code>vAlign</code> - - the desired alignment enum value</dd></dl> </li> </ul> -<a name="getVerticalAlignment()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getVerticalAlignment</h4> -<pre>public <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTableCell.XWPFVertAlign.html" title="enum in org.apache.poi.xwpf.usermodel">XWPFTableCell.XWPFVertAlign</a> getVerticalAlignment()</pre> -<div class="block">Get the vertical alignment of the cell.</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>the cell alignment enum value</dd></dl> -</li> -</ul> <a name="insertNewParagraph(org.apache.xmlbeans.XmlCursor)"> <!-- --> </a> @@ -710,8 +701,8 @@ public org.openxmlformats.schemas.w <pre>public java.util.List<<a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTable</a>> getTables()</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getTables()">IBody</a></code></strong></div> <div class="block">Return the table(s) that holds the text - of the IBodyPart, for complex cases - where a paragraph isn't used.</div> + of the IBodyPart, for complex cases + where a paragraph isn't used.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html#getTables()">getTables</a></code> in interface <code><a href="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel">IBody</a></code></dd> @@ -742,6 +733,15 @@ public org.openxmlformats.schemas.w <pre>public java.lang.String getText()</pre> </li> </ul> +<a name="setText(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setText</h4> +<pre>public void setText(java.lang.String text)</pre> +</li> +</ul> <a name="getTextRecursively()"> <!-- --> </a> Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFTableRow.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFTableRow.html?rev=1682798&r1=1682797&r2=1682798&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFTableRow.html (original) +++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/XWPFTableRow.html Sun May 31 21:20:33 2015 @@ -97,8 +97,8 @@ <pre>public class <span class="strong">XWPFTableRow</span> extends java.lang.Object</pre> <div class="block">A row within an <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTable.html" title="class in org.apache.poi.xwpf.usermodel"><code>XWPFTable</code></a>. Rows mostly just have - sizings and stylings, the interesting content lives inside - the child <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTableCell.html" title="class in org.apache.poi.xwpf.usermodel"><code>XWPFTableCell</code></a>s</div> + sizings and stylings, the interesting content lives inside + the child <a href="../../../../../org/apache/poi/xwpf/usermodel/XWPFTableCell.html" title="class in org.apache.poi.xwpf.usermodel"><code>XWPFTableCell</code></a>s</div> </li> </ul> </div> @@ -313,36 +313,36 @@ public org.openxmlformats.schemas.w <div class="block">adds a new TableCell at the end of this tableRow</div> </li> </ul> -<a name="setHeight(int)"> +<a name="getHeight()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setHeight</h4> -<pre>public void setHeight(int height)</pre> +<h4>getHeight</h4> +<pre>public int getHeight()</pre> <div class="block">This element specifies the height of the current table row within the current table. This height shall be used to determine the resulting height of the table row, which may be absolute or relative (depending on its attribute values). If omitted, then the table row shall automatically resize its height to the height required by its contents (the equivalent of an hRule value of auto).</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>height</code> - </dd></dl> +<dl><dt><span class="strong">Returns:</span></dt><dd>height</dd></dl> </li> </ul> -<a name="getHeight()"> +<a name="setHeight(int)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>getHeight</h4> -<pre>public int getHeight()</pre> +<h4>setHeight</h4> +<pre>public void setHeight(int height)</pre> <div class="block">This element specifies the height of the current table row within the current table. This height shall be used to determine the resulting height of the table row, which may be absolute or relative (depending on its attribute values). If omitted, then the table row shall automatically resize its height to the height required by its contents (the equivalent of an hRule value of auto).</div> -<dl><dt><span class="strong">Returns:</span></dt><dd>height</dd></dl> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>height</code> - </dd></dl> </li> </ul> <a name="getTable()"> @@ -389,20 +389,6 @@ public org.openxmlformats.schemas.w if there is no XWPFTableCell which belongs to the parameter CTTc cell null will be returned</div> </li> </ul> -<a name="setCantSplitRow(boolean)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setCantSplitRow</h4> -<pre>public void setCantSplitRow(boolean split)</pre> -<div class="block">This attribute controls whether to allow table rows to split across pages. - The logic for this attribute is a little unusual: a true value means - DON'T allow rows to split, false means allow rows to split.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>split</code> - - if true, don't allow rows to be split. If false, allow - rows to be split.</dd></dl> -</li> -</ul> <a name="isCantSplitRow()"> <!-- --> </a> @@ -416,30 +402,44 @@ public org.openxmlformats.schemas.w <dl><dt><span class="strong">Returns:</span></dt><dd>true if rows can't be split, false otherwise.</dd></dl> </li> </ul> -<a name="setRepeatHeader(boolean)"> +<a name="setCantSplitRow(boolean)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> -<h4>setRepeatHeader</h4> -<pre>public void setRepeatHeader(boolean repeat)</pre> -<div class="block">This attribute controls whether to repeat a table's header row at the top - of a table split across pages.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repeat</code> - - if TRUE, repeat header row at the top of each page of table; - if FALSE, don't repeat header row.</dd></dl> +<h4>setCantSplitRow</h4> +<pre>public void setCantSplitRow(boolean split)</pre> +<div class="block">This attribute controls whether to allow table rows to split across pages. + The logic for this attribute is a little unusual: a true value means + DON'T allow rows to split, false means allow rows to split.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>split</code> - - if true, don't allow rows to be split. If false, allow + rows to be split.</dd></dl> </li> </ul> <a name="isRepeatHeader()"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>isRepeatHeader</h4> <pre>public boolean isRepeatHeader()</pre> <div class="block">Return true if a table's header row should be repeated at the top of a table split across pages.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>true if table's header row should be repeated at the top of each - page of table, false otherwise.</dd></dl> + page of table, false otherwise.</dd></dl> +</li> +</ul> +<a name="setRepeatHeader(boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setRepeatHeader</h4> +<pre>public void setRepeatHeader(boolean repeat)</pre> +<div class="block">This attribute controls whether to repeat a table's header row at the top + of a table split across pages.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>repeat</code> - - if TRUE, repeat header row at the top of each page of table; + if FALSE, don't repeat header row.</dd></dl> </li> </ul> </li> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
