You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ni...@apache.org on 2017/11/04 16:24:10 UTC
svn commit: r1814304 - in /poi/site/publish/apidocs: index-all.html
org/apache/poi/xssf/usermodel/XSSFTable.html
org/apache/poi/xssf/usermodel/XSSFTextParagraph.html
Author: nick
Date: Sat Nov 4 16:24:09 2017
New Revision: 1814304
URL: http://svn.apache.org/viewvc?rev=1814304&view=rev
Log:
Republish javadocs
Modified:
poi/site/publish/apidocs/index-all.html
poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFTable.html
poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFTextParagraph.html
Modified: poi/site/publish/apidocs/index-all.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/index-all.html?rev=1814304&r1=1814303&r2=1814304&view=diff
==============================================================================
--- poi/site/publish/apidocs/index-all.html (original)
+++ poi/site/publish/apidocs/index-all.html Sat Nov 4 16:24:09 2017
@@ -59144,7 +59144,7 @@ for streaming/read-only processing of xl
<dd> </dd>
<dt><span class="memberNameLink"><a href="org/apache/poi/xssf/usermodel/XSSFTable.html#readFrom-java.io.InputStream-">readFrom(InputStream)</a></span> - Method in class org.apache.poi.xssf.usermodel.<a href="org/apache/poi/xssf/usermodel/XSSFTable.html" title="class in org.apache.poi.xssf.usermodel">XSSFTable</a></dt>
<dd>
-<div class="block">read table XML</div>
+<div class="block">Read table XML from an <code>InputStream</code></div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/poi/util/ByteField.html#readFromBytes-byte:A-">readFromBytes(byte[])</a></span> - Method in class org.apache.poi.util.<a href="org/apache/poi/util/ByteField.html" title="class in org.apache.poi.util">ByteField</a></dt>
<dd>
@@ -87779,7 +87779,7 @@ the order they are declared.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/poi/xssf/usermodel/XSSFTable.html#writeTo-java.io.OutputStream-">writeTo(OutputStream)</a></span> - Method in class org.apache.poi.xssf.usermodel.<a href="org/apache/poi/xssf/usermodel/XSSFTable.html" title="class in org.apache.poi.xssf.usermodel">XSSFTable</a></dt>
<dd>
-<div class="block">write table XML to stream</div>
+<div class="block">write table XML to an <code>OutputStream</code></div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/poi/util/ByteField.html#writeToBytes-byte:A-">writeToBytes(byte[])</a></span> - Method in class org.apache.poi.util.<a href="org/apache/poi/util/ByteField.html" title="class in org.apache.poi.util">ByteField</a></dt>
<dd>
Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFTable.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFTable.html?rev=1814304&r1=1814303&r2=1814304&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFTable.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFTable.html Sat Nov 4 16:24:09 2017
@@ -352,7 +352,7 @@ implements <a href="../../../../../org/a
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFTable.html#readFrom-java.io.InputStream-">readFrom</a></span>(java.io.InputStream is)</code>
-<div class="block">read table XML</div>
+<div class="block">Read table XML from an <code>InputStream</code></div>
</td>
</tr>
<tr id="i29" class="rowColor">
@@ -397,7 +397,7 @@ implements <a href="../../../../../org/a
<tr id="i35" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/poi/xssf/usermodel/XSSFTable.html#writeTo-java.io.OutputStream-">writeTo</a></span>(java.io.OutputStream out)</code>
-<div class="block">write table XML to stream</div>
+<div class="block">write table XML to an <code>OutputStream</code></div>
</td>
</tr>
</table>
@@ -449,9 +449,9 @@ implements <a href="../../../../../org/a
throws java.io.IOException</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>part</code> - </dd>
+<dd><code>part</code> - The part used to initialize the table</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>java.io.IOException</code></dd>
+<dd><code>java.io.IOException</code> - If reading data from the part fails.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>POI 3.14-Beta1</dd>
</dl>
@@ -473,12 +473,12 @@ implements <a href="../../../../../org/a
<h4>readFrom</h4>
<pre>public void readFrom(java.io.InputStream is)
throws java.io.IOException</pre>
-<div class="block">read table XML</div>
+<div class="block">Read table XML from an <code>InputStream</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>is</code> - </dd>
+<dd><code>is</code> - The stream which provides the XML data for the table.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>java.io.IOException</code></dd>
+<dd><code>java.io.IOException</code> - If reading from the stream fails</dd>
</dl>
</li>
</ul>
@@ -503,12 +503,12 @@ implements <a href="../../../../../org/a
<h4>writeTo</h4>
<pre>public void writeTo(java.io.OutputStream out)
throws java.io.IOException</pre>
-<div class="block">write table XML to stream</div>
+<div class="block">write table XML to an <code>OutputStream</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>out</code> - </dd>
+<dd><code>out</code> - The stream to write the XML data to</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>java.io.IOException</code></dd>
+<dd><code>java.io.IOException</code> - If writing to the stream fails.</dd>
</dl>
</li>
</ul>
@@ -646,7 +646,7 @@ public void addColumn()</pre>
<div class="block">Changes the name of the Table</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>newName</code> - </dd>
+<dd><code>newName</code> - The name of the table.</dd>
</dl>
</li>
</ul>
@@ -677,7 +677,7 @@ public void addColumn()</pre>
<div class="block">Changes the name of the Table</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>newStyleName</code> - </dd>
+<dd><code>newStyleName</code> - The name of the style.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.17 beta 1</dd>
</dl>
@@ -821,7 +821,7 @@ public void addColumn()</pre>
The next call to <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFTable.html#getStartCellReference--"><code>getStartCellReference()</code></a> and
<a href="../../../../../org/apache/poi/xssf/usermodel/XSSFTable.html#getEndCellReference--"><code>getEndCellReference()</code></a> will synchronize the
cell references with the underlying <code>CTTable</code>.
- Thus, <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFTable.html#updateReferences--"><code>updateReferences()</code></a> is inexpensive.</div>
+ Thus this method is inexpensive.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>POI 3.15 beta 3</dd>
@@ -858,7 +858,7 @@ public void addColumn()</pre>
"Found unreadable content" message on startup.
If calling both <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFTable.html#updateReferences--"><code>updateReferences()</code></a> and
- <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFTable.html#updateHeaders--"><code>updateHeaders()</code></a>, <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFTable.html#updateReferences--"><code>updateReferences()</code></a>
+ this method, <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFTable.html#updateReferences--"><code>updateReferences()</code></a>
should be called first.
Note that a Table <em>must</em> have a header. To reproduce
@@ -921,7 +921,7 @@ public void addColumn()</pre>
<pre>public boolean isHasTotalsRow()</pre>
<div class="block">Note: This is misleading. The Spec indicates this is true if the totals row
has <b><i>ever</i></b> been shown, not whether or not it is currently displayed.
- Use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFTable.html#getTotalsRowCount--"><code>getTotalsRowCount()</code></a> > 0 to decide whether or not the totals row is visible.</div>
+ Use <a href="../../../../../org/apache/poi/xssf/usermodel/XSSFTable.html#getTotalsRowCount--"><code>getTotalsRowCount()</code></a> > 0 to decide whether or not the totals row is visible.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Table.html#isHasTotalsRow--">isHasTotalsRow</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/Table.html" title="interface in org.apache.poi.ss.usermodel">Table</a></code></dd>
@@ -946,7 +946,7 @@ public void addColumn()</pre>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Table.html#getTotalsRowCount--">getTotalsRowCount</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/Table.html" title="interface in org.apache.poi.ss.usermodel">Table</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>0 for no totals rows, 1 for totals row shown.
- Values > 1 are not currently used by Excel up through 2016, and the OOXML spec
+ Values > 1 are not currently used by Excel up through 2016, and the OOXML spec
doesn't define how they would be implemented.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.17 beta 1</dd>
@@ -965,7 +965,7 @@ public void addColumn()</pre>
<dd><code><a href="../../../../../org/apache/poi/ss/usermodel/Table.html#getHeaderRowCount--">getHeaderRowCount</a></code> in interface <code><a href="../../../../../org/apache/poi/ss/usermodel/Table.html" title="interface in org.apache.poi.ss.usermodel">Table</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>0 for no header rows, 1 for table headers shown.
- Values > 1 might be used by Excel for pivot tables?</dd>
+ Values > 1 might be used by Excel for pivot tables?</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>3.17 beta 1</dd>
</dl>
Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFTextParagraph.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFTextParagraph.html?rev=1814304&r1=1814303&r2=1814304&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFTextParagraph.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFTextParagraph.html Sat Nov 4 16:24:09 2017
@@ -627,8 +627,8 @@ public org.openxmlformats.schemas.d
<div class="block">Returns the bullet size that is to be used within a paragraph.
This may be specified in two different ways, percentage spacing and font point spacing:
<p>
- If bulletSize >= 0, then bulletSize is a percentage of the font size.
- If bulletSize < 0, then it specifies the size in points
+ If bulletSize >= 0, then bulletSize is a percentage of the font size.
+ If bulletSize < 0, then it specifies the size in points
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -646,8 +646,8 @@ public org.openxmlformats.schemas.d
<div class="block">Sets the bullet size that is to be used within a paragraph.
This may be specified in two different ways, percentage spacing and font point spacing:
<p>
- If bulletSize >= 0, then bulletSize is a percentage of the font size.
- If bulletSize < 0, then it specifies the size in points
+ If bulletSize >= 0, then bulletSize is a percentage of the font size.
+ If bulletSize < 0, then it specifies the size in points
</p></div>
</li>
</ul>
@@ -783,8 +783,8 @@ public org.openxmlformats.schemas.d
<div class="block">This element specifies the vertical line spacing that is to be used within a paragraph.
This may be specified in two different ways, percentage spacing and font point spacing:
<p>
- If linespacing >= 0, then linespacing is a percentage of normal line height
- If linespacing < 0, the absolute value of linespacing is the spacing in points
+ If linespacing >= 0, then linespacing is a percentage of normal line height
+ If linespacing < 0, the absolute value of linespacing is the spacing in points
</p>
Examples:
<pre><code>
@@ -813,8 +813,8 @@ public org.openxmlformats.schemas.d
<div class="block">Returns the vertical line spacing that is to be used within a paragraph.
This may be specified in two different ways, percentage spacing and font point spacing:
<p>
- If linespacing >= 0, then linespacing is a percentage of normal line height.
- If linespacing < 0, the absolute value of linespacing is the spacing in points
+ If linespacing >= 0, then linespacing is a percentage of normal line height.
+ If linespacing < 0, the absolute value of linespacing is the spacing in points
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -832,8 +832,8 @@ public org.openxmlformats.schemas.d
<div class="block">Set the amount of vertical white space that will be present before the paragraph.
This space is specified in either percentage or points:
<p>
- If spaceBefore >= 0, then space is a percentage of normal line height.
- If spaceBefore < 0, the absolute value of linespacing is the spacing in points
+ If spaceBefore >= 0, then space is a percentage of normal line height.
+ If spaceBefore < 0, the absolute value of linespacing is the spacing in points
</p>
Examples:
<pre><code>
@@ -860,8 +860,8 @@ public org.openxmlformats.schemas.d
<div class="block">The amount of vertical white space before the paragraph
This may be specified in two different ways, percentage spacing and font point spacing:
<p>
- If spaceBefore >= 0, then space is a percentage of normal line height.
- If spaceBefore < 0, the absolute value of linespacing is the spacing in points
+ If spaceBefore >= 0, then space is a percentage of normal line height.
+ If spaceBefore < 0, the absolute value of linespacing is the spacing in points
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -879,8 +879,8 @@ public org.openxmlformats.schemas.d
<div class="block">Set the amount of vertical white space that will be present after the paragraph.
This space is specified in either percentage or points:
<p>
- If spaceAfter >= 0, then space is a percentage of normal line height.
- If spaceAfter < 0, the absolute value of linespacing is the spacing in points
+ If spaceAfter >= 0, then space is a percentage of normal line height.
+ If spaceAfter < 0, the absolute value of linespacing is the spacing in points
</p>
Examples:
<pre><code>
@@ -907,8 +907,8 @@ public org.openxmlformats.schemas.d
<div class="block">The amount of vertical white space after the paragraph
This may be specified in two different ways, percentage spacing and font point spacing:
<p>
- If spaceBefore >= 0, then space is a percentage of normal line height.
- If spaceBefore < 0, the absolute value of linespacing is the spacing in points
+ If spaceBefore >= 0, then space is a percentage of normal line height.
+ If spaceBefore < 0, the absolute value of linespacing is the spacing in points
</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org