public class DocumentSummaryInformation extends SpecialPropertySet
Convenience class representing a DocumentSummary Information stream in a Microsoft Office document.
SummaryInformation
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_STREAM_NAME
The document name a document summary information stream
usually has in a POIFS filesystem.
|
byteOrder, classID, format, OS_MACINTOSH, OS_WIN16, OS_WIN32, osVersion, sections
Constructor and Description |
---|
DocumentSummaryInformation(PropertySet ps)
Creates a
DocumentSummaryInformation from a given
PropertySet . |
Modifier and Type | Method and Description |
---|---|
int |
getByteCount()
Returns the byte count or 0 if the
DocumentSummaryInformation does not contain a byte count. |
java.lang.String |
getCategory()
Returns the category (or
null ). |
java.lang.String |
getCompany()
Returns the company (or
null ). |
CustomProperties |
getCustomProperties()
Gets the custom properties.
|
byte[] |
getDocparts()
Returns the doc parts (or
null )
when this method is implemented. |
byte[] |
getHeadingPair()
Returns the heading pair (or
null )
when this method is implemented. |
int |
getHiddenCount()
Returns the hidden count or 0 if the
DocumentSummaryInformation does not contain a hidden
count. |
int |
getLineCount()
Returns the line count or 0 if the
DocumentSummaryInformation does not contain a line count. |
boolean |
getLinksDirty()
Returns
true if the custom links are dirty. |
java.lang.String |
getManager()
Returns the manager (or
null ). |
int |
getMMClipCount()
Returns the mmclip count or 0 if the
DocumentSummaryInformation does not contain a mmclip
count. |
int |
getNoteCount()
Returns the note count or 0 if the
DocumentSummaryInformation does not contain a note count. |
int |
getParCount()
Returns the par count or 0 if the
DocumentSummaryInformation does not contain a par count. |
java.lang.String |
getPresentationFormat()
Returns the presentation format (or
null ). |
PropertyIDMap |
getPropertySetIDMap()
The id to name mapping of the properties
in this set.
|
boolean |
getScale()
Returns
true when scaling of the thumbnail is
desired, false if cropping is desired. |
int |
getSlideCount()
Returns the slide count or 0 if the
DocumentSummaryInformation does not contain a slide count. |
void |
removeByteCount()
Removes the byte count.
|
void |
removeCategory()
Removes the category.
|
void |
removeCompany()
Removes the company.
|
void |
removeCustomProperties()
Removes the custom properties.
|
void |
removeDocparts()
Removes the doc parts.
|
void |
removeHeadingPair()
Removes the heading pair.
|
void |
removeHiddenCount()
Removes the hidden count.
|
void |
removeLineCount()
Removes the line count.
|
void |
removeLinksDirty()
Removes the links dirty.
|
void |
removeManager()
Removes the manager.
|
void |
removeMMClipCount()
Removes the mmclip count.
|
void |
removeNoteCount()
Removes the noteCount.
|
void |
removeParCount()
Removes the par count.
|
void |
removePresentationFormat()
Removes the presentation format.
|
void |
removeScale()
Removes the scale.
|
void |
removeSlideCount()
Removes the slide count.
|
void |
setByteCount(int byteCount)
Sets the byte count.
|
void |
setCategory(java.lang.String category)
Sets the category.
|
void |
setCompany(java.lang.String company)
Sets the company.
|
void |
setCustomProperties(CustomProperties customProperties)
Sets the custom properties.
|
void |
setDocparts(byte[] docparts)
Sets the doc parts.
|
void |
setHeadingPair(byte[] headingPair)
Sets the heading pair.
|
void |
setHiddenCount(int hiddenCount)
Sets the hidden count.
|
void |
setLineCount(int lineCount)
Sets the line count.
|
void |
setLinksDirty(boolean linksDirty)
Sets the linksDirty.
|
void |
setManager(java.lang.String manager)
Sets the manager.
|
void |
setMMClipCount(int mmClipCount)
Sets the mmclip count.
|
void |
setNoteCount(int noteCount)
Sets the note count.
|
void |
setParCount(int parCount)
Sets the par count.
|
void |
setPresentationFormat(java.lang.String presentationFormat)
Sets the presentation format.
|
void |
setScale(boolean scale)
Sets the scale.
|
void |
setSlideCount(int slideCount)
Sets the slideCount.
|
addSection, clearSections, equals, getByteOrder, getClassID, getFirstSection, getFormat, getOSVersion, getProperties, getProperty, getPropertyBooleanValue, getPropertyIntValue, getSectionCount, getSections, hashCode, isDocumentSummaryInformation, isSummaryInformation, setByteOrder, setClassID, setFormat, setOSVersion, toInputStream, toString, wasNull, write, write
getSingleSection, isPropertySetStream, isPropertySetStream
public static final java.lang.String DEFAULT_STREAM_NAME
The document name a document summary information stream usually has in a POIFS filesystem.
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
- if ps
does not contain a document summary information stream.public PropertyIDMap getPropertySetIDMap()
SpecialPropertySet
getPropertySetIDMap
in class SpecialPropertySet
public java.lang.String getCategory()
Returns the category (or null
).
public void setCategory(java.lang.String category)
Sets the category.
category
- The category to set.public void removeCategory()
Removes the category.
public java.lang.String getPresentationFormat()
Returns the presentation format (or
null
).
public void setPresentationFormat(java.lang.String presentationFormat)
Sets the presentation format.
presentationFormat
- The presentation format to set.public void removePresentationFormat()
Removes the presentation format.
public int getByteCount()
Returns the byte count or 0 if the DocumentSummaryInformation
does not contain a byte count.
public void setByteCount(int byteCount)
Sets the byte count.
byteCount
- The byte count to set.public void removeByteCount()
Removes the byte count.
public int getLineCount()
Returns the line count or 0 if the DocumentSummaryInformation
does not contain a line count.
public void setLineCount(int lineCount)
Sets the line count.
lineCount
- The line count to set.public void removeLineCount()
Removes the line count.
public int getParCount()
Returns the par count or 0 if the DocumentSummaryInformation
does not contain a par count.
public void setParCount(int parCount)
Sets the par count.
parCount
- The par count to set.public void removeParCount()
Removes the par count.
public int getSlideCount()
Returns the slide count or 0 if the DocumentSummaryInformation
does not contain a slide count.
public void setSlideCount(int slideCount)
Sets the slideCount.
slideCount
- The slide count to set.public void removeSlideCount()
Removes the slide count.
public int getNoteCount()
Returns the note count or 0 if the DocumentSummaryInformation
does not contain a note count.
public void setNoteCount(int noteCount)
Sets the note count.
noteCount
- The note count to set.public void removeNoteCount()
Removes the noteCount.
public int getHiddenCount()
Returns the hidden count or 0 if the DocumentSummaryInformation
does not contain a hidden
count.
public void setHiddenCount(int hiddenCount)
Sets the hidden count.
hiddenCount
- The hidden count to set.public void removeHiddenCount()
Removes the hidden count.
public int getMMClipCount()
Returns the mmclip count or 0 if the DocumentSummaryInformation
does not contain a mmclip
count.
public void setMMClipCount(int mmClipCount)
Sets the mmclip count.
mmClipCount
- The mmclip count to set.public void removeMMClipCount()
Removes the mmclip count.
public boolean getScale()
Returns true
when scaling of the thumbnail is
desired, false
if cropping is desired.
public void setScale(boolean scale)
Sets the scale.
scale
- The scale to set.public void removeScale()
Removes the scale.
public byte[] getHeadingPair()
Returns the heading pair (or null
)
when this method is implemented. Please note that the
return type is likely to change!
public void setHeadingPair(byte[] headingPair)
Sets the heading pair.
headingPair
- The heading pair to set.public void removeHeadingPair()
Removes the heading pair.
public byte[] getDocparts()
Returns the doc parts (or null
)
when this method is implemented. Please note that the
return type is likely to change!
public void setDocparts(byte[] docparts)
Sets the doc parts.
docparts
- The doc parts to set.public void removeDocparts()
Removes the doc parts.
public java.lang.String getManager()
Returns the manager (or null
).
public void setManager(java.lang.String manager)
Sets the manager.
manager
- The manager to set.public void removeManager()
Removes the manager.
public java.lang.String getCompany()
Returns the company (or null
).
public void setCompany(java.lang.String company)
Sets the company.
company
- The company to set.public void removeCompany()
Removes the company.
public boolean getLinksDirty()
Returns true
if the custom links are dirty.
public void setLinksDirty(boolean linksDirty)
Sets the linksDirty.
linksDirty
- The links dirty value to set.public void removeLinksDirty()
Removes the links dirty.
public CustomProperties getCustomProperties()
Gets the custom properties.
public void setCustomProperties(CustomProperties customProperties)
Sets the custom properties.
customProperties
- The custom propertiespublic void removeCustomProperties()
Removes the custom properties.
Copyright © 2005-2010 Potix Corporation. All Rights Reserved.