Package org.jfree.report.structure

Class Element

java.lang.Object
org.jfree.report.structure.Node
org.jfree.report.structure.Element
All Implemented Interfaces:
Serializable, Cloneable
Direct Known 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
See Also:

  • Field Details

  • 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

    • getNamespace

      public String getNamespace()

    • setNamespace

      public void setNamespace(String id)

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • getType

      public String getType()

    • setType

      public void setType(String type)

    • 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

    • getName

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

    • setAttribute

      public void setAttribute(String name, Object value)

    • setAttribute

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

    • getAttribute

      public Object getAttribute(String name)

    • getAttribute

      public Object getAttribute(String namespace, String name)

    • getAttributeMap

      public org.jfree.layouting.util.AttributeMap getAttributeMap()

    • getStyle

      public org.jfree.layouting.input.style.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

    • setVisibility

      public void setVisibility(org.jfree.layouting.input.style.values.CSSConstant v)

    • getVisibility

      public org.jfree.layouting.input.style.values.CSSConstant getVisibility()

    • setAttributeExpression

      public void setAttributeExpression(String attr, Expression function)

    • 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.

    • 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)

    • getAttributeExpressions

      public Map getAttributeExpressions(String namespace)

    • getAttributeExpressionMap

      public org.jfree.layouting.util.AttributeMap getAttributeExpressionMap()

    • setStyleExpression

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

    • getStyleExpression

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

    • getStyleExpressions

      public Map getStyleExpressions()

    • addExpression

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

    • getExpressions

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

    • setExpressions

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

    • isEnabled

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

    • 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 -

    • getDisplayCondition

      public Expression getDisplayCondition()
      Overrides:
      getDisplayCondition in class Node

    • setDisplayCondition

      public void setDisplayCondition(Expression displayCondition)

    • getLocale

      public Locale getLocale()
      Overrides:
      getLocale in class Node

    • getLocaleFromAttributes

      protected Locale getLocaleFromAttributes()

    • isVirtual

      public boolean isVirtual()

    • setVirtual

      public void setVirtual(boolean virtual)

    • clone

      public Object clone() throws CloneNotSupportedException
      Overrides:
      clone in class Node
      Throws:
      CloneNotSupportedException