Package org.jfree.report.structure
Class Section
java.lang.Object
org.jfree.report.structure.Node
org.jfree.report.structure.Element
org.jfree.report.structure.Section
- All Implemented Interfaces:
Serializable
,Cloneable
- Direct Known Subclasses:
DetailSection
,Group
,ReportDefinition
A report section is a collection of other elements and sections.
This implementation is not synchronized, to take care that you externally
synchronize it when using multiple threads to modify instances of this
class.
Trying to add a parent of an band as child to the band, will result in an
exception.
The attribute and style expressions added to the element are considered
unnamed and stateless. To define a named, statefull state expression, one
would create an ordinary named expression or function and would then
reference that expression from within a style or attribute expression.
- Author:
- Thomas Morgner
- See Also:
-
Field Summary
Fields inherited from class org.jfree.report.structure.Element
ID_ATTRIBUTE, NAME_ATTRIBUTE, NAMESPACE_ATTRIBUTE, TYPE_ATTRIBUTE, VIRTUAL_ATTRIBUTE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a report element to the band.void
Adds a report element to the band.void
addNodes
(Collection elements) Adds a collection of elements to the band.void
void
clone()
findFirstChild
(String uri, String tagName) getElementByName
(String name) Returns the first element in the list that is known by the given name.getNode
(int index) Returns the element stored add the given index.Node[]
Returns an array of the elements in the band.int
Returns the number of elements in this band.getNodes()
Deprecated.boolean
isRepeat()
void
removeNode
(Node e) Removes an element from the band.void
void
setOperationBefore
(FlowControlOperation[] before) void
setRepeat
(boolean repeat) toString()
Returns a string representation of the band and all the elements it contains, useful mainly for debugging purposes.Methods inherited from class org.jfree.report.structure.Element
addExpression, getAttribute, getAttribute, getAttributeExpression, getAttributeExpression, getAttributeExpressionMap, getAttributeExpressions, getAttributeMap, getDisplayCondition, getExpressions, getId, getLocale, getLocaleFromAttributes, getName, getNamespace, getStyle, getStyleExpression, getStyleExpressions, getType, getVisibility, isEnabled, isVirtual, setAttribute, setAttribute, setAttributeExpression, setAttributeExpression, setDisplayCondition, setEnabled, setExpressions, setId, setName, setNamespace, setStyleExpression, setType, setVirtual, setVisibility
Methods inherited from class org.jfree.report.structure.Node
getGroup, getParent, getReport, getRootReport, setParent, updateParent
-
Constructor Details
-
Section
public Section()Constructs a new band (initially empty).
-
-
Method Details
-
addNode
Adds a report element to the band.- Parameters:
element
- the element that should be added- Throws:
NullPointerException
- if the given element is nullIllegalArgumentException
- if the position is invalid, either negative or greater than the number of elements in this band or if the given element is a parent of this element.
-
addNode
Adds a report element to the band. The element will be inserted at the specified position.- Parameters:
position
- the position where to insert the elementelement
- the element that should be added- Throws:
NullPointerException
- if the given element is nullIllegalArgumentException
- if the position is invalid, either negative or greater than the number of elements in this band or if the given element is a parent of this element.
-
addNodes
Adds a collection of elements to the band.- Parameters:
elements
- the element collection.- Throws:
NullPointerException
- if one of the given elements is nullIllegalArgumentException
- if one of the given element is a parent of this element.
-
getElementByName
Returns the first element in the list that is known by the given name.- Parameters:
name
- the element name.- Returns:
- the first element with the specified name, or
null
if there is no such element. - Throws:
NullPointerException
- if the given name is null.
-
removeNode
Removes an element from the band.- Parameters:
e
- the element to be removed.- Throws:
NullPointerException
- if the given element is null.
-
getNodes
Deprecated.usegetElementArray()
instead.Returns all child-elements of this band as immutable list.- Returns:
- an immutable list of all registered elements for this band.
-
getNodeCount
public int getNodeCount()Returns the number of elements in this band.- Returns:
- the number of elements of this band.
-
getNodeArray
Returns an array of the elements in the band. If the band is empty, an empty array is returned. For performance reasons, a shared cached instance is returned. Do not modify the returned array or live with the consquences.- Returns:
- the elements.
-
getNode
Returns the element stored add the given index.- Parameters:
index
- the element position within this band- Returns:
- the element
- Throws:
IndexOutOfBoundsException
- if the index is invalid.
-
toString
Returns a string representation of the band and all the elements it contains, useful mainly for debugging purposes. -
getOperationBefore
-
getOperationAfter
-
setOperationBefore
-
setOperationAfter
-
addOperationAfter
-
addOperationBefore
-
isRepeat
public boolean isRepeat() -
setRepeat
public void setRepeat(boolean repeat) -
findFirstChild
-
clone
- Overrides:
clone
in classElement
- Throws:
CloneNotSupportedException
-
getElementArray()
instead.