Klasse SummaryInfo

java.lang.Object

com.inet.report.SummaryInfo

Alle implementierten Schnittstellen:

Serializable

public class SummaryInfo
extends Object
implements Serializable

With this class SummaryInfo you can get/set the report summary info specified in the "Summary Info" of the i-net Designer or with the setXXX methods in this class.
For example:

Engine eng = new Engine( Engine.NO_EXPORT );
eng.setReportFile( "file:C:/MyReports/Report1.rpt" );
SummaryInfo su = eng.getSummaryInfo();
System.out.println("created: "+su.getCreated());
System.out.println("LastSaved: "+su.getLastSaved());
System.out.println("Author: "+su.getAuthor());
System.out.println("Subject: "+su.getSubject());
System.out.println("ReportTitle: "+su.getReportTitle());

Seit:

6.0

Siehe auch:

• Engine.getSummaryInfo()
• Serialisierte Form

Methodenübersicht

Modifikator und Typ	Methode	Beschreibung
String	getAuthor()	Returns the author of the report if the value was specified in the "Summary Info" or with the method setAuthor(String).
String	getComments()	Returns the comments of the report if the value was specified in the "Summary Info" or with the method setComments(String).
Date	getCreated()	Returns the date and time the report was created.
String	getKeywords()	Returns the keywords of the report if the value was specified in the "Summary Info" or with the method setKeywords(String).
Date	getLastSaved()	Returns the date and time set as the last time the report was saved.
String	getReportTitle()	Returns the report title if the value was specified in the "Summary Info" or with the method setReportTitle(String).
String	getSubject()	Returns the subject of the report if the value was specified in the "Summary Info" or with the method setSubject(String).
String	getTemplate()	Returns the template value of the report if the value was specified in the "Summary Info" or with the method setTemplate(String).
Image	getThumbnail()	FOR INTERNAL USE ONLY Gets the report's "thumbnail" image if there is one.
byte[]	getThumbnailData()	FOR INTERNAL USE ONLY Gets the report's "thumbnail" image if there is one.
void	setAuthor(String author)	Sets the author of the report.
void	setComments(String comments)	Sets the comments of the report.
void	setCreated(Date createTime)	Sets the date and time the report was created.
void	setKeywords(String keywords)	Sets the keywords of the report as a single string.
void	setLastSaved(Date lastSave)	Sets the date and time the report was last saved.
void	setReportTitle(String title)	Sets the report title.
void	setSubject(String subject)	Sets the subject of the report, that is, the general theme.
void	setTemplate(String template)	Sets the template field of the report.
void	setThumbnail(Image img)	FOR INTERNAL USE ONLY Sets the image as the report's "thumbnail" image.
void	setThumbnailData(byte[] data)	FOR INTERNAL USE ONLY Sets the image as the report's "thumbnail" image.

Von Klasse geerbte Methoden Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methodendetails

getAuthor

public String getAuthor()

Returns the author of the report if the value was specified in the "Summary Info" or with the method setAuthor(String).

Gibt zurück:

The author of the report if specified, otherwise null

Seit:

6.0

Siehe auch:

• setAuthor(String)

setAuthor

public void setAuthor(String author)

Sets the author of the report.

Parameter:

author - Author of the report

Seit:

6.0

Siehe auch:

• getAuthor()

getKeywords

public String getKeywords()

Returns the keywords of the report if the value was specified in the "Summary Info" or with the method setKeywords(String).

Gibt zurück:

The keywords of the report if specified

Seit:

6.0

Siehe auch:

• setKeywords(String)

setKeywords

public void setKeywords(String keywords)

Sets the keywords of the report as a single string.

Parameter:

keywords - Keywords of the report as a single string.

Seit:

6.0

Siehe auch:

• getKeywords()

getComments

public String getComments()

Returns the comments of the report if the value was specified in the "Summary Info" or with the method setComments(String).

Gibt zurück:

The comments saved in the report, if any.

Seit:

6.0

Siehe auch:

• setComments(String)

setComments

public void setComments(String comments)

Sets the comments of the report. These could be for example the reason for the report, or or changes which have been made to the report, etc.

