org.jfree.report.structure

Class Element

Implemented Interfaces:
Cloneable, Serializable
Known Direct Subclasses:
AutoTableCellContent, AutoTableElement, ContentElement, Section

public abstract class Element
extends Node

An element is a node that can have attributes. The 'id' and the 'name' attribute is defined for all elements.

Both the name and the id attribute may be null.

Properties in the 'http://jfreereport.sourceforge.net/namespaces/engine/flow' namespace and in the 'http://jfreereport.sourceforge.net/namespaces/engine/compatibility' namespace are considered internal. You should only touch them, if you really know what you are doing.

Author:
Thomas Morgner

Field Summary

static String
ID_ATTRIBUTE
static String
NAMESPACE_ATTRIBUTE
See XML-Namespaces for the idea of that one ...
static String
NAME_ATTRIBUTE
static String
TYPE_ATTRIBUTE
The type corresponds (somewhat) to the tagname of HTML.
static String
VIRTUAL_ATTRIBUTE

Constructor Summary

Element()
Constructs an element.

Method Summary

void
addExpression(Expression function)
Adds a function to the report's collection of expressions.
Object
clone()
Object
getAttribute(String name)
Object
getAttribute(String namespace, String name)
Expression
getAttributeExpression(String attr)
Returns the expressions for the report.
Expression
getAttributeExpression(String namespace, String attr)
AttributeMap
getAttributeExpressionMap()
Map
getAttributeExpressions(String namespace)
AttributeMap
getAttributeMap()
String[]
getAttributeNameSpaces()
Map
getAttributes(String namespace)
Expression
getDisplayCondition()
Expression[]
getExpressions()
Returns the expressions for the report.
String
getId()
Locale
getLocale()
protected Locale
getLocaleFromAttributes()
String
getName()
Returns the name of the Element.
String
getNamespace()
CSSStyleRule
getStyle()
Returns this elements private stylesheet.
Expression
getStyleExpression(String property)
Returns the expressions for the report.
Map
getStyleExpressions()
String
getType()
CSSConstant
getVisibility()
boolean
isEnabled()
Returns true, if the element is enabled.
boolean
isVirtual()
void
setAttribute(String name, Object value)
void
setAttribute(String namespace, String name, Object value)
void
setAttributeExpression(String namespace, String attr, Expression function)
Adds a function to the report's collection of expressions.
void
setAttributeExpression(String attr, Expression function)
void
setDisplayCondition(Expression displayCondition)
void
setEnabled(boolean enabled)
Defines whether the element is enabled.
void
setExpressions(Expression[] expressions)
Sets the expressions for the report.
void
setId(String id)
void
setName(String name)
Defines the name for this Element.
void
setNamespace(String id)
void
setStyleExpression(String property, Expression function)
Adds a function to the report's collection of expressions.
void
setType(String type)
void
setVirtual(boolean virtual)
void
setVisibility(CSSConstant v)

Methods inherited from class org.jfree.report.structure.Node

clone, getDisplayCondition, getGroup, getLocale, getParent, getReport, getRootReport, isEnabled, setParent, updateParent

Field Details

ID_ATTRIBUTE

public static final String ID_ATTRIBUTE

NAMESPACE_ATTRIBUTE

public static final String NAMESPACE_ATTRIBUTE
See XML-Namespaces for the idea of that one ...

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

TYPE_ATTRIBUTE

public static final String TYPE_ATTRIBUTE
The type corresponds (somewhat) to the tagname of HTML.

VIRTUAL_ATTRIBUTE

public static final String VIRTUAL_ATTRIBUTE

Constructor Details

Element

protected Element()
Constructs an element.

The element inherits the element's defined default ElementStyleSheet to provide reasonable default values for common stylekeys. When the element is added to the band, the bands stylesheet is set as parent to the element's stylesheet.

A datasource is assigned with this element is set to a default source, which always returns null.

Method Details

addExpression

public void addExpression(Expression function)
Adds a function to the report's collection of expressions.
Parameters:
function - the function.

clone

public Object clone()
            throws CloneNotSupportedException
Overrides:
clone in interface Node

getAttribute

public Object getAttribute(String name)

getAttribute

public Object getAttribute(String namespace,
                           String name)

getAttributeExpression

public Expression getAttributeExpression(String attr)
Returns the expressions for the report.
Parameters:
attr -
Returns:
the expressions.

getAttributeExpression

public Expression getAttributeExpression(String namespace,
                                         String attr)

getAttributeExpressionMap

public AttributeMap getAttributeExpressionMap()

getAttributeExpressions

public Map getAttributeExpressions(String namespace)

getAttributeMap

public AttributeMap getAttributeMap()

getAttributeNameSpaces

public String[] getAttributeNameSpaces()

getAttributes

public Map getAttributes(String namespace)

getDisplayCondition

public Expression getDisplayCondition()
Overrides:
getDisplayCondition in interface Node

getExpressions

public Expression[] getExpressions()
Returns the expressions for the report.
Returns:
the expressions.

getId

public String getId()

getLocale

public Locale getLocale()
Overrides:
getLocale in interface Node

getLocaleFromAttributes

protected Locale getLocaleFromAttributes()

getName

public String getName()
Returns the name of the Element. The name of the Element is never null.
Returns:
the name.

getNamespace

public String getNamespace()

getStyle

public CSSStyleRule getStyle()
Returns this elements private stylesheet. This sheet can be used to override the default values set in one of the parent-stylesheets.
Returns:
the Element's stylesheet

getStyleExpression

public Expression getStyleExpression(String property)
Returns the expressions for the report.
Parameters:
property -
Returns:
the expressions.

getStyleExpressions

public Map getStyleExpressions()

getType

public String getType()

getVisibility

public CSSConstant getVisibility()

isEnabled

public boolean isEnabled()
Returns true, if the element is enabled.
Overrides:
isEnabled in interface Node
Returns:
true or false

isVirtual

public boolean isVirtual()

setAttribute

public void setAttribute(String name,
                         Object value)

setAttribute

public void setAttribute(String namespace,
                         String name,
                         Object value)

setAttributeExpression

public void setAttributeExpression(String namespace,
                                   String attr,
                                   Expression function)
Adds a function to the report's collection of expressions.
Parameters:
namespace -
attr -
function - the function.

setAttributeExpression

public void setAttributeExpression(String attr,
                                   Expression function)

setDisplayCondition

public void setDisplayCondition(Expression displayCondition)

setEnabled

public void setEnabled(boolean enabled)
Defines whether the element is enabled. Disabled elements will be fully ignored by the report processor. This is a design time property to exclude elements from the processing without actually having to deal with the other complex properties.
Parameters:
enabled -

setExpressions

public void setExpressions(Expression[] expressions)
Sets the expressions for the report.
Parameters:
expressions - the expressions (null not permitted).

setId

public void setId(String id)

setName

public void setName(String name)
Defines the name for this Element. The name must not be empty, or a NullPointerException is thrown.

Names can be used to lookup an element within a band. There is no requirement for element names to be unique.

Parameters:
name - the name of this element

setNamespace

public void setNamespace(String id)

setStyleExpression

public void setStyleExpression(String property,
                               Expression function)
Adds a function to the report's collection of expressions.
Parameters:
property -
function - the function.

setType

public void setType(String type)

setVirtual

public void setVirtual(boolean virtual)

setVisibility

public void setVisibility(CSSConstant v)