Modified: poi/site/publish/apidocs/org/apache/poi/ddf/EscherChildAnchorRecord.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ddf/EscherChildAnchorRecord.html?rev=1800563&r1=1800562&r2=1800563&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ddf/EscherChildAnchorRecord.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ddf/EscherChildAnchorRecord.html Sun Jul 2 13:21:20 2017 @@ -180,49 +180,56 @@ extends <a href="../../../../org/apache/ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code>protected java.lang.Object[][]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherChildAnchorRecord.html#getAttributeMap()">getAttributeMap</a></strong>()</code> +<div class="block">For the purpose of providing toString() and toXml() a subclass can either override those methods + or provide a Object[][] array in the form { { "Attribute Name (Header)", value, "optional attribute", value }, ...</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherChildAnchorRecord.html#getDx1()">getDx1</a></strong>()</code> <div class="block">Retrieves offset within the parent coordinate space for the top left point.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherChildAnchorRecord.html#getDx2()">getDx2</a></strong>()</code> <div class="block">Retrieves offset within the parent coordinate space for the bottom right point.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherChildAnchorRecord.html#getDy1()">getDy1</a></strong>()</code> <div class="block">Gets offset within the parent coordinate space for the top left point.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherChildAnchorRecord.html#getDy2()">getDy2</a></strong>()</code> <div class="block">Gets the offset within the parent coordinate space for the bottom right point.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherChildAnchorRecord.html#getRecordId()">getRecordId</a></strong>()</code> <div class="block">Return the current record id.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherChildAnchorRecord.html#getRecordName()">getRecordName</a></strong>()</code> <div class="block">Subclasses should return the short name for this escher record.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherChildAnchorRecord.html#getRecordSize()">getRecordSize</a></strong>()</code> <div class="block">Subclasses should effeciently return the number of bytes required to serialize the record.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherChildAnchorRecord.html#serialize(int,%20byte[],%20org.apache.poi.ddf.EscherSerializationListener)">serialize</a></strong>(int offset, byte[] data, @@ -230,47 +237,37 @@ extends <a href="../../../../org/apache/ <div class="block">Serializes the record to an existing byte array.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherChildAnchorRecord.html#setDx1(int)">setDx1</a></strong>(int field_1_dx1)</code> <div class="block">Sets offset within the parent coordinate space for the top left point.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherChildAnchorRecord.html#setDx2(int)">setDx2</a></strong>(int field_3_dx2)</code> <div class="block">Sets offset within the parent coordinate space for the bottom right point.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherChildAnchorRecord.html#setDy1(int)">setDy1</a></strong>(int field_2_dy1)</code> <div class="block">Sets offset within the parent coordinate space for the top left point.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherChildAnchorRecord.html#setDy2(int)">setDy2</a></strong>(int field_4_dy2)</code> <div class="block">Sets the offset within the parent coordinate space for the bottom right point.</div> </td> </tr> -<tr class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherChildAnchorRecord.html#toString()">toString</a></strong>()</code> -<div class="block">The string representation of this record</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherChildAnchorRecord.html#toXml(java.lang.String)">toXml</a></strong>(java.lang.String tab)</code> </td> -</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.ddf.EscherRecord"> <!-- --> </a> <h3>Methods inherited from class org.apache.poi.ddf.<a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></h3> -<code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#clone()">clone</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#display(java.io.PrintWriter,%20int)">display</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#fillFields(byte[],%20org.apache.poi.ddf.EscherRecordFactory)">fillFields</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#formatXmlRecordHeader(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)">formatXmlRecordHeader</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChild(int)">getChild</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChildRecords()">getChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getInstance()">getInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getOptions()">getOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getVersion()">getVersion</a>, <a href="../../../../org/apache/ poi/ddf/EscherRecord.html#isContainerRecord()">isContainerRecord</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readHeader(byte[],%20int)">readHeader</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readInstance(byte[],%20int)">readInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize()">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize(int,%20byte[])">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setChildRecords(java.util.List)">setChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setInstance(short)">setInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setOptions(short)">setOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setRecordId(short)">setRecordId</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setVersion(short)">setVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRe cord.html#toXml()">toXml</a></code></li> +<code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#clone()">clone</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#display(java.io.PrintWriter,%20int)">display</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#fillFields(byte[],%20org.apache.poi.ddf.EscherRecordFactory)">fillFields</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChild(int)">getChild</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChildRecords()">getChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getInstance()">getInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getOptions()">getOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getVersion()">getVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#isContainerRecord()">isContainerRecord</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readHeader(byte[],%20int)">readHeader</a>, <a href="../../ ../../org/apache/poi/ddf/EscherRecord.html#readInstance(byte[],%20int)">readInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize()">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize(int,%20byte[])">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setChildRecords(java.util.List)">setChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setInstance(short)">setInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setOptions(short)">setOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setRecordId(short)">setRecordId</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setVersion(short)">setVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toString()">toString</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml()">toXml</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml(java.lan g.String)">toXml</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> @@ -425,34 +422,6 @@ extends <a href="../../../../org/apache/ <dt><span class="strong">Returns:</span></dt><dd>the short name for this escher record</dd></dl> </li> </ul> -<a name="toString()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>toString</h4> -<pre>public java.lang.String toString()</pre> -<div class="block">The string representation of this record</div> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>toString</code> in class <code>java.lang.Object</code></dd> -</dl> -</li> -</ul> -<a name="toXml(java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>toXml</h4> -<pre>public java.lang.String toXml(java.lang.String tab)</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml(java.lang.String)">toXml</a></code> in class <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>tab</code> - - each children must be a right of his parent</dd> -<dt><span class="strong">Returns:</span></dt><dd>xml representation of this record</dd></dl> -</li> -</ul> <a name="getDx1()"> <!-- --> </a> @@ -533,7 +502,7 @@ extends <a href="../../../../org/apache/ <a name="setDy2(int)"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>setDy2</h4> <pre>public void setDy2(int field_4_dy2)</pre> @@ -541,6 +510,26 @@ extends <a href="../../../../org/apache/ <dl><dt><span class="strong">Parameters:</span></dt><dd><code>field_4_dy2</code> - the y offset of the bottom right point</dd></dl> </li> </ul> +<a name="getAttributeMap()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAttributeMap</h4> +<pre>protected java.lang.Object[][] getAttributeMap()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#getAttributeMap()">EscherRecord</a></code></strong></div> +<div class="block">For the purpose of providing toString() and toXml() a subclass can either override those methods + or provide a Object[][] array in the form <code>{ { "Attribute Name (Header)", value, "optional attribute", value }, ... } </code>.<p> + + Null values won't be printed.<p> + + The attributes record, version, instance, options must not be returned.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#getAttributeMap()">getAttributeMap</a></code> in class <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the attribute map</dd></dl> +</li> +</ul> </li> </ul> </li>
Modified: poi/site/publish/apidocs/org/apache/poi/ddf/EscherClientAnchorRecord.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ddf/EscherClientAnchorRecord.html?rev=1800563&r1=1800562&r2=1800563&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ddf/EscherClientAnchorRecord.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ddf/EscherClientAnchorRecord.html Sun Jul 2 13:21:20 2017 @@ -182,85 +182,92 @@ extends <a href="../../../../org/apache/ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code>protected java.lang.Object[][]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#getAttributeMap()">getAttributeMap</a></strong>()</code> +<div class="block">For the purpose of providing toString() and toXml() a subclass can either override those methods + or provide a Object[][] array in the form { { "Attribute Name (Header)", value, "optional attribute", value }, ...</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#getCol1()">getCol1</a></strong>()</code> <div class="block">The column number for the top-left position.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#getCol2()">getCol2</a></strong>()</code> <div class="block">The column of the bottom right corner of this shape.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#getDx1()">getDx1</a></strong>()</code> <div class="block">The x offset within the top-left cell.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#getDx2()">getDx2</a></strong>()</code> <div class="block">The x offset withing the cell for the bottom-right corner of this shape.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#getDy1()">getDy1</a></strong>()</code> <div class="block">The y offset within the top-left corner of the current shape.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#getDy2()">getDy2</a></strong>()</code> <div class="block">The y offset withing the cell for the bottom-right corner of this shape.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#getFlag()">getFlag</a></strong>()</code> <div class="block">0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#getRecordId()">getRecordId</a></strong>()</code> <div class="block">Return the current record id.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#getRecordName()">getRecordName</a></strong>()</code> <div class="block">Subclasses should return the short name for this escher record.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#getRecordSize()">getRecordSize</a></strong>()</code> <div class="block">Subclasses should effeciently return the number of bytes required to serialize the record.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#getRemainingData()">getRemainingData</a></strong>()</code> <div class="block">Any remaining data in the record</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#getRow1()">getRow1</a></strong>()</code> <div class="block">The row number for the top-left corner of the shape.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#getRow2()">getRow2</a></strong>()</code> <div class="block">The row number for the bottom-right corner of the current shape.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#serialize(int,%20byte[],%20org.apache.poi.ddf.EscherSerializationListener)">serialize</a></strong>(int offset, byte[] data, @@ -268,83 +275,73 @@ extends <a href="../../../../org/apache/ <div class="block">Serializes the record to an existing byte array.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#setCol1(short)">setCol1</a></strong>(short field_2_col1)</code> <div class="block">The column number for the top-left position.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#setCol2(short)">setCol2</a></strong>(short field_6_col2)</code> <div class="block">The column of the bottom right corner of this shape.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#setDx1(short)">setDx1</a></strong>(short field_3_dx1)</code> <div class="block">The x offset within the top-left cell.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#setDx2(short)">setDx2</a></strong>(short field_7_dx2)</code> <div class="block">The x offset withing the cell for the bottom-right corner of this shape.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#setDy1(short)">setDy1</a></strong>(short field_5_dy1)</code> <div class="block">The y offset within the top-left corner of the current shape.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#setDy2(short)">setDy2</a></strong>(short field_9_dy2)</code> <div class="block">The y offset withing the cell for the bottom-right corner of this shape.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#setFlag(short)">setFlag</a></strong>(short field_1_flag)</code> <div class="block">0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#setRemainingData(byte[])">setRemainingData</a></strong>(byte[] remainingData)</code> <div class="block">Any remaining data in the record</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#setRow1(short)">setRow1</a></strong>(short field_4_row1)</code> <div class="block">The row number of the top-left corner of the shape.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#setRow2(short)">setRow2</a></strong>(short field_8_row2)</code> <div class="block">The row number for the bottom-right corner of the current shape.</div> </td> </tr> -<tr class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#toString()">toString</a></strong>()</code> -<div class="block">Returns the string representation for this record.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientAnchorRecord.html#toXml(java.lang.String)">toXml</a></strong>(java.lang.String tab)</code> </td> -</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.ddf.EscherRecord"> <!-- --> </a> <h3>Methods inherited from class org.apache.poi.ddf.<a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></h3> -<code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#clone()">clone</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#display(java.io.PrintWriter,%20int)">display</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#fillFields(byte[],%20org.apache.poi.ddf.EscherRecordFactory)">fillFields</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#formatXmlRecordHeader(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)">formatXmlRecordHeader</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChild(int)">getChild</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChildRecords()">getChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getInstance()">getInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getOptions()">getOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getVersion()">getVersion</a>, <a href="../../../../org/apache/ poi/ddf/EscherRecord.html#isContainerRecord()">isContainerRecord</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readHeader(byte[],%20int)">readHeader</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readInstance(byte[],%20int)">readInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize()">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize(int,%20byte[])">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setChildRecords(java.util.List)">setChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setInstance(short)">setInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setOptions(short)">setOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setRecordId(short)">setRecordId</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setVersion(short)">setVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRe cord.html#toXml()">toXml</a></code></li> +<code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#clone()">clone</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#display(java.io.PrintWriter,%20int)">display</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#fillFields(byte[],%20org.apache.poi.ddf.EscherRecordFactory)">fillFields</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChild(int)">getChild</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChildRecords()">getChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getInstance()">getInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getOptions()">getOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getVersion()">getVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#isContainerRecord()">isContainerRecord</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readHeader(byte[],%20int)">readHeader</a>, <a href="../../ ../../org/apache/poi/ddf/EscherRecord.html#readInstance(byte[],%20int)">readInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize()">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize(int,%20byte[])">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setChildRecords(java.util.List)">setChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setInstance(short)">setInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setOptions(short)">setOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setRecordId(short)">setRecordId</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setVersion(short)">setVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toString()">toString</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml()">toXml</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml(java.lan g.String)">toXml</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> @@ -499,34 +496,6 @@ extends <a href="../../../../org/apache/ <dt><span class="strong">Returns:</span></dt><dd>the short name for this escher record</dd></dl> </li> </ul> -<a name="toString()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>toString</h4> -<pre>public java.lang.String toString()</pre> -<div class="block">Returns the string representation for this record.</div> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>toString</code> in class <code>java.lang.Object</code></dd> -<dt><span class="strong">Returns:</span></dt><dd>A string</dd></dl> -</li> -</ul> -<a name="toXml(java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>toXml</h4> -<pre>public java.lang.String toXml(java.lang.String tab)</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml(java.lang.String)">toXml</a></code> in class <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>tab</code> - - each children must be a right of his parent</dd> -<dt><span class="strong">Returns:</span></dt><dd>xml representation of this record</dd></dl> -</li> -</ul> <a name="getFlag()"> <!-- --> </a> @@ -739,7 +708,7 @@ extends <a href="../../../../org/apache/ <a name="setRemainingData(byte[])"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>setRemainingData</h4> <pre>public void setRemainingData(byte[] remainingData)</pre> @@ -747,6 +716,26 @@ extends <a href="../../../../org/apache/ <dl><dt><span class="strong">Parameters:</span></dt><dd><code>remainingData</code> - the remaining bytes</dd></dl> </li> </ul> +<a name="getAttributeMap()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAttributeMap</h4> +<pre>protected java.lang.Object[][] getAttributeMap()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#getAttributeMap()">EscherRecord</a></code></strong></div> +<div class="block">For the purpose of providing toString() and toXml() a subclass can either override those methods + or provide a Object[][] array in the form <code>{ { "Attribute Name (Header)", value, "optional attribute", value }, ... } </code>.<p> + + Null values won't be printed.<p> + + The attributes record, version, instance, options must not be returned.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#getAttributeMap()">getAttributeMap</a></code> in class <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the attribute map</dd></dl> +</li> +</ul> </li> </ul> </li> Modified: poi/site/publish/apidocs/org/apache/poi/ddf/EscherClientDataRecord.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ddf/EscherClientDataRecord.html?rev=1800563&r1=1800562&r2=1800563&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ddf/EscherClientDataRecord.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ddf/EscherClientDataRecord.html Sun Jul 2 13:21:20 2017 @@ -183,31 +183,38 @@ extends <a href="../../../../org/apache/ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code>protected java.lang.Object[][]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientDataRecord.html#getAttributeMap()">getAttributeMap</a></strong>()</code> +<div class="block">For the purpose of providing toString() and toXml() a subclass can either override those methods + or provide a Object[][] array in the form { { "Attribute Name (Header)", value, "optional attribute", value }, ...</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientDataRecord.html#getRecordId()">getRecordId</a></strong>()</code> <div class="block">Return the current record id.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientDataRecord.html#getRecordName()">getRecordName</a></strong>()</code> <div class="block">Subclasses should return the short name for this escher record.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientDataRecord.html#getRecordSize()">getRecordSize</a></strong>()</code> <div class="block">Subclasses should effeciently return the number of bytes required to serialize the record.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientDataRecord.html#getRemainingData()">getRemainingData</a></strong>()</code> <div class="block">Any data recording this record.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientDataRecord.html#serialize(int,%20byte[],%20org.apache.poi.ddf.EscherSerializationListener)">serialize</a></strong>(int offset, byte[] data, @@ -215,29 +222,19 @@ extends <a href="../../../../org/apache/ <div class="block">Serializes the record to an existing byte array.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientDataRecord.html#setRemainingData(byte[])">setRemainingData</a></strong>(byte[] remainingData)</code> <div class="block">Any data recording this record.</div> </td> </tr> -<tr class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientDataRecord.html#toString()">toString</a></strong>()</code> -<div class="block">Returns the string representation of this record.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherClientDataRecord.html#toXml(java.lang.String)">toXml</a></strong>(java.lang.String tab)</code> </td> -</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.ddf.EscherRecord"> <!-- --> </a> <h3>Methods inherited from class org.apache.poi.ddf.<a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></h3> -<code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#clone()">clone</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#display(java.io.PrintWriter,%20int)">display</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#fillFields(byte[],%20org.apache.poi.ddf.EscherRecordFactory)">fillFields</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#formatXmlRecordHeader(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)">formatXmlRecordHeader</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChild(int)">getChild</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChildRecords()">getChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getInstance()">getInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getOptions()">getOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getVersion()">getVersion</a>, <a href="../../../../org/apache/ poi/ddf/EscherRecord.html#isContainerRecord()">isContainerRecord</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readHeader(byte[],%20int)">readHeader</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readInstance(byte[],%20int)">readInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize()">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize(int,%20byte[])">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setChildRecords(java.util.List)">setChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setInstance(short)">setInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setOptions(short)">setOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setRecordId(short)">setRecordId</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setVersion(short)">setVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRe cord.html#toXml()">toXml</a></code></li> +<code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#clone()">clone</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#display(java.io.PrintWriter,%20int)">display</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#fillFields(byte[],%20org.apache.poi.ddf.EscherRecordFactory)">fillFields</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChild(int)">getChild</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChildRecords()">getChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getInstance()">getInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getOptions()">getOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getVersion()">getVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#isContainerRecord()">isContainerRecord</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readHeader(byte[],%20int)">readHeader</a>, <a href="../../ ../../org/apache/poi/ddf/EscherRecord.html#readInstance(byte[],%20int)">readInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize()">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize(int,%20byte[])">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setChildRecords(java.util.List)">setChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setInstance(short)">setInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setOptions(short)">setOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setRecordId(short)">setRecordId</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setVersion(short)">setVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toString()">toString</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml()">toXml</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml(java.lan g.String)">toXml</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> @@ -392,34 +389,6 @@ extends <a href="../../../../org/apache/ <dt><span class="strong">Returns:</span></dt><dd>the short name for this escher record</dd></dl> </li> </ul> -<a name="toString()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>toString</h4> -<pre>public java.lang.String toString()</pre> -<div class="block">Returns the string representation of this record.</div> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>toString</code> in class <code>java.lang.Object</code></dd> -</dl> -</li> -</ul> -<a name="toXml(java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>toXml</h4> -<pre>public java.lang.String toXml(java.lang.String tab)</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml(java.lang.String)">toXml</a></code> in class <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>tab</code> - - each children must be a right of his parent</dd> -<dt><span class="strong">Returns:</span></dt><dd>xml representation of this record</dd></dl> -</li> -</ul> <a name="getRemainingData()"> <!-- --> </a> @@ -434,7 +403,7 @@ extends <a href="../../../../org/apache/ <a name="setRemainingData(byte[])"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>setRemainingData</h4> <pre>public void setRemainingData(byte[] remainingData)</pre> @@ -442,6 +411,26 @@ extends <a href="../../../../org/apache/ <dl><dt><span class="strong">Parameters:</span></dt><dd><code>remainingData</code> - the remaining bytes</dd></dl> </li> </ul> +<a name="getAttributeMap()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAttributeMap</h4> +<pre>protected java.lang.Object[][] getAttributeMap()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#getAttributeMap()">EscherRecord</a></code></strong></div> +<div class="block">For the purpose of providing toString() and toXml() a subclass can either override those methods + or provide a Object[][] array in the form <code>{ { "Attribute Name (Header)", value, "optional attribute", value }, ... } </code>.<p> + + Null values won't be printed.<p> + + The attributes record, version, instance, options must not be returned.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#getAttributeMap()">getAttributeMap</a></code> in class <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the attribute map</dd></dl> +</li> +</ul> </li> </ul> </li> Modified: poi/site/publish/apidocs/org/apache/poi/ddf/EscherComplexProperty.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ddf/EscherComplexProperty.html?rev=1800563&r1=1800562&r2=1800563&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ddf/EscherComplexProperty.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ddf/EscherComplexProperty.html Sun Jul 2 13:21:20 2017 @@ -377,8 +377,8 @@ extends <a href="../../../../org/apache/ <pre>public java.lang.String toString()</pre> <div class="block">Retrieves the string representation for this property.</div> <dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/poi/ddf/EscherProperty.html#toString()">toString</a></code> in class <code><a href="../../../../org/apache/poi/ddf/EscherProperty.html" title="class in org.apache.poi.ddf">EscherProperty</a></code></dd> </dl> </li> </ul> Modified: poi/site/publish/apidocs/org/apache/poi/ddf/EscherContainerRecord.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ddf/EscherContainerRecord.html?rev=1800563&r1=1800562&r2=1800563&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ddf/EscherContainerRecord.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ddf/EscherContainerRecord.html Sun Jul 2 13:21:20 2017 @@ -219,23 +219,30 @@ implements java.lang.Iterable<<a href </td> </tr> <tr class="altColor"> +<td class="colFirst"><code>protected java.lang.Object[][]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#getAttributeMap()">getAttributeMap</a></strong>()</code> +<div class="block">For the purpose of providing toString() and toXml() a subclass can either override those methods + or provide a Object[][] array in the form { { "Attribute Name (Header)", value, "optional attribute", value }, ...</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#getChild(int)">getChild</a></strong>(int index)</code> <div class="block">Returns the indexed child record.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code><T extends <a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a>> <br>T</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#getChildById(short)">getChildById</a></strong>(short recordId)</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html" title="class in org.apache.poi.ddf">EscherContainerRecord</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#getChildContainers()">getChildContainers</a></strong>()</code> <div class="block">Returns all of our children which are also EscherContainers (may be 0, 1, or vary rarely 2 or 3)</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>java.util.Iterator<<a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#getChildIterator()">getChildIterator</a></strong>()</code> <div class="block"><strong>Deprecated.</strong> @@ -244,47 +251,47 @@ implements java.lang.Iterable<<a href </div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>java.util.List<<a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#getChildRecords()">getChildRecords</a></strong>()</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#getRecordName()">getRecordName</a></strong>()</code> <div class="block">Subclasses should return the short name for this escher record.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#getRecordsById(short,%20java.util.List)">getRecordsById</a></strong>(short recordId, java.util.List<<a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a>> out)</code> <div class="block">Recursively find records with the specified record ID</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#getRecordSize()">getRecordSize</a></strong>()</code> <div class="block">Subclasses should effeciently return the number of bytes required to serialize the record.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#hasChildOfType(short)">hasChildOfType</a></strong>(short recordId)</code> <div class="block">Do any of our (top level) children have the given recordId?</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>java.util.Iterator<<a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a>></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#iterator()">iterator</a></strong>()</code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#removeChildRecord(org.apache.poi.ddf.EscherRecord)">removeChildRecord</a></strong>(<a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a> toBeRemoved)</code> <div class="block">Removes the given escher record from the child list</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#serialize(int,%20byte[],%20org.apache.poi.ddf.EscherSerializationListener)">serialize</a></strong>(int offset, byte[] data, @@ -292,27 +299,19 @@ implements java.lang.Iterable<<a href <div class="block">Serializes the record to an existing byte array.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#setChildRecords(java.util.List)">setChildRecords</a></strong>(java.util.List<<a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a>> childRecords)</code> <div class="block">replaces the internal child list with the contents of the supplied <tt>childRecords</tt></div> </td> </tr> -<tr class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#toString()">toString</a></strong>()</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherContainerRecord.html#toXml(java.lang.String)">toXml</a></strong>(java.lang.String tab)</code> </td> -</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.ddf.EscherRecord"> <!-- --> </a> <h3>Methods inherited from class org.apache.poi.ddf.<a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></h3> -<code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#clone()">clone</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#fillFields(byte[],%20org.apache.poi.ddf.EscherRecordFactory)">fillFields</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#formatXmlRecordHeader(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)">formatXmlRecordHeader</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getInstance()">getInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getOptions()">getOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getRecordId()">getRecordId</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getVersion()">getVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#isContainerRecord()">isContainerRecord</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readHeader(byte[],%20int)">readHeader</a>, <a href="../../../../org/apache/ poi/ddf/EscherRecord.html#readInstance(byte[],%20int)">readInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize()">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize(int,%20byte[])">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setInstance(short)">setInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setOptions(short)">setOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setRecordId(short)">setRecordId</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setVersion(short)">setVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml()">toXml</a></code></li> +<code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#clone()">clone</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#fillFields(byte[],%20org.apache.poi.ddf.EscherRecordFactory)">fillFields</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getInstance()">getInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getOptions()">getOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getRecordId()">getRecordId</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getVersion()">getVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#isContainerRecord()">isContainerRecord</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readHeader(byte[],%20int)">readHeader</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readInstance(byte[],%20int)">readInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize()">serialize</a>, <a href="../../../../org/ap ache/poi/ddf/EscherRecord.html#serialize(int,%20byte[])">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setInstance(short)">setInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setOptions(short)">setOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setRecordId(short)">setRecordId</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setVersion(short)">setVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toString()">toString</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml()">toXml</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml(java.lang.String)">toXml</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> @@ -638,33 +637,6 @@ public java.util.Iterator<<a hre <dl><dt><span class="strong">Parameters:</span></dt><dd><code>record</code> - the record to be added</dd><dd><code>insertBeforeRecordId</code> - the recordId of the next sibling</dd></dl> </li> </ul> -<a name="toString()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>toString</h4> -<pre>public java.lang.String toString()</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>toString</code> in class <code>java.lang.Object</code></dd> -</dl> -</li> -</ul> -<a name="toXml(java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>toXml</h4> -<pre>public java.lang.String toXml(java.lang.String tab)</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml(java.lang.String)">toXml</a></code> in class <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>tab</code> - - each children must be a right of his parent</dd> -<dt><span class="strong">Returns:</span></dt><dd>xml representation of this record</dd></dl> -</li> -</ul> <a name="getChildById(short)"> <!-- --> </a> @@ -677,7 +649,7 @@ public java.util.Iterator<<a hre <a name="getRecordsById(short, java.util.List)"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>getRecordsById</h4> <pre>public void getRecordsById(short recordId, @@ -686,6 +658,26 @@ public java.util.Iterator<<a hre <dl><dt><span class="strong">Parameters:</span></dt><dd><code>recordId</code> - the recordId to be searched for</dd><dd><code>out</code> - - list to store found records</dd></dl> </li> </ul> +<a name="getAttributeMap()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAttributeMap</h4> +<pre>protected java.lang.Object[][] getAttributeMap()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#getAttributeMap()">EscherRecord</a></code></strong></div> +<div class="block">For the purpose of providing toString() and toXml() a subclass can either override those methods + or provide a Object[][] array in the form <code>{ { "Attribute Name (Header)", value, "optional attribute", value }, ... } </code>.<p> + + Null values won't be printed.<p> + + The attributes record, version, instance, options must not be returned.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#getAttributeMap()">getAttributeMap</a></code> in class <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the attribute map</dd></dl> +</li> +</ul> </li> </ul> </li> Modified: poi/site/publish/apidocs/org/apache/poi/ddf/EscherDgRecord.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ddf/EscherDgRecord.html?rev=1800563&r1=1800562&r2=1800563&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ddf/EscherDgRecord.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ddf/EscherDgRecord.html Sun Jul 2 13:21:20 2017 @@ -179,48 +179,55 @@ extends <a href="../../../../org/apache/ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code>protected java.lang.Object[][]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDgRecord.html#getAttributeMap()">getAttributeMap</a></strong>()</code> +<div class="block">For the purpose of providing toString() and toXml() a subclass can either override those methods + or provide a Object[][] array in the form { { "Attribute Name (Header)", value, "optional attribute", value }, ...</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDgRecord.html#getDrawingGroupId()">getDrawingGroupId</a></strong>()</code> <div class="block">Gets the drawing group id for this record.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDgRecord.html#getLastMSOSPID()">getLastMSOSPID</a></strong>()</code> <div class="block">The last shape id used in this drawing group.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDgRecord.html#getNumShapes()">getNumShapes</a></strong>()</code> <div class="block">The number of shapes in this drawing group.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDgRecord.html#getRecordId()">getRecordId</a></strong>()</code> <div class="block">Return the current record id.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDgRecord.html#getRecordName()">getRecordName</a></strong>()</code> <div class="block">Subclasses should return the short name for this escher record.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDgRecord.html#getRecordSize()">getRecordSize</a></strong>()</code> <div class="block">Returns the number of bytes that are required to serialize this record.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDgRecord.html#incrementShapeCount()">incrementShapeCount</a></strong>()</code> <div class="block">Increments the number of shapes</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDgRecord.html#serialize(int,%20byte[],%20org.apache.poi.ddf.EscherSerializationListener)">serialize</a></strong>(int offset, byte[] data, @@ -228,35 +235,25 @@ extends <a href="../../../../org/apache/ <div class="block">Serializes the record to an existing byte array.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDgRecord.html#setLastMSOSPID(int)">setLastMSOSPID</a></strong>(int field_2_lastMSOSPID)</code> <div class="block">The last shape id used in this drawing group.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDgRecord.html#setNumShapes(int)">setNumShapes</a></strong>(int field_1_numShapes)</code> <div class="block">The number of shapes in this drawing group.</div> </td> </tr> -<tr class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDgRecord.html#toString()">toString</a></strong>()</code> -<div class="block">Returns the string representation of this record.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDgRecord.html#toXml(java.lang.String)">toXml</a></strong>(java.lang.String tab)</code> </td> -</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.ddf.EscherRecord"> <!-- --> </a> <h3>Methods inherited from class org.apache.poi.ddf.<a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></h3> -<code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#clone()">clone</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#display(java.io.PrintWriter,%20int)">display</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#fillFields(byte[],%20org.apache.poi.ddf.EscherRecordFactory)">fillFields</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#formatXmlRecordHeader(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)">formatXmlRecordHeader</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChild(int)">getChild</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChildRecords()">getChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getInstance()">getInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getOptions()">getOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getVersion()">getVersion</a>, <a href="../../../../org/apache/ poi/ddf/EscherRecord.html#isContainerRecord()">isContainerRecord</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readHeader(byte[],%20int)">readHeader</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readInstance(byte[],%20int)">readInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize()">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize(int,%20byte[])">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setChildRecords(java.util.List)">setChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setInstance(short)">setInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setOptions(short)">setOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setRecordId(short)">setRecordId</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setVersion(short)">setVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRe cord.html#toXml()">toXml</a></code></li> +<code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#clone()">clone</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#display(java.io.PrintWriter,%20int)">display</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#fillFields(byte[],%20org.apache.poi.ddf.EscherRecordFactory)">fillFields</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChild(int)">getChild</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChildRecords()">getChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getInstance()">getInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getOptions()">getOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getVersion()">getVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#isContainerRecord()">isContainerRecord</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readHeader(byte[],%20int)">readHeader</a>, <a href="../../ ../../org/apache/poi/ddf/EscherRecord.html#readInstance(byte[],%20int)">readInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize()">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize(int,%20byte[])">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setChildRecords(java.util.List)">setChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setInstance(short)">setInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setOptions(short)">setOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setRecordId(short)">setRecordId</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setVersion(short)">setVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toString()">toString</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml()">toXml</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml(java.lan g.String)">toXml</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> @@ -409,34 +406,6 @@ extends <a href="../../../../org/apache/ <dt><span class="strong">Returns:</span></dt><dd>the short name for this escher record</dd></dl> </li> </ul> -<a name="toString()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>toString</h4> -<pre>public java.lang.String toString()</pre> -<div class="block">Returns the string representation of this record.</div> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>toString</code> in class <code>java.lang.Object</code></dd> -</dl> -</li> -</ul> -<a name="toXml(java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>toXml</h4> -<pre>public java.lang.String toXml(java.lang.String tab)</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml(java.lang.String)">toXml</a></code> in class <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>tab</code> - - each children must be a right of his parent</dd> -<dt><span class="strong">Returns:</span></dt><dd>xml representation of this record</dd></dl> -</li> -</ul> <a name="getNumShapes()"> <!-- --> </a> @@ -496,13 +465,33 @@ extends <a href="../../../../org/apache/ <a name="incrementShapeCount()"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>incrementShapeCount</h4> <pre>public void incrementShapeCount()</pre> <div class="block">Increments the number of shapes</div> </li> </ul> +<a name="getAttributeMap()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAttributeMap</h4> +<pre>protected java.lang.Object[][] getAttributeMap()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#getAttributeMap()">EscherRecord</a></code></strong></div> +<div class="block">For the purpose of providing toString() and toXml() a subclass can either override those methods + or provide a Object[][] array in the form <code>{ { "Attribute Name (Header)", value, "optional attribute", value }, ... } </code>.<p> + + Null values won't be printed.<p> + + The attributes record, version, instance, options must not be returned.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#getAttributeMap()">getAttributeMap</a></code> in class <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the attribute map</dd></dl> +</li> +</ul> </li> </ul> </li> Modified: poi/site/publish/apidocs/org/apache/poi/ddf/EscherDggRecord.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ddf/EscherDggRecord.html?rev=1800563&r1=1800562&r2=1800563&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/ddf/EscherDggRecord.html (original) +++ poi/site/publish/apidocs/org/apache/poi/ddf/EscherDggRecord.html Sun Jul 2 13:21:20 2017 @@ -212,59 +212,66 @@ extends <a href="../../../../org/apache/ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><code>protected java.lang.Object[][]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#getAttributeMap()">getAttributeMap</a></strong>()</code> +<div class="block">For the purpose of providing toString() and toXml() a subclass can either override those methods + or provide a Object[][] array in the form { { "Attribute Name (Header)", value, "optional attribute", value }, ...</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#getDrawingsSaved()">getDrawingsSaved</a></strong>()</code> <div class="block">Gets the number of drawings saved</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/poi/ddf/EscherDggRecord.FileIdCluster.html" title="class in org.apache.poi.ddf">EscherDggRecord.FileIdCluster</a>[]</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#getFileIdClusters()">getFileIdClusters</a></strong>()</code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#getMaxDrawingGroupId()">getMaxDrawingGroupId</a></strong>()</code> <div class="block">Gets the maximum drawing group ID</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#getNumIdClusters()">getNumIdClusters</a></strong>()</code> <div class="block">Number of id clusters + 1</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#getNumShapesSaved()">getNumShapesSaved</a></strong>()</code> <div class="block">Gets the number of shapes saved</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>short</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#getRecordId()">getRecordId</a></strong>()</code> <div class="block">Return the current record id.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#getRecordName()">getRecordName</a></strong>()</code> <div class="block">Subclasses should return the short name for this escher record.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#getRecordSize()">getRecordSize</a></strong>()</code> <div class="block">Subclasses should effeciently return the number of bytes required to serialize the record.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#getShapeIdMax()">getShapeIdMax</a></strong>()</code> <div class="block">Gets the next available shape id</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#serialize(int,%20byte[],%20org.apache.poi.ddf.EscherSerializationListener)">serialize</a></strong>(int offset, byte[] data, @@ -272,51 +279,43 @@ extends <a href="../../../../org/apache/ <div class="block">Serializes the record to an existing byte array.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#setDrawingsSaved(int)">setDrawingsSaved</a></strong>(int drawingsSaved)</code> <div class="block">Sets the number of drawings saved</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#setFileIdClusters(org.apache.poi.ddf.EscherDggRecord.FileIdCluster[])">setFileIdClusters</a></strong>(<a href="../../../../org/apache/poi/ddf/EscherDggRecord.FileIdCluster.html" title="class in org.apache.poi.ddf">EscherDggRecord.FileIdCluster</a>[] fileIdClusters)</code> <div class="block">Sets the file id clusters</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#setMaxDrawingGroupId(int)">setMaxDrawingGroupId</a></strong>(int id)</code> <div class="block">Sets the maximum drawing group ID</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#setNumShapesSaved(int)">setNumShapesSaved</a></strong>(int numShapesSaved)</code> <div class="block">Sets the number of shapes saved</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#setShapeIdMax(int)">setShapeIdMax</a></strong>(int shapeIdMax)</code> <div class="block">The maximum is actually the next available shape id.</div> </td> </tr> -<tr class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#toString()">toString</a></strong>()</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../org/apache/poi/ddf/EscherDggRecord.html#toXml(java.lang.String)">toXml</a></strong>(java.lang.String tab)</code> </td> -</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.ddf.EscherRecord"> <!-- --> </a> <h3>Methods inherited from class org.apache.poi.ddf.<a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></h3> -<code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#clone()">clone</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#display(java.io.PrintWriter,%20int)">display</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#fillFields(byte[],%20org.apache.poi.ddf.EscherRecordFactory)">fillFields</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#formatXmlRecordHeader(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)">formatXmlRecordHeader</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChild(int)">getChild</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChildRecords()">getChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getInstance()">getInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getOptions()">getOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getVersion()">getVersion</a>, <a href="../../../../org/apache/ poi/ddf/EscherRecord.html#isContainerRecord()">isContainerRecord</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readHeader(byte[],%20int)">readHeader</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readInstance(byte[],%20int)">readInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize()">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize(int,%20byte[])">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setChildRecords(java.util.List)">setChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setInstance(short)">setInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setOptions(short)">setOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setRecordId(short)">setRecordId</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setVersion(short)">setVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRe cord.html#toXml()">toXml</a></code></li> +<code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#clone()">clone</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#display(java.io.PrintWriter,%20int)">display</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#fillFields(byte[],%20org.apache.poi.ddf.EscherRecordFactory)">fillFields</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChild(int)">getChild</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getChildRecords()">getChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getInstance()">getInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getOptions()">getOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#getVersion()">getVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#isContainerRecord()">isContainerRecord</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#readHeader(byte[],%20int)">readHeader</a>, <a href="../../ ../../org/apache/poi/ddf/EscherRecord.html#readInstance(byte[],%20int)">readInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize()">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#serialize(int,%20byte[])">serialize</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setChildRecords(java.util.List)">setChildRecords</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setInstance(short)">setInstance</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setOptions(short)">setOptions</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setRecordId(short)">setRecordId</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#setVersion(short)">setVersion</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toString()">toString</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml()">toXml</a>, <a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml(java.lan g.String)">toXml</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> @@ -471,33 +470,6 @@ extends <a href="../../../../org/apache/ <dt><span class="strong">Returns:</span></dt><dd>the short name for this escher record</dd></dl> </li> </ul> -<a name="toString()"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>toString</h4> -<pre>public java.lang.String toString()</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code>toString</code> in class <code>java.lang.Object</code></dd> -</dl> -</li> -</ul> -<a name="toXml(java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>toXml</h4> -<pre>public java.lang.String toXml(java.lang.String tab)</pre> -<dl> -<dt><strong>Overrides:</strong></dt> -<dd><code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#toXml(java.lang.String)">toXml</a></code> in class <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></code></dd> -<dt><span class="strong">Parameters:</span></dt><dd><code>tab</code> - - each children must be a right of his parent</dd> -<dt><span class="strong">Returns:</span></dt><dd>xml representation of this record</dd></dl> -</li> -</ul> <a name="getShapeIdMax()"> <!-- --> </a> @@ -633,7 +605,7 @@ extends <a href="../../../../org/apache/ <a name="addCluster(int, int, boolean)"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>addCluster</h4> <pre>public void addCluster(int dgId, @@ -644,6 +616,26 @@ extends <a href="../../../../org/apache/ In Excel the clusters are sorted but in PPT they are not)</dd></dl> </li> </ul> +<a name="getAttributeMap()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAttributeMap</h4> +<pre>protected java.lang.Object[][] getAttributeMap()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#getAttributeMap()">EscherRecord</a></code></strong></div> +<div class="block">For the purpose of providing toString() and toXml() a subclass can either override those methods + or provide a Object[][] array in the form <code>{ { "Attribute Name (Header)", value, "optional attribute", value }, ... } </code>.<p> + + Null values won't be printed.<p> + + The attributes record, version, instance, options must not be returned.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/poi/ddf/EscherRecord.html#getAttributeMap()">getAttributeMap</a></code> in class <code><a href="../../../../org/apache/poi/ddf/EscherRecord.html" title="class in org.apache.poi.ddf">EscherRecord</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the attribute map</dd></dl> +</li> +</ul> </li> </ul> </li> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@poi.apache.org For additional commands, e-mail: commits-h...@poi.apache.org
