|
| |
|
| java.lang.Object
 org.apache.poi.hpsf.PropertySet
org.apache.poi.hpsf.MutablePropertySet
org.apache.poi.hpsf.SpecialPropertySet
org.apache.poi.hpsf.SummaryInformation
| SummaryInformation | | public class SummaryInformation extends SpecialPropertySet (Code) | | Convenience class representing a Summary Information stream in a
Microsoft Office document.
author:
Rainer Klute author:
href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de>
See Also: DocumentSummaryInformation
version:
$Id: SummaryInformation.java 496419 2007-01-15 17:56:52Z klute $
since:
2002-02-09 |
| DEFAULT_STREAM_NAME | | final public static String DEFAULT_STREAM_NAME(Code) | | The document name a summary information stream usually has in a POIFS
filesystem.
|
| getApplicationName | | public String getApplicationName()(Code) | | Returns the application name (or null).
The application name or null |
| getAuthor | | public String getAuthor()(Code) | | Returns the author (or null).
The author or null |
| getCharCount | | public int getCharCount()(Code) | | Returns the character count or 0 if the
SummaryInformation does not contain a char count.
The character count or null |
| getComments | | public String getComments()(Code) | | Returns the comments (or null).
The comments or null |
| getCreateDateTime | | public Date getCreateDateTime()(Code) | | Returns the creation time (or null).
The creation time or null |
| getEditTime | | public long getEditTime()(Code) | | Returns the total time spent in editing the document (or
0).
The total time spent in editing the document or 0 if the SummaryInformation does not contain this information. |
| getKeywords | | public String getKeywords()(Code) | | Returns the keywords (or null).
The keywords or null |
| getLastAuthor | | public String getLastAuthor()(Code) | | Returns the last author (or null).
The last author or null |
| getLastPrinted | | public Date getLastPrinted()(Code) | | Returns the last printed time (or null).
The last printed time or null |
| getLastSaveDateTime | | public Date getLastSaveDateTime()(Code) | | Returns the last save time (or null).
The last save time or null |
| getRevNumber | | public String getRevNumber()(Code) | | Returns the revision number (or null).
The revision number or null |
| getSecurity | | public int getSecurity()(Code) | | Returns a security code which is one of the following values:
0 if the
SummaryInformation does not contain a
security field or if there is no security on the document. Use
PropertySet.wasNull to distinguish between the two
cases! 1 if the document is password protected 2 if the document is read-only recommended 4 if the document is read-only enforced 8 if the document is locked for annotations
The security code or null |
| getSubject | | public String getSubject()(Code) | | Returns the subject (or null).
The subject or null |
| getTemplate | | public String getTemplate()(Code) | | Returns the template (or null).
The template or null |
| getThumbnail | | public byte[] getThumbnail()(Code) | | Returns the thumbnail (or null) when this
method is implemented. Please note that the return type is likely to
change!
Hint to developers: Drew Varner <Drew.Varner
-at- sc.edu> said that this is an image in WMF or Clipboard (BMP?)
format. However, we won't do any conversion into any image type but
instead just return a byte array.
The thumbnail or null |
| getTitle | | public String getTitle()(Code) | | Returns the title (or null).
The title or null |
| getWordCount | | public int getWordCount()(Code) | | Returns the word count or 0 if the
SummaryInformation does
not contain a word count.
The word count or null |
| removeApplicationName | | public void removeApplicationName()(Code) | | Removes the application name.
|
| removeAuthor | | public void removeAuthor()(Code) | | Removes the author.
|
| removeCharCount | | public void removeCharCount()(Code) | | Removes the character count.
|
| removeComments | | public void removeComments()(Code) | | Removes the comments.
|
| removeCreateDateTime | | public void removeCreateDateTime()(Code) | | Removes the creation time.
|
| removeEditTime | | public void removeEditTime()(Code) | | Remove the total time spent in editing the document.
|
| removeKeywords | | public void removeKeywords()(Code) | | Removes the keywords.
|
| removeLastAuthor | | public void removeLastAuthor()(Code) | | Removes the last author.
|
| removeLastPrinted | | public void removeLastPrinted()(Code) | | Removes the lastPrinted.
|
| removeLastSaveDateTime | | public void removeLastSaveDateTime()(Code) | | Remove the total time spent in editing the document.
|
| removePageCount | | public void removePageCount()(Code) | | Removes the page count.
|
| removeRevNumber | | public void removeRevNumber()(Code) | | Removes the revision number.
|
| removeSecurity | | public void removeSecurity()(Code) | | Removes the security code.
|
| removeSubject | | public void removeSubject()(Code) | | Removes the subject.
|
| removeTemplate | | public void removeTemplate()(Code) | | Removes the template.
|
| removeThumbnail | | public void removeThumbnail()(Code) | | Removes the thumbnail.
|
| removeTitle | | public void removeTitle()(Code) | | Removes the title.
|
| removeWordCount | | public void removeWordCount()(Code) | | Removes the word count.
|
| setApplicationName | | public void setApplicationName(String applicationName)(Code) | | Sets the application name.
Parameters:
applicationName - The application name to set. |
| setAuthor | | public void setAuthor(String author)(Code) | | Sets the author.
Parameters:
author - The author to set. |
| setCharCount | | public void setCharCount(int charCount)(Code) | | Sets the character count.
Parameters:
charCount - The character count to set. |
| setComments | | public void setComments(String comments)(Code) | | Sets the comments.
Parameters:
comments - The comments to set. |
| setCreateDateTime | | public void setCreateDateTime(Date createDateTime)(Code) | | Sets the creation time.
Parameters:
createDateTime - The creation time to set. |
| setEditTime | | public void setEditTime(long time)(Code) | | Sets the total time spent in editing the document.
Parameters:
time - The time to set. |
| setKeywords | | public void setKeywords(String keywords)(Code) | | Sets the keywords.
Parameters:
keywords - The keywords to set. |
| setLastAuthor | | public void setLastAuthor(String lastAuthor)(Code) | | Sets the last author.
Parameters:
lastAuthor - The last author to set. |
| setLastPrinted | | public void setLastPrinted(Date lastPrinted)(Code) | | Sets the lastPrinted.
Parameters:
lastPrinted - The lastPrinted to set. |
| setLastSaveDateTime | | public void setLastSaveDateTime(Date time)(Code) | | Sets the total time spent in editing the document.
Parameters:
time - The time to set. |
| setPageCount | | public void setPageCount(int pageCount)(Code) | | Sets the page count.
Parameters:
pageCount - The page count to set. |
| setRevNumber | | public void setRevNumber(String revNumber)(Code) | | Sets the revision number.
Parameters:
revNumber - The revision number to set. |
| setSecurity | | public void setSecurity(int security)(Code) | | Sets the security code.
Parameters:
security - The security code to set. |
| setSubject | | public void setSubject(String subject)(Code) | | Sets the subject.
Parameters:
subject - The subject to set. |
| setTemplate | | public void setTemplate(String template)(Code) | | Sets the template.
Parameters:
template - The template to set. |
| setThumbnail | | public void setThumbnail(byte[] thumbnail)(Code) | | Sets the thumbnail.
Parameters:
thumbnail - The thumbnail to set. |
| setTitle | | public void setTitle(String title)(Code) | | Sets the title.
Parameters:
title - The title to set. |
| setWordCount | | public void setWordCount(int wordCount)(Code) | | Sets the word count.
Parameters:
wordCount - The word count to set. |
|
|
|