|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.document.SummaryInfo
public class SummaryInfo
This object enables you to get and set summary information for the report. This information includes: the author of the document, the document's subject, the document title, any comments the author of the report has added, keywords that describe the report, and whether or not a thumbnail image of the report is saved.
Example:
This sample shows how to update the summary information of a report. Summary information of a report can contain the author's name, comments, keywords, subject, title, and whether a preview image is saved.
ISummaryInfo summaryInfo = clientDoc.getReportDocument().getSummaryInfo();
ISummaryInfo newSummaryInfo = summaryInfo.clone(true);
newSummaryInfo.setAuthor( "Leo Tolstoy" );
clientDoc.modifySummaryInfo( newSummaryInfo );
Constructor Summary | |
---|---|
SummaryInfo()
|
|
SummaryInfo(ISummaryInfo src)
|
Method Summary | |
---|---|
java.lang.Object |
clone(boolean deepClone)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
|
java.lang.Object |
createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
For internal use only. |
void |
doControllerModification(java.lang.Object newObject)
|
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
void |
enumerateMembers(IMemberVisitor visitor)
|
java.lang.String |
getAuthor()
Returns the author's name. |
java.lang.String |
getComments()
Returns any comments the author of the report has added. |
ControllableMixin |
getControllableMixin()
|
boolean |
getIsSavingWithPreview()
Returns whether or not a thumbnail image of the report is to be saved. |
java.lang.String |
getKeywords()
Returns keywords that have been assigned to describe the report. |
java.lang.String |
getSubject()
Returns the subject that has been assigned to the report. |
java.lang.String |
getTitle()
Returns the title of the report. |
boolean |
hasContent(java.lang.Object srcSummaryInfo)
|
boolean |
isDirectlyControllable()
|
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only. |
void |
save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
For internal use only. |
void |
save(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
setAuthor(java.lang.String author)
Sets the author's name. |
void |
setComments(java.lang.String comments)
Sets comments for the report. |
void |
setIsSavingWithPreview(boolean isSavingWithPreview)
Set whether or not a thumbnail image of the report is to be saved. |
void |
setKeywords(java.lang.String keywords)
Sets keywords to describe the report. |
void |
setSubject(java.lang.String subject)
Sets the subject for the report. |
void |
setTitle(java.lang.String title)
Sets the title of the report. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SummaryInfo(ISummaryInfo src)
public SummaryInfo()
Method Detail |
---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject, boolean deepCopy)
public java.lang.Object createMember(java.lang.String eleName, org.xml.sax.Attributes attrs, XMLSerializationContext ctxt, java.util.Map objState, boolean[] bLoaded)
For internal use only.
public void endElement(java.lang.String eleName, java.util.Map objState)
For internal use only.
public java.lang.String getAuthor()
ISummaryInfo
Returns the author's name.
getAuthor
in interface ISummaryInfo
String
.public java.lang.String getComments()
ISummaryInfo
Returns any comments the author of the report has added.
getComments
in interface ISummaryInfo
String
.public boolean getIsSavingWithPreview()
ISummaryInfo
Returns whether or not a thumbnail image of the report is to be saved.
getIsSavingWithPreview
in interface ISummaryInfo
true
if a preview is saved, and false
otherwise.public java.lang.String getKeywords()
ISummaryInfo
Returns keywords that have been assigned to describe the report.
getKeywords
in interface ISummaryInfo
String
.public java.lang.String getSubject()
ISummaryInfo
Returns the subject that has been assigned to the report.
getSubject
in interface ISummaryInfo
String
.public java.lang.String getTitle()
ISummaryInfo
Returns the title of the report. This is not the same as the report's file name.
getTitle
in interface ISummaryInfo
String
.public boolean hasContent(java.lang.Object srcSummaryInfo)
public void readElement(java.lang.String eleName, java.lang.String sVal, org.xml.sax.Attributes attrs, java.util.Map objState)
For internal use only.
public void save(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void save(XMLWriter writer, java.lang.String sTag, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void saveContents(XMLWriter writer, XMLSerializationContext ctxt) throws java.io.IOException
For internal use only.
java.io.IOException
public void setAuthor(java.lang.String author)
ISummaryInfo
Sets the author's name.
setAuthor
in interface ISummaryInfo
author
- The author's name as a String
.public void setComments(java.lang.String comments)
ISummaryInfo
Sets comments for the report.
setComments
in interface ISummaryInfo
comments
- The comments as a String
.public void setIsSavingWithPreview(boolean isSavingWithPreview)
ISummaryInfo
Set whether or not a thumbnail image of the report is to be saved.
setIsSavingWithPreview
in interface ISummaryInfo
isSavingWithPreview
- true
if a preview is saved, and false
otherwise.public void setKeywords(java.lang.String keywords)
ISummaryInfo
Sets keywords to describe the report.
setKeywords
in interface ISummaryInfo
keywords
- The keywords as a String
.public void setSubject(java.lang.String subject)
ISummaryInfo
Sets the subject for the report.
setSubject
in interface ISummaryInfo
subject
- The subject as a String
.public void setTitle(java.lang.String title)
ISummaryInfo
Sets the title of the report. This is not the same as the report's file name.
setTitle
in interface ISummaryInfo
title
- The title as a String
.public void startElement(java.lang.String eleName, java.util.Map objState, org.xml.sax.Attributes attrs)
For internal use only.
public ControllableMixin getControllableMixin()
public void doControllerModification(java.lang.Object newObject) throws ReportSDKException
ReportSDKException
public boolean isDirectlyControllable()
public void enumerateMembers(IMemberVisitor visitor)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |