com.businessobjects.rebean.wi
Interface ReportElementContainer

All Superinterfaces:
ReportElement, TreeNode, Unit
All Known Subinterfaces:
PageHeaderFooter, ReportBody, ReportContainer, ReportStructure, SectionContainer

public interface ReportElementContainer
extends ReportElement, Unit

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

The ReportElementContainer interface is a container for ReportElements.


Method Summary
 ReportElement copyReportElement(ReportElement element)
          Copies and adds a report element to this container.
 double getWidth()
          Returns the width of this element.
 void move(int fromIndex, int toIndex)
          Change the position of a ReportElement in the ReportElementContainer.
 void removeAllChildren()
          Removes any report elements from this container.
 void removeReportElement(ReportElement element)
          Removes an element.
 void removeReportElementAt(int index)
          Removes an element at a given index.
 
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
 

Method Detail

copyReportElement

ReportElement copyReportElement(ReportElement element)
Copies and adds a report element to this container.

Parameters:
element - the element to copy and add
Returns:
the new element
Throws:
java.lang.NullPointerException - when element is null
java.lang.IllegalArgumentException - when element cannot be added to this element (for example, no ReportBody can be added to a Cell)

removeReportElement

void removeReportElement(ReportElement element)
Removes an element. If element is not a direct child (or null), the method call does nothing.

Parameters:
element - the child to remove

removeReportElementAt

void removeReportElementAt(int index)
Removes an element at a given index.

Parameters:
index - the index to remove the element at
Throws:
java.lang.ArrayIndexOutOfBoundsException - if index is out of range (index < 0 || index >= getReportElementCount())

removeAllChildren

void removeAllChildren()
Removes any report elements from this container.


getWidth

double getWidth()
Returns the width of this element.

Returns:
the width, or -1 when there is no width available

move

void move(int fromIndex,
          int toIndex)
Change the position of a ReportElement in the ReportElementContainer. For example, a ReportElementContainer contains 4 ReportElements in the following order: rep1,rep2,rep3,rep4. After calling move(0,2), the order becomes rep2, rep3, rep1, rep4.

Parameters:
fromIndex - the initial index of the report element to be moved
toIndex - the index to which the report element will be moved
Throws:
java.lang.IndexOutOfBoundsException - if fromIndex or toIndex is out of range ( fromIndex(toIndex) < 0 || fromIndex(toIndex) >= getReportElementCount())
Since:
12.0