com.businessobjects.rebean.wi
Interface ReportBlock

All Superinterfaces:

Attachable, Filterable, PageLayout, Position, ReportElement, TreeNode, Unit

public interface ReportBlock
extends ReportElement, PageLayout, Attachable, Filterable

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

Represents a block in a report. A block can be either a table or a graph.

Method Summary

void	changeAxes() Changes the Axes
BlockAxis	getAxis(AxisType type) Returns an axis of the block.
BlockSort	getBlockSort(boolean horizontal) Returns the BlockSort object in the requested direction.
boolean	getDuplicateRowAggregation() Checks if duplicate rows will be shown in the block or not.
java.lang.String	getName() Returns the name of this block.
Representation	getRepresentation() Returns the representation of this block.
boolean	isShowWhenEmpty() Returns true if the block is visible when it contains no values.
boolean	repeatOnEveryPage() Checks if the cell is repeated on every page or not.
void	repeatOnEveryPage(boolean b) Specifies whether the cell is repeated on every page.
void	setDuplicateRowAggregation(boolean b) Sets whether duplicate rows will be displayed in the block.
void	setName(java.lang.String name) Changes the block name.
void	setShowWhenEmpty(boolean show) Specifies if this block should be visible when it contains no values.

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

avoidPageBreak, avoidPageBreak, startOnNewPage, startOnNewPage

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

deleteAttachment, getAttachTo, getHAttachTo, getHorizontalAnchor, getVAttachTo, getVerticalAnchor, setAttachTo, setAttachTo

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

getX, getY, setLocation, setX, setY

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

getName

java.lang.String getName()

Returns the name of this block. The block name is not shown in the final report. The block name can be used to identify the block.

Returns:

the name

setName

void setName(java.lang.String name)

Changes the block name.

Parameters:

name - the new name

Throws:

java.lang.NullPointerException - when name is null

getAxis

BlockAxis getAxis(AxisType type)

Returns an axis of the block. An axis holds the report expressions that are displayed in the block. For information on which block uses which axes, see the BlockType interfaces.

It is not an error to request an axis that does not exist for a block; when one or more expressions are added to an axis that does not currently exist, the block type will change to something that can hold expressions in all current axes. For example, a TableType.VTABLE block has all its expressions in TableAxis.HORIZONTAL. When an expression is added to TableAxis.VERTICAL, the block will automatically be turned into a crosstable. Note that changing block type may move some expressions from one axis to another, as described in Representation.setType(BlockType).

Parameters:

type - the axis type

Returns:

the requested block axis

Throws:

java.lang.NullPointerException - when type is null

changeAxes

void changeAxes()

Changes the Axes

getRepresentation

Representation getRepresentation()

Returns the representation of this block. The returned object is a Representation. The Representation type can be tested using Representation.getType().

Returns:

the representation of this block

getDuplicateRowAggregation

boolean getDuplicateRowAggregation()

Checks if duplicate rows will be shown in the block or not.

Note: When Query.getDuplicatedRows() returns false, duplicate rows are already filtered out at the Query level.

Returns:

false when duplicate rows will be shown in the block

setDuplicateRowAggregation

void setDuplicateRowAggregation(boolean b)

Sets whether duplicate rows will be displayed in the block.

Parameters:

b - set to false for duplicate rows to be shown in the block

See Also:

ReportBlock.getDuplicateRowAggregation(), Query.setDuplicatedRows(boolean)

repeatOnEveryPage

boolean repeatOnEveryPage()

Checks if the cell is repeated on every page or not.

Returns:

true when the cell is repeated on every page

repeatOnEveryPage

void repeatOnEveryPage(boolean b)

Specifies whether the cell is repeated on every page.

Parameters:

b - set to true so the cell is repeated on every page

getBlockSort

BlockSort getBlockSort(boolean horizontal)

Returns the BlockSort object in the requested direction.

Parameters:

horizontal - when true, the horizontal sorts will be returned

Returns:

the sort list

isShowWhenEmpty

boolean isShowWhenEmpty()

Returns true if the block is visible when it contains no values.

Returns:

true if the block will be displayed in the result when it is empty

Since:

6.5.0

setShowWhenEmpty

void setShowWhenEmpty(boolean show)

Specifies if this block should be visible when it contains no values.

Parameters:

show - if set to true, the block will be displayed in the resulting report, even when it is empty

Since:

6.5.0