Package net.sf.jasperreports.engine.design

Class JRDesignScriptlet

java.lang.Object

net.sf.jasperreports.engine.base.JRBaseScriptlet

net.sf.jasperreports.engine.design.JRDesignScriptlet

All Implemented Interfaces:

Serializable, Cloneable, JRChangeEventsSupport, JRCloneable, JRPropertiesHolder, JRScriptlet

public class JRDesignScriptlet
extends JRBaseScriptlet

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_NAME
static final String	PROPERTY_PROPERTY_EXPRESSIONS
static final String	PROPERTY_VALUE_CLASS_NAME

Fields inherited from class net.sf.jasperreports.engine.base.JRBaseScriptlet

description, name, propertiesMap, PROPERTY_DESCRIPTION, valueClass, valueClassName, valueClassRealName

Fields inherited from interface net.sf.jasperreports.engine.JRScriptlet

SCRIPTLET_PARAMETER_NAME_SUFFIX

Constructor Summary

Constructors

Constructor	Description
JRDesignScriptlet()

Method Summary

Modifier and Type	Method	Description
void	addPropertyExpression(JRPropertyExpression propertyExpression)	Add a dynamic/expression-based property.
Object	clone()
JRPropertyExpression[]	getPropertyExpressions()	Returns the list of dynamic/expression-based properties for this scriptlet.
List<JRPropertyExpression>	getPropertyExpressionsList()	Returns the list of property expressions.
JRPropertyExpression	removePropertyExpression(String name)	Remove a property expression.
void	removePropertyExpression(JRPropertyExpression propertyExpression)	Remove a property expression.
void	setName(String name)
void	setValueClass(Class<?> clazz)
void	setValueClassName(String className)

Methods inherited from class net.sf.jasperreports.engine.base.JRBaseScriptlet

getDescription, getEventSupport, getName, getParentProperties, getPropertiesMap, getValueClass, getValueClassName, hasProperties, setDescription

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PROPERTY_NAME

public static final String PROPERTY_NAME

See Also:

• Constant Field Values

PROPERTY_VALUE_CLASS_NAME

public static final String PROPERTY_VALUE_CLASS_NAME

See Also:

• Constant Field Values

PROPERTY_PROPERTY_EXPRESSIONS

public static final String PROPERTY_PROPERTY_EXPRESSIONS

See Also:

• Constant Field Values

Constructor Details

JRDesignScriptlet

public JRDesignScriptlet()

Method Details

setName

public void setName(String name)

setValueClass

public void setValueClass(Class<?> clazz)

setValueClassName

public void setValueClassName(String className)

addPropertyExpression

public void addPropertyExpression(JRPropertyExpression propertyExpression)

Add a dynamic/expression-based property.

Parameters:

propertyExpression - the property to add

See Also:

• getPropertyExpressions()

removePropertyExpression

public void removePropertyExpression(JRPropertyExpression propertyExpression)

Remove a property expression.

Parameters:

propertyExpression - the property expression to remove

See Also:

• addPropertyExpression(JRPropertyExpression)

removePropertyExpression

public JRPropertyExpression removePropertyExpression(String name)

Remove a property expression.

Parameters:

name - the name of the property to remove

Returns:

the removed property expression (if found)

getPropertyExpressionsList

public List<JRPropertyExpression> getPropertyExpressionsList()

Returns the list of property expressions.

Returns:

the list of property expressions (JRPropertyExpression instances)

See Also:

• addPropertyExpression(JRPropertyExpression)

getPropertyExpressions

public JRPropertyExpression[] getPropertyExpressions()

Description copied from interface: JRScriptlet

Returns the list of dynamic/expression-based properties for this scriptlet.

Specified by:

getPropertyExpressions in interface JRScriptlet

Overrides:

getPropertyExpressions in class JRBaseScriptlet

Returns:

an array containing the expression-based properties of this scriptlet

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class JRBaseScriptlet