com.businessobjects.rebean.wi
Interface ReportContainer

All Superinterfaces:

Filterable, ReportElement, ReportElementContainer, TreeNode, Unit

public interface ReportContainer
extends ReportElementContainer, Filterable

Warning: This interface is no longer functional from the SAP BusinessObjects 4.0 release onwards.

ReportContainer interface represents a single report.

See Also:

DocumentInstance.createReport(String)

Method Summary

ReportElement	copyReportElement(ReportElement element) Replaces current header / body / footer with something else.
PageHeaderFooter	createPageFooter() Creates a new page footer.
PageHeaderFooter	createPageHeader() Creates a new page header.
ReportBody	createReportBody() Creates a new body.
java.awt.Color	getHyperlinkColor() Returns the color used for any hyperlinks in this report.
java.lang.String	getName() Returns the report name.
PageHeaderFooter	getPageFooter() Gets the page footer, when there is one.
PageHeaderFooter	getPageHeader() Gets the page header, when there is one.
PageInfo	getPageInfo() Returns an object holding information on the page size and margins for this report.
ReportBody	getReportBody() Gets the page body.
java.lang.String	getSourceName() Returns the report name in the locale it was created.
java.awt.Color	getVisitedHyperlinkColor() Returns the color used for any visited hyperlinks in this report.
void	removeAllChildren() Removes all children except for the body; all the body's children are removed though.
void	removeReportElement(ReportElement element) Removes only the current header / footer.
void	removeReportElementAt(int index) Removes only the current header / footer.
void	setHyperlinkColor(java.awt.Color c) Changes the color used for any hyperlinks in this report.
void	setName(java.lang.String name) Changes the report name.
void	setVisitedHyperlinkColor(java.awt.Color c) Changes the color used for any visited hyperlinks in this report.

Methods inherited from interface com.businessobjects.rebean.wi.ReportElementContainer

getWidth, move

Methods inherited from interface com.businessobjects.rebean.wi.ReportElement

getFather, getID, getReportElement, getReportElement, getReportElementCount

Methods inherited from interface com.businessobjects.rebean.wi.TreeNode

getChildAt, getChildCount, getIndex, getParent, isLeaf

Methods inherited from interface com.businessobjects.rebean.wi.Unit

getUnit, setUnit

Methods inherited from interface com.businessobjects.rebean.wi.Filterable

copyFilter, createFilter, getFilter, hasFilter, removeFilter

Method Detail

createPageHeader

PageHeaderFooter createPageHeader()

Creates a new page header. Replaces the current header when there is one.

Returns:

the new header

getPageHeader

PageHeaderFooter getPageHeader()

Gets the page header, when there is one. This is a shortcut for obtaining the header using TreeNode.getChildAt(int).

Returns:

the page header, or null when there is no page header

createPageFooter

PageHeaderFooter createPageFooter()

Creates a new page footer. Replaces the current footer when there is one.

Returns:

the new footer

getPageFooter

PageHeaderFooter getPageFooter()

Gets the page footer, when there is one. This is a shortcut for obtaining the footer using TreeNode.getChildAt(int).

Returns:

the page footer, or null when there is no page footer

createReportBody

ReportBody createReportBody()

Creates a new body. Since the body can not be removed, this method always replaces the current body.

Returns:

the new body

getReportBody

ReportBody getReportBody()

Gets the page body. This is a shortcut for obtaining the body using TreeNode.getChildAt(int).

Returns:

the page body

getName

java.lang.String getName()

Returns the report name.

Returns:

the report name

getSourceName

java.lang.String getSourceName()

Returns the report name in the locale it was created.

Returns:

the report name in the locale it was created.

Since:

12.2

setName

void setName(java.lang.String name)

Changes the report name.

Parameters:

name - the new report name

getPageInfo

PageInfo getPageInfo()

Returns an object holding information on the page size and margins for this report.

Returns:

the page information

copyReportElement

ReportElement copyReportElement(ReportElement element)

Replaces current header / body / footer with something else. Does still create a copy of element.

Specified by:

copyReportElement in interface ReportElementContainer

Parameters:

element - the element to copy and add

Returns:

the new element

See Also:

ReportElementContainer.copyReportElement(ReportElement)

removeReportElement

void removeReportElement(ReportElement element)

Removes only the current header / footer. The body cannot be removed; when called for the body, all the body's children will be removed.

Specified by:

removeReportElement in interface ReportElementContainer

Parameters:

element - the child to remove

See Also:

ReportElementContainer.removeReportElement(ReportElement)

removeReportElementAt

void removeReportElementAt(int index)

Removes only the current header / footer. The body cannot be removed; when called for the body, all the body's children will be removed.

Specified by:

removeReportElementAt in interface ReportElementContainer

Parameters:

index - the index to remove the element at

See Also:

ReportElementContainer.removeReportElementAt(int)

removeAllChildren

void removeAllChildren()

Removes all children except for the body; all the body's children are removed though.

Specified by:

removeAllChildren in interface ReportElementContainer

See Also:

ReportElementContainer.removeAllChildren()

getHyperlinkColor

java.awt.Color getHyperlinkColor()

Returns the color used for any hyperlinks in this report.

Returns:

the hyperlink color for this report

setHyperlinkColor

void setHyperlinkColor(java.awt.Color c)

Changes the color used for any hyperlinks in this report.

Parameters:

c - the new hyperlink color for this report

getVisitedHyperlinkColor

java.awt.Color getVisitedHyperlinkColor()

Returns the color used for any visited hyperlinks in this report.

Returns:

the visited hyperlink color for this report

setVisitedHyperlinkColor

void setVisitedHyperlinkColor(java.awt.Color c)

Changes the color used for any visited hyperlinks in this report.

Parameters:

c - the new visited hyperlink color for this report