Parameter:

comments - Comments to set for the report

Seit:

6.0

Siehe auch:

• getComments()

getReportTitle

public String getReportTitle()

Returns the report title if the value was specified in the "Summary Info" or with the method setReportTitle(String).

Gibt zurück:

The report title if specified, else null

Seit:

6.0

Siehe auch:

• setReportTitle(String)

setReportTitle

public void setReportTitle(String title)

Sets the report title. May be null if no title is to be set. The title is used as label for the view tabs in the viewer and as export file name.

Parameter:

title - Title to set for the report, may be null

Seit:

6.0

Siehe auch:

• getReportTitle()

getSubject

public String getSubject()

Returns the subject of the report if the value was specified in the "Summary Info" or with the method setSubject(String).

Gibt zurück:

The subject of the report if specified

Seit:

6.0

Siehe auch:

• setSubject(String)

setSubject

public void setSubject(String subject)

Sets the subject of the report, that is, the general theme.

Parameter:

subject - Subject to set for the report

Seit:

6.0

Siehe auch:

• getSubject()

getTemplate

public String getTemplate()

Returns the template value of the report if the value was specified in the "Summary Info" or with the method setTemplate(String).

Gibt zurück:

The value of the template field if specified.

Seit:

6.0

Siehe auch:

• setTemplate(String)

setTemplate

public void setTemplate(String template)

Sets the template field of the report. Note that at this point, this has no effect other than to save another string in the SummaryInfo.

Parameter:

template - String to save as "template" of the report.

Seit:

6.0

Siehe auch:

• getTemplate()

getCreated

public Date getCreated()

Returns the date and time the report was created.

Gibt zurück:

Date and time set as report creation time.

Seit:

6.0

Siehe auch:

• setCreated(java.util.Date)

setCreated

public void setCreated(Date createTime)

Sets the date and time the report was created.

Parameter:

createTime - Time to set as the creation date of the report.

Seit:

6.0

Siehe auch:

• getCreated()

getLastSaved

public Date getLastSaved()

Returns the date and time set as the last time the report was saved.

Gibt zurück:

The date and time set as the last time the report was saved.

Seit:

6.0

Siehe auch:

• setLastSaved(java.util.Date)

setLastSaved

public void setLastSaved(Date lastSave)

Sets the date and time the report was last saved.

Parameter:

lastSave - Date and time to set the report as being last saved on

Seit:

6.0

Siehe auch:

• getLastSaved()

setThumbnail

public void setThumbnail(Image img)

FOR INTERNAL USE ONLY Sets the image as the report's "thumbnail" image. This image is stored within the report as Thumbnails/Thumbnail.png. This overwrites the currently set thumbnail. Setting null is allowed and causes the thumbnail to be the default thumbnail image. The thumbnail image is scaled to 96x96 pixels.

Parameter:

img - Image to store as the report's thumbnail. Null is allowed.

Seit:

9.0

getThumbnail

public Image getThumbnail()

FOR INTERNAL USE ONLY Gets the report's "thumbnail" image if there is one. Can be null, which means no thumbnail exists for the report (e.g. if the report is in an old report format).

Gibt zurück:

the report's thumbnail image or null if the report has no thumbnail

Seit:

9.0

setThumbnailData

public void setThumbnailData(byte[] data)

FOR INTERNAL USE ONLY Sets the image as the report's "thumbnail" image. This image is stored within the report as Thumbnails/Thumbnail.png. This overwrites the currently set thumbnail. Setting null is allowed and causes the thumbnail to be the default thumbnail image. The thumbnail image is scaled to 96x96 pixels.

Parameter:

data - Image to store as the report's thumbnail. Null is allowed. The bytes must be readable from ImageIO.

Seit:

11.0

getThumbnailData

public byte[] getThumbnailData()

FOR INTERNAL USE ONLY Gets the report's "thumbnail" image if there is one. Can be null, which means no thumbnail exists for the report (e.g. if the report is in an old report format).

Gibt zurück:

the report's thumbnail image data or null if the report has no thumbnail

Seit:

11.0