com.businessobjects.rebean.wi
Interface PageHeaderFooter

All Superinterfaces:

Decoration, ReportElement, ReportElementContainer, TreeNode, Unit

public interface PageHeaderFooter
extends ReportElementContainer, Decoration, Unit

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

Represents a page header or a page footer.

See Also:

ReportContainer

Method Summary

FreeCell	createFreeCell(java.lang.String text) Creates a new cell holding a specified text.
ReportCell	createReportCell(ReportExpression expr) Creates a new cell, based on a report expression.
double	getHeight() Returns the height of this header or footer.
boolean	isHeader() Checks wheather this object represents a header or a footer.
void	setHeight(double size) Changes the height of this header or footer.

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

copyReportElement, getWidth, move, removeAllChildren, removeReportElement, removeReportElementAt

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.Decoration

getAlignment, getAttributes, getBackgroundAlignment, getFont, setAlignment, setAttributes, setBackgroundAlignment, setFont

Method Detail

isHeader

boolean isHeader()

Checks wheather this object represents a header or a footer.

Returns:

true when this instance is a page header, or false when it is a page footer

createFreeCell

FreeCell createFreeCell(java.lang.String text)

Creates a new cell holding a specified text.

Parameters:

text - the text to display in the cell

Returns:

the new cell

Throws:

java.lang.NullPointerException - when text is null

createReportCell

ReportCell createReportCell(ReportExpression expr)

Creates a new cell, based on a report expression.

Parameters:

expr - the report expression

Returns:

the new cell

Throws:

java.lang.NullPointerException - when expr is null

getHeight

double getHeight()

Returns the height of this header or footer. The unity used is Unit.getUnit().

Returns:

the height

setHeight

void setHeight(double size)

Changes the height of this header or footer. The unity used is Unit.getUnit().

Parameters:

size - the new height

Throws:

java.lang.IllegalArgumentException - when size < 0.0