com.businessobjects.rebean.wi
Interface Foldable

public interface Foldable

The Foldable interface represents the elements of report that can be folded (Sections, Table Block Axis and Breaks). ReportElement, BlockAxis and BreakElement can be casted to 'Foldable'.

Since:

12.2.0

See Also:

FoldInfo

Method Summary

java.util.Vector	getFoldTree() Returns the FoldInfo vector that contains the hierarcy of the fold details for the instances of the element.
boolean	isFoldAll() Checks if all instances of the element are folded.
boolean	isFolded(java.util.ArrayList foldinfo) Checks if the fold condition exists in the fold info tree of the element.
boolean	removeFold(java.util.ArrayList foldinfo) Returns true if the fold condition is removed from the foldinfo tree of the element.
void	setFoldAll(boolean allfold) Sets foldAll flag for the element.
boolean	setFolded(java.util.ArrayList foldinfo) Returns true, if the fold condition is set successfully for the element.
void	setFoldTree(java.util.Vector foldTree) Sets the FoldInfo vector that contains the hierarcy of the fold details for the instances of the element.

Method Detail

isFoldAll

boolean isFoldAll()

Checks if all instances of the element are folded.

Returns:

true if all the instances of the element are folded, otherwise false.

setFoldAll

void setFoldAll(boolean allfold)

Sets foldAll flag for the element. Its also removes all the fold information in the foldtree.

Parameters:

allfold - a boolean value.

setFoldTree

void setFoldTree(java.util.Vector foldTree)

Sets the FoldInfo vector that contains the hierarcy of the fold details for the instances of the element.

Parameters:

foldTree - The Vector.

getFoldTree

java.util.Vector getFoldTree()

Returns the FoldInfo vector that contains the hierarcy of the fold details for the instances of the element.

Returns:

the FoldInfo vector that contains the hierarcy of the fold details for the instances of the element.

setFolded

boolean setFolded(java.util.ArrayList foldinfo)

Returns true, if the fold condition is set successfully for the element. This function folds the specific index and will have a toggling effect on the fold condition of the particular index depending on the foldAll flag. If setFoldAll() is called before this function, this function unfolds the specific index alone, as all the indices will be folded by default.

Parameters:

foldinfo - The String array that represents one fold condition. Strings contain foldinfo fragments (bid:index value) in the parent to child order.

Returns:

true if the fold condition is set successfully for the element, otherwise false.

isFolded

boolean isFolded(java.util.ArrayList foldinfo)

Checks if the fold condition exists in the fold info tree of the element. Fold status of a particular foldinfo is decided by this method considering "isFoldAll()" method. If isFolded(foldinfo) returns true, and

• if isFoldAll() returns false, foldinfo is folded,
• if isFoldAll() returns true, foldinfo is unfolded.

Parameters:

foldinfo - The ArrayList of FoldInfo instances.

Returns:

true if the fold condition exists in the fold info tree of the element, otherwise false.

removeFold

boolean removeFold(java.util.ArrayList foldinfo)

Returns true if the fold condition is removed from the foldinfo tree of the element. Normally this method unfolds the specific index. Depending on the isFoldAll() method, this method will have toggling effect on the fold condition of the particular index. If setFoldAll() method is called before this method, this method folds the specific index as all the indices will be folded by default.

Parameters:

foldinfo - The ArrayList of FoldInfo instances.

Returns:

true if the fold condition is removed from the foldinfo tree of the element, otherwise false.