com.businessobjects.rebean.wi
Interface BreakElement

public interface BreakElement

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

A break on a single report expression.

Method Summary

ReportExpression	getExpression() Returns the expression this break is based on.
boolean	hasImplicateSort() Does this break element have an implicate sort?
boolean	isAvoidPageBreak() Returns if there should never be a page break in the element.
boolean	isFooterVisible() Checks if the footer for this break is visible or not.
boolean	isHeaderOnEveryPage() If the block spans over several pages, should the header be shown on each page?
boolean	isHeaderVisible() Checks if the header for this break is visible or not.
boolean	isStartOnNewPage() Checks if each different break value will be placed on a new page or not.
boolean	isValueCentered() Checks if the value for this break will be centered across the rows or columns.
boolean	isValueOnNewPage() Is the break value repeated on each page?
boolean	isValueRepeated() Is this break's value repeated on each row or column?
void	setAvoidPageBreak(boolean b) Changes if there should never be a page break in the element.
void	setFooterVisible(boolean show) Shows or hides the footer for this break.
void	setHeaderOnEveryPage(boolean b) Changes is the header is repeated on every page or not.
void	setHeaderVisible(boolean show) Shows or hides the header for this break.
void	setImplicateSort(boolean b) Sets an implicate sort for this break, or removes it.
void	setStartOnNewPage(boolean b) Sets if each different break value will be placed on a new page or not.
void	setValueCentered(boolean center) Centers the break value across all rows or columns, or removes that feature.
void	setValueOnNewPage(boolean b) Changed the duplication behaviour for this break.
void	setValueRepeated(boolean b) Changes if the value for this break will be repeated on each row or column.

Method Detail

getExpression

ReportExpression getExpression()

Returns the expression this break is based on.

Returns:

the expression this break is based on

isHeaderVisible

boolean isHeaderVisible()

Checks if the header for this break is visible or not. return true if the break header is visible

setHeaderVisible

void setHeaderVisible(boolean show)

Shows or hides the header for this break.

Parameters:

show - when true, the header for this break will be shown

isFooterVisible

boolean isFooterVisible()

Checks if the footer for this break is visible or not. return true if the break footer is visible

setFooterVisible

void setFooterVisible(boolean show)

Shows or hides the footer for this break.

Parameters:

show - when true, the footer for this break will be shown

isValueCentered

boolean isValueCentered()

Checks if the value for this break will be centered across the rows or columns. return true when the value is centered

setValueCentered

void setValueCentered(boolean center)

Centers the break value across all rows or columns, or removes that feature. Setting this to true will also set BreakElement.isValueRepeated() to false.

Parameters:

center - when true, the break's value will be centered across the break's rows or columns

isValueRepeated

boolean isValueRepeated()

Is this break's value repeated on each row or column? If so, the value will be displayed on each row or column, if not, only once.

Returns:

true if this break's value will be shown on each row or column

setValueRepeated

void setValueRepeated(boolean b)

Changes if the value for this break will be repeated on each row or column. When setting this to true, BreakElement.isValueCentered() and BreakElement.isValueOnNewPage() will return false.

Parameters:

b - when true the break's value will be repeated on each row or column

isValueOnNewPage

boolean isValueOnNewPage()

Is the break value repeated on each page? This only applies when BreakElement.isValueRepeated() is false; when isValueOnNewPage() is true, the break value will still be repeated at the beginning of a new page, otherwise it will not.

Returns:

true when the break value will be repeated on other pages if the block is spread over several pages

See Also:

BreakElement.isValueRepeated()

setValueOnNewPage

void setValueOnNewPage(boolean b)

Changed the duplication behaviour for this break. When set to true, this will set BreakElement.isValueRepeated() to false.

Parameters:

b - When set to true, the break value will be repeated on other pages if the block is spread over several pages

See Also:

BreakElement.isValueOnNewPage()

isHeaderOnEveryPage

boolean isHeaderOnEveryPage()

If the block spans over several pages, should the header be shown on each page? Note that this has no visual effect when BreakElement.isHeaderVisible() returns false.

Returns:

true when the break header is repeated on every page

setHeaderOnEveryPage

void setHeaderOnEveryPage(boolean b)

Changes is the header is repeated on every page or not. Note that this has no visual effect when BreakElement.isHeaderVisible() returns false.

Parameters:

b - when true, the header will be repeated on every page

isStartOnNewPage

boolean isStartOnNewPage()

Checks if each different break value will be placed on a new page or not.

Returns:

true if each different break value will be placed on a new page

setStartOnNewPage

void setStartOnNewPage(boolean b)

Sets if each different break value will be placed on a new page or not.

Parameters:

b - when true, each different break value will be placed on a new page

hasImplicateSort

boolean hasImplicateSort()

Does this break element have an implicate sort? If so, the values for this break will be sorted in ascending order.

Note that implicate sorts for breaks do not appear in any BlockSort.

Returns:

true when break values will be sorted

Since:

6.1

setImplicateSort

void setImplicateSort(boolean b)

Sets an implicate sort for this break, or removes it.

Parameters:

b - when true, an implicate sort will be created for this break element, or when false, this break will not be sorted.

Since:

6.1

See Also:

BreakElement.hasImplicateSort()

isAvoidPageBreak

boolean isAvoidPageBreak()

Returns if there should never be a page break in the element.

Returns:

true when the element should never have a page break in it (when possible)

Since:

11.5

setAvoidPageBreak

void setAvoidPageBreak(boolean b)

Changes if there should never be a page break in the element.

Parameters:

b - true when the element should never have a page break in it (when possible)

Since:

11.5