org.pentaho.reporting.engine.classic.core.filter.types

Class AutoLayoutBoxType

java.lang.Object

org.pentaho.reporting.engine.classic.core.filter.types.AbstractElementType

org.pentaho.reporting.engine.classic.core.filter.types.AutoLayoutBoxType

All Implemented Interfaces:

Serializable, Cloneable, DataSource, ElementType

public class AutoLayoutBoxType
extends AbstractElementType

A internal type that marks boxes that have been created for layouting purposes.

Author:

Thomas Morgner

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ElementType	INSTANCE

Constructor Summary

Constructors

Constructor and Description
AutoLayoutBoxType()

Method Summary

Modifier and Type	Method and Description
void	configureDesignTimeDefaults(ReportElement element, Locale locale) Compute the design-time defaults that should be applied to an element after it was created by a design-tool.
ReportElement	create() Creates the element implementation.
Object	getDesignValue(ExpressionRuntime runtime, ReportElement element) Compute a design-time value.
Object	getValue(ExpressionRuntime runtime, ReportElement element) Returns the current value for the data source.

Methods inherited from class org.pentaho.reporting.engine.classic.core.filter.types.AbstractElementType

clone, equals, getMetaData, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final ElementType INSTANCE

Constructor Detail

AutoLayoutBoxType

public AutoLayoutBoxType()

Method Detail

create

public ReportElement create()

Description copied from interface: ElementType

Creates the element implementation. Return a new Element for data-items, Band for compound data items or the appropriate Element implementation for complex element types.

Specified by:

create in interface ElementType

Overrides:

create in class AbstractElementType

Returns:

the new element instance.

getValue

public Object getValue(ExpressionRuntime runtime,
                       ReportElement element)

Returns the current value for the data source.

Parameters:

runtime - the expression runtime that is used to evaluate formulas and expressions when computing the value of this filter.

element - the element.

Returns:

the value.

getDesignValue

public Object getDesignValue(ExpressionRuntime runtime,
                             ReportElement element)

Description copied from interface: ElementType

Compute a design-time value. This value will be displayed when editing the element in the Pentaho Report Designer. If there is not enough data available to produce a sensible output, return a mock-object so that the user can interact with the element in a sensible fashion.

When the element is called, all style and attribute expressions have been resolved and can be accessed via the normal static style and attribute accessor methods. If the content of your element depends on style information, the fully computed style must be retrieved via the .Element#getComputedStyle() method. The local style-sheet for the element may not have all information.

Parameters:

runtime - the expression runtime holding the current report state.

element - the element.

Returns:

the computed value.

configureDesignTimeDefaults

public void configureDesignTimeDefaults(ReportElement element,
                                        Locale locale)

Description copied from interface: ElementType

Compute the design-time defaults that should be applied to an element after it was created by a design-tool. Only declare explicit values. If you assume defaults when an attribute or style is undefined, then there is no need to set it here.

Any value set here will be treated as user-defined value afterwards and will be explicitly stored in the XML files.

Specified by:

configureDesignTimeDefaults in interface ElementType

Overrides:

configureDesignTimeDefaults in class AbstractElementType

Parameters:

element - the element that should be configured.

locale - the locale.