|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.poi.hpsf.PropertySet | +--org.apache.poi.hpsf.SpecialPropertySet | +--org.apache.poi.hpsf.DocumentSummaryInformation
Convenience class representing a DocumentSummary Information stream in a Microsoft Office document.
SummaryInformation
Constructor Summary | |
DocumentSummaryInformation(PropertySet ps)
Creates a DocumentSummaryInformation from a given PropertySet . |
Method Summary | |
int |
getByteCount()
Returns the stream's byte count or 0 if the DocumentSummaryInformation does not contain a byte count. |
java.lang.String |
getCategory()
Returns the stream's category (or null ). |
java.lang.String |
getCompany()
Returns the stream's company (or null ). |
byte[] |
getDocparts()
Returns the stream's doc parts (or null ) when this
method is implemented. |
byte[] |
getHeadingPair()
Returns the stream's heading pair (or null ) when
this method is implemented. |
int |
getHiddenCount()
Returns the stream's hidden count or 0 if the DocumentSummaryInformation does not contain a hidden count. |
int |
getLineCount()
Returns the stream's line count or 0 if the DocumentSummaryInformation does not contain a line count. |
boolean |
getLinksDirty()
Returns true if the custom links are hampered by excessive
noise, for all applications. |
java.lang.String |
getManager()
Returns the stream's manager (or null ). |
int |
getMMClipCount()
Returns the stream's mmclip count or 0 if the DocumentSummaryInformation does not contain a mmclip count. |
int |
getNoteCount()
Returns the stream's note count or 0 if the DocumentSummaryInformation does not contain a note count. |
int |
getParCount()
Returns the stream's par count or 0 if the DocumentSummaryInformation does not contain a par count. |
java.lang.String |
getPresentationFormat()
Returns the stream's presentation format (or null ). |
boolean |
getScale()
Returns true when scaling of the thumbnail is desired,
false if cropping is desired. |
int |
getSlideCount()
Returns the stream's slide count or 0 if the DocumentSummaryInformation does not contain a slide count. |
Methods inherited from class org.apache.poi.hpsf.SpecialPropertySet |
getByteOrder, getClassID, getFormat, getOSVersion, getSectionCount, getSections, getSingleSection, isDocumentSummaryInformation, isSummaryInformation |
Methods inherited from class org.apache.poi.hpsf.PropertySet |
getProperties, getProperty, getPropertyBooleanValue, getPropertyIntValue, isPropertySetStream, isPropertySetStream, wasNull |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DocumentSummaryInformation(PropertySet ps) throws UnexpectedPropertySetTypeException
Creates a DocumentSummaryInformation
from a given PropertySet
.
ps
- A property set which
should be created from a document summary information stream.
UnexpectedPropertySetTypeException
- Description of the
ExceptionMethod Detail |
public java.lang.String getCategory()
Returns the stream's category (or null
).
public java.lang.String getPresentationFormat()
Returns the stream's presentation format (or null
).
public int getByteCount()
Returns the stream's byte count or 0 if the DocumentSummaryInformation
does not contain a byte count.
public int getLineCount()
Returns the stream's line count or 0 if the DocumentSummaryInformation
does not contain a line count.
public int getParCount()
Returns the stream's par count or 0 if the DocumentSummaryInformation
does not contain a par count.
public int getSlideCount()
Returns the stream's slide count or 0 if the DocumentSummaryInformation
does not contain a slide count.
public int getNoteCount()
Returns the stream's note count or 0 if the DocumentSummaryInformation
does not contain a note count.
public int getHiddenCount()
Returns the stream's hidden count or 0 if the DocumentSummaryInformation
does not contain a hidden count.
public int getMMClipCount()
Returns the stream's mmclip count or 0 if the DocumentSummaryInformation
does not contain a mmclip count.
public boolean getScale()
Returns true
when scaling of the thumbnail is desired,
false
if cropping is desired.
public byte[] getHeadingPair()
Returns the stream's heading pair (or null
) when
this method is implemented. Please note that the return type is likely
to change!
public byte[] getDocparts()
Returns the stream's doc parts (or null
) when this
method is implemented. Please note that the return type is likely to
change!
public java.lang.String getManager()
Returns the stream's manager (or null
).
public java.lang.String getCompany()
Returns the stream's company (or null
).
public boolean getLinksDirty()
Returns true
if the custom links are hampered by excessive
noise, for all applications.
FIXME: Explain this some more! I (Rainer) don't understand it.
|
jakarta-poi 1.8.0-dev | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |