org.jfree.report.structure
Class Element
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
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() |
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 attr, Expression function) |
void | setAttributeExpression(String namespace, String attr, Expression function)
Adds a function to the report's collection of expressions.
|
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) |
public static final String ID_ATTRIBUTE
public static final String NAMESPACE_ATTRIBUTE
See XML-Namespaces for the idea of that one ...
public static final String NAME_ATTRIBUTE
public static final String TYPE_ATTRIBUTE
The type corresponds (somewhat) to the tagname of HTML.
public static final String VIRTUAL_ATTRIBUTE
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.
Adds a function to the report's collection of expressions.
Parameters: function the function.
public Object clone()
public Object getAttribute(String name)
public Object getAttribute(String namespace, String name)
public
Expression getAttributeExpression(String attr)
Returns the expressions for the report.
Parameters: attr
Returns: the expressions.
public
Expression getAttributeExpression(String namespace, String attr)
public AttributeMap getAttributeExpressionMap()
public Map getAttributeExpressions(String namespace)
public AttributeMap getAttributeMap()
Returns the expressions for the report.
Returns: the expressions.
public String getId()
public Locale getLocale()
protected Locale getLocaleFromAttributes()
public String getName()
Returns the name of the Element. The name of the Element is never null.
Returns: the name.
public String getNamespace()
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
public
Expression getStyleExpression(String property)
Returns the expressions for the report.
Parameters: property
Returns: the expressions.
public Map getStyleExpressions()
UNKNOWN: ReturnOfCollectionOrArrayField
public String getType()
public CSSConstant getVisibility()
public boolean isEnabled()
Returns true, if the element is enabled.
Returns: true or false
public boolean isVirtual()
public void setAttribute(String name, Object value)
public void setAttribute(String namespace, String name, Object value)
public void setAttributeExpression(String attr,
Expression function)
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.
public void setDisplayCondition(
Expression displayCondition)
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
public void setExpressions(
Expression[] expressions)
Sets the expressions for the report.
Parameters: expressions the expressions (null
not permitted).
public void setId(String id)
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
public void setNamespace(String id)
public void setStyleExpression(String property,
Expression function)
Adds a function to the report's collection of expressions.
Parameters: function the function. property
public void setType(String type)
public void setVirtual(boolean virtual)
public void setVisibility(CSSConstant v)