Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/ClassID.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/ClassID.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/ClassID.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/ClassID.html Tue May 2 23:37:06 2017 @@ -84,22 +84,29 @@ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.poi.hpsf.wellknown">org.apache.poi.hpsf.wellknown</a></td> +<td class="colLast"> +<div class="block"><div> + Specific support for DocumentSummaryInformation, SummaryInformation types.</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.poi.hslf.usermodel">org.apache.poi.hslf.usermodel</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.hssf.usermodel">org.apache.poi.hssf.usermodel</a></td> <td class="colLast"> <div class="block">usermodel package maps HSSF low level strutures to familiar workbook/sheet model</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.poi.poifs.filesystem">org.apache.poi.poifs.filesystem</a></td> <td class="colLast"> <div class="block">filesystem package maps OLE 2 Compound document files to a more familiar filesystem interface.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.poifs.property">org.apache.poi.poifs.property</a></td> <td class="colLast"> <div class="block">property package contains high and low level Property structures for POIFS.</div> @@ -258,25 +265,89 @@ </tr> <tbody> <tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><span class="strong">ClassID.</span><code><strong><a href="../../../../../org/apache/poi/hpsf/ClassID.html#equalsInverted(org.apache.poi.hpsf.ClassID)">equalsInverted</a></strong>(<a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> o)</code> +<div class="block">Checks whether this <code>ClassID</code> is equal to another ClassID with inverted endianess, + because there are apparently not only version 1 GUIDs (aka "network" with big-endian encoding), + but also version 2 GUIDs (aka "native" with little-endian encoding) out there.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">PropertySet.</span><code><strong><a href="../../../../../org/apache/poi/hpsf/PropertySet.html#setClassID(org.apache.poi.hpsf.ClassID)">setClassID</a></strong>(<a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> classID)</code> <div class="block">Sets the property set stream's low-level "class ID" field.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><span class="strong">Section.</span><code><strong><a href="../../../../../org/apache/poi/hpsf/Section.html#setFormatID(org.apache.poi.hpsf.ClassID)">setFormatID</a></strong>(<a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> formatID)</code> <div class="block">Sets the section's format ID.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><span class="strong">TypeWriter.</span><code><strong><a href="../../../../../org/apache/poi/hpsf/TypeWriter.html#writeToStream(java.io.OutputStream,%20org.apache.poi.hpsf.ClassID)">writeToStream</a></strong>(java.io.OutputStream out, <a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> n)</code> +<div class="block"><strong>Deprecated.</strong> </div> <div class="block">Writes a 16-byte <a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf"><code>ClassID</code></a> to an output stream.</div> </td> </tr> </tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.poi.hpsf.wellknown"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> in <a href="../../../../../org/apache/poi/hpsf/wellknown/package-summary.html">org.apache.poi.hpsf.wellknown</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing fields, and an explanation"> +<caption><span>Fields in <a href="../../../../../org/apache/poi/hpsf/wellknown/package-summary.html">org.apache.poi.hpsf.wellknown</a> declared as <a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a>[]</code></td> +<td class="colLast"><span class="strong">SectionIDMap.</span><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#DOCUMENT_SUMMARY_INFORMATION_ID">DOCUMENT_SUMMARY_INFORMATION_ID</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a></code></td> +<td class="colLast"><span class="strong">SectionIDMap.</span><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#SUMMARY_INFORMATION_ID">SUMMARY_INFORMATION_ID</a></strong></code> +<div class="block">The SummaryInformation's section's format ID.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../org/apache/poi/hpsf/wellknown/package-summary.html">org.apache.poi.hpsf.wellknown</a> with parameters of type <a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a></code></td> +<td class="colLast"><span class="strong">SectionIDMap.</span><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#get(org.apache.poi.hpsf.ClassID)">get</a></strong>(<a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> sectionFormatID)</code> +<div class="block">Returns the <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a> for a given section format + ID.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><span class="strong">SectionIDMap.</span><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#getPIDString(org.apache.poi.hpsf.ClassID,%20long)">getPIDString</a></strong>(<a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> sectionFormatID, + long pid)</code> +<div class="block">Returns the property ID string that is associated with a + given property ID in a section format ID's namespace.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a></code></td> +<td class="colLast"><span class="strong">SectionIDMap.</span><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#put(org.apache.poi.hpsf.ClassID,%20org.apache.poi.hpsf.wellknown.PropertyIDMap)">put</a></strong>(<a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> sectionFormatID, + <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a> propertyIDMap)</code> +<div class="block">Associates a section format ID with a <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a>.</div> +</td> +</tr> +</tbody> </table> </li> <li class="blockList"><a name="org.apache.poi.hslf.usermodel">
Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/MarkUnsupportedException.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/MarkUnsupportedException.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/MarkUnsupportedException.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/MarkUnsupportedException.html Tue May 2 23:37:06 2017 @@ -121,10 +121,20 @@ </tr> <tbody> <tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html#DocumentSummaryInformation(java.io.InputStream)">DocumentSummaryInformation</a></strong>(java.io.InputStream stream)</code> +<div class="block">Creates a <a href="../../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> instance from an <code>InputStream</code> in the Horrible Property Set Format.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/PropertySet.html#PropertySet(java.io.InputStream)">PropertySet</a></strong>(java.io.InputStream stream)</code> <div class="block">Creates a <a href="../../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> instance from an <code>InputStream</code> in the Horrible Property Set Format.</div> </td> </tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/SummaryInformation.html#SummaryInformation(java.io.InputStream)">SummaryInformation</a></strong>(java.io.InputStream stream)</code> +<div class="block">Creates a <a href="../../../../../org/apache/poi/hpsf/SummaryInformation.html" title="class in org.apache.poi.hpsf"><code>SummaryInformation</code></a> instance from an <code>InputStream</code> in the Horrible Property Set Format.</div> +</td> +</tr> </tbody> </table> </li> Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/NoPropertySetStreamException.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/NoPropertySetStreamException.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/NoPropertySetStreamException.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/NoPropertySetStreamException.html Tue May 2 23:37:06 2017 @@ -122,12 +122,17 @@ </tr> <tbody> <tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html#DocumentSummaryInformation(java.io.InputStream)">DocumentSummaryInformation</a></strong>(java.io.InputStream stream)</code> +<div class="block">Creates a <a href="../../../../../org/apache/poi/hpsf/DocumentSummaryInformation.html" title="class in org.apache.poi.hpsf"><code>DocumentSummaryInformation</code></a> instance from an <code>InputStream</code> in the Horrible Property Set Format.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/PropertySet.html#PropertySet(byte[])">PropertySet</a></strong>(byte[] stream)</code> <div class="block">Creates a <a href="../../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> instance from a byte array that represents a stream in the Horrible Property Set Format.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/PropertySet.html#PropertySet(byte[],%20int,%20int)">PropertySet</a></strong>(byte[] stream, int offset, int length)</code> @@ -135,11 +140,16 @@ represents a stream in the Horrible Property Set Format.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/PropertySet.html#PropertySet(java.io.InputStream)">PropertySet</a></strong>(java.io.InputStream stream)</code> <div class="block">Creates a <a href="../../../../../org/apache/poi/hpsf/PropertySet.html" title="class in org.apache.poi.hpsf"><code>PropertySet</code></a> instance from an <code>InputStream</code> in the Horrible Property Set Format.</div> </td> </tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/SummaryInformation.html#SummaryInformation(java.io.InputStream)">SummaryInformation</a></strong>(java.io.InputStream stream)</code> +<div class="block">Creates a <a href="../../../../../org/apache/poi/hpsf/SummaryInformation.html" title="class in org.apache.poi.hpsf"><code>SummaryInformation</code></a> instance from an <code>InputStream</code> in the Horrible Property Set Format.</div> +</td> +</tr> </tbody> </table> </li> Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/Property.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/Property.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/Property.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/Property.html Tue May 2 23:37:06 2017 @@ -162,6 +162,7 @@ <td class="colLast"><span class="strong">TypeWriter.</span><code><strong><a href="../../../../../org/apache/poi/hpsf/TypeWriter.html#writeToStream(java.io.OutputStream,%20org.apache.poi.hpsf.Property[],%20int)">writeToStream</a></strong>(java.io.OutputStream out, <a href="../../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a>[] properties, int codepage)</code> +<div class="block"><strong>Deprecated.</strong> </div> <div class="block">Writes an array of <a href="../../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> instances to an output stream according to the Horrible Property Stream Format.</div> </td> Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/ReadingNotSupportedException.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/ReadingNotSupportedException.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/ReadingNotSupportedException.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/ReadingNotSupportedException.html Tue May 2 23:37:06 2017 @@ -109,6 +109,13 @@ <div class="block">Reads a variant type from a byte array.</div> </td> </tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Object</code></td> +<td class="colLast"><span class="strong">VariantSupport.</span><code><strong><a href="../../../../../org/apache/poi/hpsf/VariantSupport.html#read(org.apache.poi.util.LittleEndianByteArrayInputStream,%20int,%20long,%20int)">read</a></strong>(<a href="../../../../../org/apache/poi/util/LittleEndianByteArrayInputStream.html" title="class in org.apache.poi.util">LittleEndianByteArrayInputStream</a> lei, + int length, + long type, + int codepage)</code> </td> +</tr> </tbody> </table> </li> Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/UnsupportedVariantTypeException.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/UnsupportedVariantTypeException.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/UnsupportedVariantTypeException.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/UnsupportedVariantTypeException.html Tue May 2 23:37:06 2017 @@ -143,6 +143,7 @@ <td class="colLast"><span class="strong">TypeWriter.</span><code><strong><a href="../../../../../org/apache/poi/hpsf/TypeWriter.html#writeToStream(java.io.OutputStream,%20org.apache.poi.hpsf.Property[],%20int)">writeToStream</a></strong>(java.io.OutputStream out, <a href="../../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf">Property</a>[] properties, int codepage)</code> +<div class="block"><strong>Deprecated.</strong> </div> <div class="block">Writes an array of <a href="../../../../../org/apache/poi/hpsf/Property.html" title="class in org.apache.poi.hpsf"><code>Property</code></a> instances to an output stream according to the Horrible Property Stream Format.</div> </td> Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/WritingNotSupportedException.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/WritingNotSupportedException.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/WritingNotSupportedException.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/class-use/WritingNotSupportedException.html Tue May 2 23:37:06 2017 @@ -101,7 +101,7 @@ <tbody> <tr class="altColor"> <td class="colFirst"><code>protected int</code></td> -<td class="colLast"><span class="strong">Property.</span><code><strong><a href="../../../../../org/apache/poi/hpsf/Property.html#getSize()">getSize</a></strong>()</code> +<td class="colLast"><span class="strong">Property.</span><code><strong><a href="../../../../../org/apache/poi/hpsf/Property.html#getSize(int)">getSize</a></strong>(int codepage)</code> <div class="block">Returns the property's size in bytes.</div> </td> </tr> Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/package-summary.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/package-summary.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/package-summary.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/package-summary.html Tue May 2 23:37:06 2017 @@ -180,8 +180,8 @@ </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/poi/hpsf/TypeWriter.html" title="class in org.apache.poi.hpsf">TypeWriter</a></td> -<td class="colLast"> -<div class="block">Class for writing little-endian data and more.</div> +<td class="colLast">Deprecated +<div class="block"><i>POI 3.16 beta 2 - use LittleEndian instead</i></div> </td> </tr> <tr class="altColor"> @@ -193,7 +193,7 @@ <tr class="rowColor"> <td class="colFirst"><a href="../../../../org/apache/poi/hpsf/Variant.html" title="class in org.apache.poi.hpsf">Variant</a></td> <td class="colLast"> -<div class="block">The <em>Variant</em> types as defined by Microsoft's COM.</div> +<div class="block">The <code>Variant</code> types as defined by Microsoft's COM.</div> </td> </tr> <tr class="altColor"> Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/package-use.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/package-use.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/package-use.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/package-use.html Tue May 2 23:37:06 2017 @@ -88,34 +88,41 @@ </td> </tr> <tr class="altColor"> +<td class="colFirst"><a href="#org.apache.poi.hpsf.wellknown">org.apache.poi.hpsf.wellknown</a></td> +<td class="colLast"> +<div class="block"><div> + Specific support for DocumentSummaryInformation, SummaryInformation types.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.hslf.usermodel">org.apache.poi.hslf.usermodel</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.poi.hssf.converter">org.apache.poi.hssf.converter</a></td> <td class="colLast"> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.hssf.extractor">org.apache.poi.hssf.extractor</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.poi.hssf.usermodel">org.apache.poi.hssf.usermodel</a></td> <td class="colLast"> <div class="block">usermodel package maps HSSF low level strutures to familiar workbook/sheet model</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.hwpf.converter">org.apache.poi.hwpf.converter</a></td> <td class="colLast"> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.poi.poifs.filesystem">org.apache.poi.poifs.filesystem</a></td> <td class="colLast"> <div class="block">filesystem package maps OLE 2 Compound document files to a more familiar filesystem interface.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.poi.poifs.property">org.apache.poi.poifs.property</a></td> <td class="colLast"> <div class="block">property package contains high and low level Property structures for POIFS.</div> @@ -291,7 +298,7 @@ </tr> <tr class="rowColor"> <td class="colOne"><a href="../../../../org/apache/poi/hpsf/class-use/Variant.html#org.apache.poi.hpsf">Variant</a> -<div class="block">The <em>Variant</em> types as defined by Microsoft's COM.</div> +<div class="block">The <code>Variant</code> types as defined by Microsoft's COM.</div> </td> </tr> <tr class="altColor"> @@ -306,6 +313,23 @@ </td> </tr> </tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.poi.hpsf.wellknown"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../org/apache/poi/hpsf/package-summary.html">org.apache.poi.hpsf</a> used by <a href="../../../../org/apache/poi/hpsf/wellknown/package-summary.html">org.apache.poi.hpsf.wellknown</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../org/apache/poi/hpsf/class-use/ClassID.html#org.apache.poi.hpsf.wellknown">ClassID</a> +<div class="block">Represents a class ID (16 bytes).</div> +</td> +</tr> +</tbody> </table> </li> <li class="blockList"><a name="org.apache.poi.hslf.usermodel"> Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/wellknown/PropertyIDMap.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/wellknown/PropertyIDMap.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/wellknown/PropertyIDMap.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/wellknown/PropertyIDMap.html Tue May 2 23:37:06 2017 @@ -114,12 +114,12 @@ <br> <pre>public class <span class="strong">PropertyIDMap</span> extends java.util.HashMap<java.lang.Long,java.lang.String></pre> -<div class="block"><p>This is a dictionary which maps property ID values to property - ID strings.</p> +<div class="block">This is a dictionary which maps property ID values to property + ID strings. - <p>The methods <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#getSummaryInformationProperties()"><code>getSummaryInformationProperties()</code></a> and <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#getDocumentSummaryInformationProperties()"><code>getDocumentSummaryInformationProperties()</code></a> return singleton <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a>s. An application that wants to extend these maps + The methods <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#getSummaryInformationProperties()"><code>getSummaryInformationProperties()</code></a> and <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#getDocumentSummaryInformationProperties()"><code>getDocumentSummaryInformationProperties()</code></a> return singleton <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a>s. An application that wants to extend these maps should treat them as unmodifiable, copy them and modifiy the - copies.</p></div> + copies.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.poi.hpsf.wellknown.PropertyIDMap">Serialized Form</a></dd></dl> </li> </ul> @@ -169,82 +169,89 @@ extends java.util.HashMap<java.lang.L </tr> <tr class="altColor"> <td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_BEHAVIOUR">PID_BEHAVIOUR</a></strong></code> +<div class="block">The Behavior property, if present, MUST have the property identifier 0x80000003, + MUST NOT have a property name, and MUST have type VT_UI4 (0x0013).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_BYTECOUNT">PID_BYTECOUNT</a></strong></code> <div class="block">Number of bytes.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_CATEGORY">PID_CATEGORY</a></strong></code> <div class="block">The entry is a string denoting the category the file belongs to, e.g.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_CCHWITHSPACES">PID_CCHWITHSPACES</a></strong></code> <div class="block">The entry specifies an estimate of the number of characters in the document, including whitespace, as an integer</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_CHARCOUNT">PID_CHARCOUNT</a></strong></code> <div class="block">ID of the property that denotes the number of characters in the document</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_CODEPAGE">PID_CODEPAGE</a></strong></code> <div class="block">The entry denotes a code page.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_COMMENTS">PID_COMMENTS</a></strong></code> <div class="block">ID of the property that denotes the document's comments</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_COMPANY">PID_COMPANY</a></strong></code> <div class="block">This entry contains the company name.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_CONTENTSTATUS">PID_CONTENTSTATUS</a></strong></code> <div class="block">This entry contains a string of the document status.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_CONTENTTYPE">PID_CONTENTTYPE</a></strong></code> <div class="block">This entry contains a string of the content type of the file.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_CREATE_DTM">PID_CREATE_DTM</a></strong></code> <div class="block">ID of the property that denotes the date and time the document was created.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_DICTIONARY">PID_DICTIONARY</a></strong></code> <div class="block">The entry is a dictionary.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_DIGSIG">PID_DIGSIG</a></strong></code> <div class="block">This entry contains the VBA digital signature for the VBA project embedded in the document.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_DOCPARTS">PID_DOCPARTS</a></strong></code> <div class="block">This entry contains the names of document parts (word: names @@ -252,32 +259,32 @@ extends java.util.HashMap<java.lang.L power point: slide titles, binder: document names).</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_DOCVERSION">PID_DOCVERSION</a></strong></code> <div class="block">This entry contains a string of the document version, but normally should be empty</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_EDITTIME">PID_EDITTIME</a></strong></code> <div class="block">ID of the property that denotes the document's edit time</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_HEADINGPAIR">PID_HEADINGPAIR</a></strong></code> <div class="block">This entry denotes an internally used property.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_HIDDENCOUNT">PID_HIDDENCOUNT</a></strong></code> <div class="block">Number of hidden slides.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_HYPERLINKSCHANGED">PID_HYPERLINKSCHANGED</a></strong></code> <div class="block">This entry contains a boolean which marks if the User Defined @@ -285,52 +292,59 @@ extends java.util.HashMap<java.lang.L hyperlinks should be updated on document load.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_KEYWORDS">PID_KEYWORDS</a></strong></code> <div class="block">ID of the property that denotes the document's keywords</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_LANGUAGE">PID_LANGUAGE</a></strong></code> <div class="block">This entry contains a string of the document language, but normally should be empty.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_LASTAUTHOR">PID_LASTAUTHOR</a></strong></code> <div class="block">ID of the property that denotes the document's last author</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_LASTPRINTED">PID_LASTPRINTED</a></strong></code> <div class="block">ID of the property that denotes the date and time the document was last printed</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_LASTSAVE_DTM">PID_LASTSAVE_DTM</a></strong></code> <div class="block">ID of the property that denotes the date and time the document was saved</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_LINECOUNT">PID_LINECOUNT</a></strong></code> <div class="block">Number of lines.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_LINKSDIRTY">PID_LINKSDIRTY</a></strong></code> <div class="block">If this entry is -1 the links are dirty and should be re-evaluated.</div> </td> </tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_LOCALE">PID_LOCALE</a></strong></code> +<div class="block">The Locale property, if present, MUST have the property identifier 0x80000000, + MUST NOT have a property name, and MUST have type VT_UI4 (0x0013).</div> +</td> +</tr> <tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html#PID_MANAGER">PID_MANAGER</a></strong></code> @@ -559,7 +573,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_TITLE</h4> <pre>public static final int PID_TITLE</pre> -<div class="block"><p>ID of the property that denotes the document's title</p></div> +<div class="block">ID of the property that denotes the document's title</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_TITLE">Constant Field Values</a></dd></dl> </li> </ul> @@ -570,7 +584,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_SUBJECT</h4> <pre>public static final int PID_SUBJECT</pre> -<div class="block"><p>ID of the property that denotes the document's subject</p></div> +<div class="block">ID of the property that denotes the document's subject</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_SUBJECT">Constant Field Values</a></dd></dl> </li> </ul> @@ -581,7 +595,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_AUTHOR</h4> <pre>public static final int PID_AUTHOR</pre> -<div class="block"><p>ID of the property that denotes the document's author</p></div> +<div class="block">ID of the property that denotes the document's author</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_AUTHOR">Constant Field Values</a></dd></dl> </li> </ul> @@ -592,7 +606,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_KEYWORDS</h4> <pre>public static final int PID_KEYWORDS</pre> -<div class="block"><p>ID of the property that denotes the document's keywords</p></div> +<div class="block">ID of the property that denotes the document's keywords</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_KEYWORDS">Constant Field Values</a></dd></dl> </li> </ul> @@ -603,7 +617,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_COMMENTS</h4> <pre>public static final int PID_COMMENTS</pre> -<div class="block"><p>ID of the property that denotes the document's comments</p></div> +<div class="block">ID of the property that denotes the document's comments</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_COMMENTS">Constant Field Values</a></dd></dl> </li> </ul> @@ -614,7 +628,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_TEMPLATE</h4> <pre>public static final int PID_TEMPLATE</pre> -<div class="block"><p>ID of the property that denotes the document's template</p></div> +<div class="block">ID of the property that denotes the document's template</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_TEMPLATE">Constant Field Values</a></dd></dl> </li> </ul> @@ -625,7 +639,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_LASTAUTHOR</h4> <pre>public static final int PID_LASTAUTHOR</pre> -<div class="block"><p>ID of the property that denotes the document's last author</p></div> +<div class="block">ID of the property that denotes the document's last author</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_LASTAUTHOR">Constant Field Values</a></dd></dl> </li> </ul> @@ -636,7 +650,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_REVNUMBER</h4> <pre>public static final int PID_REVNUMBER</pre> -<div class="block"><p>ID of the property that denotes the document's revision number</p></div> +<div class="block">ID of the property that denotes the document's revision number</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_REVNUMBER">Constant Field Values</a></dd></dl> </li> </ul> @@ -647,7 +661,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_EDITTIME</h4> <pre>public static final int PID_EDITTIME</pre> -<div class="block"><p>ID of the property that denotes the document's edit time</p></div> +<div class="block">ID of the property that denotes the document's edit time</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_EDITTIME">Constant Field Values</a></dd></dl> </li> </ul> @@ -658,8 +672,8 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_LASTPRINTED</h4> <pre>public static final int PID_LASTPRINTED</pre> -<div class="block"><p>ID of the property that denotes the date and time the document was - last printed</p></div> +<div class="block">ID of the property that denotes the date and time the document was + last printed</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_LASTPRINTED">Constant Field Values</a></dd></dl> </li> </ul> @@ -670,8 +684,8 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_CREATE_DTM</h4> <pre>public static final int PID_CREATE_DTM</pre> -<div class="block"><p>ID of the property that denotes the date and time the document was - created.</p></div> +<div class="block">ID of the property that denotes the date and time the document was + created.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_CREATE_DTM">Constant Field Values</a></dd></dl> </li> </ul> @@ -682,8 +696,8 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_LASTSAVE_DTM</h4> <pre>public static final int PID_LASTSAVE_DTM</pre> -<div class="block"><p>ID of the property that denotes the date and time the document was - saved</p></div> +<div class="block">ID of the property that denotes the date and time the document was + saved</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_LASTSAVE_DTM">Constant Field Values</a></dd></dl> </li> </ul> @@ -694,8 +708,8 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_PAGECOUNT</h4> <pre>public static final int PID_PAGECOUNT</pre> -<div class="block"><p>ID of the property that denotes the number of pages in the - document</p></div> +<div class="block">ID of the property that denotes the number of pages in the + document</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_PAGECOUNT">Constant Field Values</a></dd></dl> </li> </ul> @@ -706,8 +720,8 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_WORDCOUNT</h4> <pre>public static final int PID_WORDCOUNT</pre> -<div class="block"><p>ID of the property that denotes the number of words in the - document</p></div> +<div class="block">ID of the property that denotes the number of words in the + document</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_WORDCOUNT">Constant Field Values</a></dd></dl> </li> </ul> @@ -718,8 +732,8 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_CHARCOUNT</h4> <pre>public static final int PID_CHARCOUNT</pre> -<div class="block"><p>ID of the property that denotes the number of characters in the - document</p></div> +<div class="block">ID of the property that denotes the number of characters in the + document</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_CHARCOUNT">Constant Field Values</a></dd></dl> </li> </ul> @@ -730,7 +744,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_THUMBNAIL</h4> <pre>public static final int PID_THUMBNAIL</pre> -<div class="block"><p>ID of the property that denotes the document's thumbnail</p></div> +<div class="block">ID of the property that denotes the document's thumbnail</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_THUMBNAIL">Constant Field Values</a></dd></dl> </li> </ul> @@ -741,8 +755,8 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_APPNAME</h4> <pre>public static final int PID_APPNAME</pre> -<div class="block"><p>ID of the property that denotes the application that created the - document</p></div> +<div class="block">ID of the property that denotes the application that created the + document</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_APPNAME">Constant Field Values</a></dd></dl> </li> </ul> @@ -753,27 +767,27 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_SECURITY</h4> <pre>public static final int PID_SECURITY</pre> -<div class="block"><p>ID of the property that denotes whether read/write access to the +<div class="block">ID of the property that denotes whether read/write access to the document is allowed or whether is should be opened as read-only. It can - have the following values:</p> + have the following values: <table summary=""> <tbody> <tr> - <th><p>Value</p></th> - <th><p>Description</p></th> + <th>Value</th> + <th>Description</th> </tr> <tr> - <th><p>0</p></th> - <th><p>No restriction</p></th> + <th>0</th> + <th>No restriction</th> </tr> <tr> - <th><p>2</p></th> - <th><p>Read-only recommended</p></th> + <th>2</th> + <th>Read-only recommended</th> </tr> <tr> - <th><p>4</p></th> - <th><p>Read-only enforced</p></th> + <th>4</th> + <th>Read-only enforced</th> </tr> </tbody> </table></div> @@ -787,7 +801,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_DICTIONARY</h4> <pre>public static final int PID_DICTIONARY</pre> -<div class="block"><p>The entry is a dictionary.</p></div> +<div class="block">The entry is a dictionary.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_DICTIONARY">Constant Field Values</a></dd></dl> </li> </ul> @@ -798,7 +812,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_CODEPAGE</h4> <pre>public static final int PID_CODEPAGE</pre> -<div class="block"><p>The entry denotes a code page.</p></div> +<div class="block">The entry denotes a code page.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_CODEPAGE">Constant Field Values</a></dd></dl> </li> </ul> @@ -809,9 +823,9 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_CATEGORY</h4> <pre>public static final int PID_CATEGORY</pre> -<div class="block"><p>The entry is a string denoting the category the file belongs +<div class="block">The entry is a string denoting the category the file belongs to, e.g. review, memo, etc. This is useful to find documents of - same type.</p></div> + same type.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_CATEGORY">Constant Field Values</a></dd></dl> </li> </ul> @@ -822,8 +836,8 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_PRESFORMAT</h4> <pre>public static final int PID_PRESFORMAT</pre> -<div class="block"><p>Target format for power point presentation, e.g. 35mm, - printer, video etc.</p></div> +<div class="block">Target format for power point presentation, e.g. 35mm, + printer, video etc.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_PRESFORMAT">Constant Field Values</a></dd></dl> </li> </ul> @@ -834,7 +848,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_BYTECOUNT</h4> <pre>public static final int PID_BYTECOUNT</pre> -<div class="block"><p>Number of bytes.</p></div> +<div class="block">Number of bytes.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_BYTECOUNT">Constant Field Values</a></dd></dl> </li> </ul> @@ -845,7 +859,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_LINECOUNT</h4> <pre>public static final int PID_LINECOUNT</pre> -<div class="block"><p>Number of lines.</p></div> +<div class="block">Number of lines.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_LINECOUNT">Constant Field Values</a></dd></dl> </li> </ul> @@ -856,7 +870,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_PARCOUNT</h4> <pre>public static final int PID_PARCOUNT</pre> -<div class="block"><p>Number of paragraphs.</p></div> +<div class="block">Number of paragraphs.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_PARCOUNT">Constant Field Values</a></dd></dl> </li> </ul> @@ -867,7 +881,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_SLIDECOUNT</h4> <pre>public static final int PID_SLIDECOUNT</pre> -<div class="block"><p>Number of slides in a power point presentation.</p></div> +<div class="block">Number of slides in a power point presentation.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_SLIDECOUNT">Constant Field Values</a></dd></dl> </li> </ul> @@ -878,7 +892,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_NOTECOUNT</h4> <pre>public static final int PID_NOTECOUNT</pre> -<div class="block"><p>Number of slides with notes.</p></div> +<div class="block">Number of slides with notes.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_NOTECOUNT">Constant Field Values</a></dd></dl> </li> </ul> @@ -889,7 +903,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_HIDDENCOUNT</h4> <pre>public static final int PID_HIDDENCOUNT</pre> -<div class="block"><p>Number of hidden slides.</p></div> +<div class="block">Number of hidden slides.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_HIDDENCOUNT">Constant Field Values</a></dd></dl> </li> </ul> @@ -900,7 +914,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_MMCLIPCOUNT</h4> <pre>public static final int PID_MMCLIPCOUNT</pre> -<div class="block"><p>Number of multimedia clips, e.g. sound or video.</p></div> +<div class="block">Number of multimedia clips, e.g. sound or video.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_MMCLIPCOUNT">Constant Field Values</a></dd></dl> </li> </ul> @@ -911,8 +925,8 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_SCALE</h4> <pre>public static final int PID_SCALE</pre> -<div class="block"><p>This entry is set to -1 when scaling of the thumbnail is - desired. Otherwise the thumbnail should be cropped.</p></div> +<div class="block">This entry is set to -1 when scaling of the thumbnail is + desired. Otherwise the thumbnail should be cropped.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_SCALE">Constant Field Values</a></dd></dl> </li> </ul> @@ -923,11 +937,11 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_HEADINGPAIR</h4> <pre>public static final int PID_HEADINGPAIR</pre> -<div class="block"><p>This entry denotes an internally used property. It is a +<div class="block">This entry denotes an internally used property. It is a vector of variants consisting of pairs of a string (VT_LPSTR) and a number (VT_I4). The string is a heading name, and the number tells how many document parts are under that - heading.</p></div> + heading.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_HEADINGPAIR">Constant Field Values</a></dd></dl> </li> </ul> @@ -938,9 +952,9 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_DOCPARTS</h4> <pre>public static final int PID_DOCPARTS</pre> -<div class="block"><p>This entry contains the names of document parts (word: names +<div class="block">This entry contains the names of document parts (word: names of the documents in the master document, excel: sheet names, - power point: slide titles, binder: document names).</p></div> + power point: slide titles, binder: document names).</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_DOCPARTS">Constant Field Values</a></dd></dl> </li> </ul> @@ -951,7 +965,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_MANAGER</h4> <pre>public static final int PID_MANAGER</pre> -<div class="block"><p>This entry contains the name of the project manager.</p></div> +<div class="block">This entry contains the name of the project manager.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_MANAGER">Constant Field Values</a></dd></dl> </li> </ul> @@ -962,7 +976,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_COMPANY</h4> <pre>public static final int PID_COMPANY</pre> -<div class="block"><p>This entry contains the company name.</p></div> +<div class="block">This entry contains the company name.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_COMPANY">Constant Field Values</a></dd></dl> </li> </ul> @@ -973,8 +987,8 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_LINKSDIRTY</h4> <pre>public static final int PID_LINKSDIRTY</pre> -<div class="block"><p>If this entry is -1 the links are dirty and should be - re-evaluated.</p></div> +<div class="block">If this entry is -1 the links are dirty and should be + re-evaluated.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_LINKSDIRTY">Constant Field Values</a></dd></dl> </li> </ul> @@ -985,7 +999,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_CCHWITHSPACES</h4> <pre>public static final int PID_CCHWITHSPACES</pre> -<div class="block"><p>The entry specifies an estimate of the number of characters +<div class="block">The entry specifies an estimate of the number of characters in the document, including whitespace, as an integer</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_CCHWITHSPACES">Constant Field Values</a></dd></dl> </li> @@ -997,7 +1011,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_HYPERLINKSCHANGED</h4> <pre>public static final int PID_HYPERLINKSCHANGED</pre> -<div class="block"><p>This entry contains a boolean which marks if the User Defined +<div class="block">This entry contains a boolean which marks if the User Defined Property Set has been updated outside of the Application, if so the hyperlinks should be updated on document load.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_HYPERLINKSCHANGED">Constant Field Values</a></dd></dl> @@ -1010,7 +1024,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_VERSION</h4> <pre>public static final int PID_VERSION</pre> -<div class="block"><p>This entry contains the version of the Application which wrote the +<div class="block">This entry contains the version of the Application which wrote the Property set, stored with the two high order bytes having the major version number, and the two low order bytes the minor version number.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_VERSION">Constant Field Values</a></dd></dl> @@ -1023,7 +1037,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_DIGSIG</h4> <pre>public static final int PID_DIGSIG</pre> -<div class="block"><p>This entry contains the VBA digital signature for the VBA project +<div class="block">This entry contains the VBA digital signature for the VBA project embedded in the document.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_DIGSIG">Constant Field Values</a></dd></dl> </li> @@ -1035,7 +1049,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_CONTENTTYPE</h4> <pre>public static final int PID_CONTENTTYPE</pre> -<div class="block"><p>This entry contains a string of the content type of the file.</div> +<div class="block">This entry contains a string of the content type of the file.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_CONTENTTYPE">Constant Field Values</a></dd></dl> </li> </ul> @@ -1046,7 +1060,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_CONTENTSTATUS</h4> <pre>public static final int PID_CONTENTSTATUS</pre> -<div class="block"><p>This entry contains a string of the document status.</div> +<div class="block">This entry contains a string of the document status.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_CONTENTSTATUS">Constant Field Values</a></dd></dl> </li> </ul> @@ -1057,7 +1071,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_LANGUAGE</h4> <pre>public static final int PID_LANGUAGE</pre> -<div class="block"><p>This entry contains a string of the document language, but +<div class="block">This entry contains a string of the document language, but normally should be empty.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_LANGUAGE">Constant Field Values</a></dd></dl> </li> @@ -1069,7 +1083,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PID_DOCVERSION</h4> <pre>public static final int PID_DOCVERSION</pre> -<div class="block"><p>This entry contains a string of the document version, but +<div class="block">This entry contains a string of the document version, but normally should be empty</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_DOCVERSION">Constant Field Values</a></dd></dl> </li> @@ -1077,16 +1091,50 @@ extends java.util.HashMap<java.lang.L <a name="PID_MAX"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>PID_MAX</h4> <pre>public static final int PID_MAX</pre> -<div class="block"><p>The highest well-known property ID. Applications are free to use +<div class="block">The highest well-known property ID. Applications are free to use higher values for custom purposes. (This value is based on Office 12, - earlier versions of Office had lower values)</p></div> + earlier versions of Office had lower values)</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_MAX">Constant Field Values</a></dd></dl> </li> </ul> +<a name="PID_LOCALE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PID_LOCALE</h4> +<pre>public static final int PID_LOCALE</pre> +<div class="block">The Locale property, if present, MUST have the property identifier 0x80000000, + MUST NOT have a property name, and MUST have type VT_UI4 (0x0013). + If present, its value MUST be a valid language code identifier as specified in [MS-LCID]. + Its value is selected in an implementation-specific manner.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_LOCALE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PID_BEHAVIOUR"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PID_BEHAVIOUR</h4> +<pre>public static final int PID_BEHAVIOUR</pre> +<div class="block">The Behavior property, if present, MUST have the property identifier 0x80000003, + MUST NOT have a property name, and MUST have type VT_UI4 (0x0013). + A version 0 property set, indicated by the value 0x0000 for the Version field of + the PropertySetStream packet, MUST NOT have a Behavior property. + If the Behavior property is present, it MUST have one of the following values. + + <ul> + <li>0x00000000 = Property names are case-insensitive (default) + <li>0x00000001 = Property names are case-sensitive. + </ul></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.PropertyIDMap.PID_BEHAVIOUR">Constant Field Values</a></dd></dl> +</li> +</ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> @@ -1103,7 +1151,7 @@ extends java.util.HashMap<java.lang.L <h4>PropertyIDMap</h4> <pre>public PropertyIDMap(int initialCapacity, float loadFactor)</pre> -<div class="block"><p>Creates a <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a>.</p></div> +<div class="block">Creates a <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>initialCapacity</code> - The initial capacity as defined for <code>HashMap</code></dd><dd><code>loadFactor</code> - The load factor as defined for <code>HashMap</code></dd></dl> </li> @@ -1115,7 +1163,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>PropertyIDMap</h4> <pre>public PropertyIDMap(java.util.Map<java.lang.Long,java.lang.String> map)</pre> -<div class="block"><p>Creates a <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a> backed by another map.</p></div> +<div class="block">Creates a <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a> backed by another map.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - The instance to be created is backed by this map.</dd></dl> </li> </ul> @@ -1135,7 +1183,7 @@ extends java.util.HashMap<java.lang.L <h4>put</h4> <pre>public java.lang.Object put(long id, java.lang.String idString)</pre> -<div class="block"><p>Puts a ID string for an ID into the <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a>.</p></div> +<div class="block">Puts a ID string for an ID into the <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The ID.</dd><dd><code>idString</code> - The ID string.</dd> <dt><span class="strong">Returns:</span></dt><dd>As specified by the <code>Map</code> interface, this method returns the previous value associated with the specified @@ -1150,7 +1198,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>get</h4> <pre>public java.lang.Object get(long id)</pre> -<div class="block"><p>Gets the ID string for an ID from the <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a>.</p></div> +<div class="block">Gets the ID string for an ID from the <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The ID.</dd> <dt><span class="strong">Returns:</span></dt><dd>The ID string associated with <var>id</var>.</dd></dl> </li> @@ -1172,8 +1220,8 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>getDocumentSummaryInformationProperties</h4> <pre>public static <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a> getDocumentSummaryInformationProperties()</pre> -<div class="block"><p>Returns the Document Summary Information properties - singleton.</p></div> +<div class="block">Returns the Document Summary Information properties + singleton.</div> <dl><dt><span class="strong">Returns:</span></dt><dd>The Document Summary Information properties singleton.</dd></dl> </li> </ul> @@ -1184,7 +1232,7 @@ extends java.util.HashMap<java.lang.L <li class="blockList"> <h4>main</h4> <pre>public static void main(java.lang.String[] args)</pre> -<div class="block"><p>For the most basic testing.</p></div> +<div class="block">For the most basic testing.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - The command-line arguments</dd></dl> </li> </ul> Modified: poi/site/publish/apidocs/org/apache/poi/hpsf/wellknown/SectionIDMap.html URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/hpsf/wellknown/SectionIDMap.html?rev=1793603&r1=1793602&r2=1793603&view=diff ============================================================================== --- poi/site/publish/apidocs/org/apache/poi/hpsf/wellknown/SectionIDMap.html (original) +++ poi/site/publish/apidocs/org/apache/poi/hpsf/wellknown/SectionIDMap.html Tue May 2 23:37:06 2017 @@ -63,7 +63,7 @@ <div> <ul class="subNavList"> <li>Summary: </li> -<li><a href="#nested_classes_inherited_from_class_java.util.AbstractMap">Nested</a> | </li> +<li>Nested | </li> <li><a href="#field_summary">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> @@ -89,31 +89,18 @@ <li>java.lang.Object</li> <li> <ul class="inheritance"> -<li>java.util.AbstractMap<K,V></li> -<li> -<ul class="inheritance"> -<li>java.util.HashMap</li> -<li> -<ul class="inheritance"> <li>org.apache.poi.hpsf.wellknown.SectionIDMap</li> </ul> </li> </ul> -</li> -</ul> -</li> -</ul> <div class="description"> <ul class="blockList"> <li class="blockList"> -<dl> -<dt>All Implemented Interfaces:</dt> -<dd>java.io.Serializable, java.lang.Cloneable, java.util.Map</dd> -</dl> <hr> <br> -<pre>public class <span class="strong">SectionIDMap</span> -extends java.util.HashMap</pre> +<pre><a href="../../../../../org/apache/poi/util/Internal.html" title="annotation in org.apache.poi.util">@Internal</a> +public class <span class="strong">SectionIDMap</span> +extends java.lang.Object</pre> <div class="block"><p>Maps section format IDs to <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a>s. It is initialized with two well-known section format IDs: those of the <tt>\005SummaryInformation</tt> stream and the @@ -127,28 +114,12 @@ extends java.util.HashMap</pre> <p>This <code>Map</code> expects the byte arrays of section format IDs as keys. A key maps to a <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a> describing the property IDs in sections with the specified section format ID.</p></div> -<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.poi.hpsf.wellknown.SectionIDMap">Serialized Form</a></dd></dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> -<!-- ======== NESTED CLASS SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="nested_class_summary"> -<!-- --> -</a> -<h3>Nested Class Summary</h3> -<ul class="blockList"> -<li class="blockList"><a name="nested_classes_inherited_from_class_java.util.AbstractMap"> -<!-- --> -</a> -<h3>Nested classes/interfaces inherited from class java.util.AbstractMap</h3> -<code>java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V></code></li> -</ul> -</li> -</ul> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field_summary"> @@ -162,14 +133,11 @@ extends java.util.HashMap</pre> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> -<td class="colFirst"><code>static byte[][]</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#DOCUMENT_SUMMARY_INFORMATION_ID">DOCUMENT_SUMMARY_INFORMATION_ID</a></strong></code> -<div class="block">The DocumentSummaryInformation's first and second sections' format - ID.</div> -</td> +<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#DOCUMENT_SUMMARY_INFORMATION_ID">DOCUMENT_SUMMARY_INFORMATION_ID</a></strong></code> </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code>static byte[]</code></td> +<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#SUMMARY_INFORMATION_ID">SUMMARY_INFORMATION_ID</a></strong></code> <div class="block">The SummaryInformation's section's format ID.</div> </td> @@ -214,7 +182,7 @@ extends java.util.HashMap</pre> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#get(byte[])">get</a></strong>(byte[] sectionFormatID)</code> +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#get(org.apache.poi.hpsf.ClassID)">get</a></strong>(<a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> sectionFormatID)</code> <div class="block">Returns the <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a> for a given section format ID.</div> </td> @@ -227,7 +195,7 @@ extends java.util.HashMap</pre> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.lang.String</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#getPIDString(byte[],%20long)">getPIDString</a></strong>(byte[] sectionFormatID, +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#getPIDString(org.apache.poi.hpsf.ClassID,%20long)">getPIDString</a></strong>(<a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> sectionFormatID, long pid)</code> <div class="block">Returns the property ID string that is associated with a given property ID in a section format ID's namespace.</div> @@ -235,7 +203,7 @@ extends java.util.HashMap</pre> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#put(byte[],%20org.apache.poi.hpsf.wellknown.PropertyIDMap)">put</a></strong>(byte[] sectionFormatID, +<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#put(org.apache.poi.hpsf.ClassID,%20org.apache.poi.hpsf.wellknown.PropertyIDMap)">put</a></strong>(<a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> sectionFormatID, <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a> propertyIDMap)</code> <div class="block">Associates a section format ID with a <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a>.</div> </td> @@ -244,38 +212,16 @@ extends java.util.HashMap</pre> <td class="colFirst"><code>protected <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hpsf/wellknown/SectionIDMap.html#put(java.lang.String,%20org.apache.poi.hpsf.wellknown.PropertyIDMap)">put</a></strong>(java.lang.String key, <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a> value)</code> -<div class="block">Associates the string representation of a section - format ID with a <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a></div> +<div class="block">Associates the string representation of a section format ID with a <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a></div> </td> </tr> </table> <ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.util.HashMap"> -<!-- --> -</a> -<h3>Methods inherited from class java.util.HashMap</h3> -<code>clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values</code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.util.AbstractMap"> -<!-- --> -</a> -<h3>Methods inherited from class java.util.AbstractMap</h3> -<code>equals, hashCode, toString</code></li> -</ul> -<ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> -<code>finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.util.Map"> -<!-- --> -</a> -<h3>Methods inherited from interface java.util.Map</h3> -<code>equals, hashCode</code></li> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> @@ -297,7 +243,7 @@ extends java.util.HashMap</pre> <ul class="blockList"> <li class="blockList"> <h4>SUMMARY_INFORMATION_ID</h4> -<pre>public static final byte[] SUMMARY_INFORMATION_ID</pre> +<pre>public static final <a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> SUMMARY_INFORMATION_ID</pre> <div class="block"><p>The SummaryInformation's section's format ID.</p></div> </li> </ul> @@ -307,9 +253,7 @@ extends java.util.HashMap</pre> <ul class="blockList"> <li class="blockList"> <h4>DOCUMENT_SUMMARY_INFORMATION_ID</h4> -<pre>public static final byte[][] DOCUMENT_SUMMARY_INFORMATION_ID</pre> -<div class="block"><p>The DocumentSummaryInformation's first and second sections' format - ID.</p></div> +<pre>public static final <a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a>[] DOCUMENT_SUMMARY_INFORMATION_ID</pre> </li> </ul> <a name="UNDEFINED"> @@ -319,7 +263,7 @@ extends java.util.HashMap</pre> <li class="blockList"> <h4>UNDEFINED</h4> <pre>public static final java.lang.String UNDEFINED</pre> -<div class="block"><p>A property without a known name is described by this string.</p></div> +<div class="block">A property without a known name is described by this string.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.hpsf.wellknown.SectionIDMap.UNDEFINED">Constant Field Values</a></dd></dl> </li> </ul> @@ -359,13 +303,13 @@ extends java.util.HashMap</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>The instance value</dd></dl> </li> </ul> -<a name="getPIDString(byte[], long)"> +<a name="getPIDString(org.apache.poi.hpsf.ClassID, long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getPIDString</h4> -<pre>public static java.lang.String getPIDString(byte[] sectionFormatID, +<pre>public static java.lang.String getPIDString(<a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> sectionFormatID, long pid)</pre> <div class="block"><p>Returns the property ID string that is associated with a given property ID in a section format ID's namespace.</p></div> @@ -378,28 +322,28 @@ extends java.util.HashMap</pre> string "[undefined]" is returned.</dd></dl> </li> </ul> -<a name="get(byte[])"> +<a name="get(org.apache.poi.hpsf.ClassID)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>get</h4> -<pre>public <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a> get(byte[] sectionFormatID)</pre> +<pre>public <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a> get(<a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> sectionFormatID)</pre> <div class="block"><p>Returns the <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a> for a given section format ID.</p></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sectionFormatID</code> - the section format ID</dd> <dt><span class="strong">Returns:</span></dt><dd>the property ID map</dd></dl> </li> </ul> -<a name="put(byte[], org.apache.poi.hpsf.wellknown.PropertyIDMap)"> +<a name="put(org.apache.poi.hpsf.ClassID, org.apache.poi.hpsf.wellknown.PropertyIDMap)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>put</h4> -<pre>public <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a> put(byte[] sectionFormatID, +<pre>public <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a> put(<a href="../../../../../org/apache/poi/hpsf/ClassID.html" title="class in org.apache.poi.hpsf">ClassID</a> sectionFormatID, <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a> propertyIDMap)</pre> -<div class="block"><p>Associates a section format ID with a <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a>.</p></div> +<div class="block">Associates a section format ID with a <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a>.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sectionFormatID</code> - the section format ID</dd><dd><code>propertyIDMap</code> - the property ID map</dd> <dt><span class="strong">Returns:</span></dt><dd>as defined by <code>Map.put(K, V)</code></dd></dl> </li> @@ -412,8 +356,7 @@ extends java.util.HashMap</pre> <h4>put</h4> <pre>protected <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a> put(java.lang.String key, <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown">PropertyIDMap</a> value)</pre> -<div class="block">Associates the string representation of a section - format ID with a <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a></div> +<div class="block">Associates the string representation of a section format ID with a <a href="../../../../../org/apache/poi/hpsf/wellknown/PropertyIDMap.html" title="class in org.apache.poi.hpsf.wellknown"><code>PropertyIDMap</code></a></div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key of the PropertyIDMap</dd><dd><code>value</code> - the PropertyIDMap itself</dd> <dt><span class="strong">Returns:</span></dt><dd>the previous PropertyIDMap stored under this key, or <code>null</code> if there wasn't one</dd></dl> </li> @@ -469,7 +412,7 @@ extends java.util.HashMap</pre> <div> <ul class="subNavList"> <li>Summary: </li> -<li><a href="#nested_classes_inherited_from_class_java.util.AbstractMap">Nested</a> | </li> +<li>Nested | </li> <li><a href="#field_summary">Field</a> | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
