Package net.sf.jasperreports.engine.base

Class JRBasePart

java.lang.Object

net.sf.jasperreports.engine.base.JRBasePart

All Implemented Interfaces:

Serializable, Cloneable, JRChangeEventsSupport, JRCloneable, JRIdentifiable, JRPart, JRPropertiesHolder

Direct Known Subclasses:

JRDesignPart

public class JRBasePart
extends Object
implements JRPart, Serializable, JRChangeEventsSupport

A read-only JRPart implementation which is included in compiled reports.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PartComponent	component
protected ComponentKey	componentKey
protected PartEvaluationTime	evaluationTime
protected JRExpression	partNameExpression
protected JRExpression	printWhenExpression
protected UUID	uuid

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JRBasePart()
	JRBasePart(JRPart part, JRBaseObjectFactory factory)

Method Summary

Modifier and Type	Method	Description
Object	clone()
PartComponent	getComponent()	Returns the component instance wrapped by this part.
ComponentKey	getComponentKey()	Returns the component type key for this part.
PartEvaluationTime	getEvaluationTime()	Determines the moment at which this part is to be evaluated.
JRPropertyChangeSupport	getEventSupport()	Returns the property change support object for this instance.
JRPropertiesHolder	getParentProperties()	Returns the parent properties holder, whose properties are used as defaults for this object.
JRExpression	getPartNameExpression()
JRExpression	getPrintWhenExpression()	Returns the boolean expression that specifies if the part will be displayed.
JRPropertiesMap	getPropertiesMap()	Returns this object's properties map.
JRPropertyExpression[]	getPropertyExpressions()	Returns the list of dynamic/expression-based properties for this report part.
UUID	getUUID()
boolean	hasProperties()	Checks whether the object has any properties.

Methods inherited from class java.lang.Object

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

Field Detail

uuid

protected UUID uuid

printWhenExpression

protected JRExpression printWhenExpression

partNameExpression

protected JRExpression partNameExpression

componentKey

protected ComponentKey componentKey

component

protected PartComponent component

evaluationTime

protected PartEvaluationTime evaluationTime

Constructor Detail

JRBasePart

protected JRBasePart()

JRBasePart

public JRBasePart(JRPart part,
                  JRBaseObjectFactory factory)

Method Detail

getUUID

public UUID getUUID()

Specified by:

getUUID in interface JRIdentifiable

getComponent

public PartComponent getComponent()

Description copied from interface: JRPart

Returns the component instance wrapped by this part.

Specified by:

getComponent in interface JRPart

Returns:

the component instance

getComponentKey

public ComponentKey getComponentKey()

Description copied from interface: JRPart

Returns the component type key for this part.

The component type key needs to be set in order to locate the component manager.

Specified by:

getComponentKey in interface JRPart

Returns:

the component type key

getEvaluationTime

public PartEvaluationTime getEvaluationTime()

Description copied from interface: JRPart

Determines the moment at which this part is to be evaluated.

Specified by:

getEvaluationTime in interface JRPart

Returns:

the evaluation time of this part

getPrintWhenExpression

public JRExpression getPrintWhenExpression()

Description copied from interface: JRPart

Returns the boolean expression that specifies if the part will be displayed.

Specified by:

getPrintWhenExpression in interface JRPart

getPartNameExpression

public JRExpression getPartNameExpression()

Specified by:

getPartNameExpression in interface JRPart

hasProperties

public boolean hasProperties()

Description copied from interface: JRPropertiesHolder

Checks whether the object has any properties.

Specified by:

hasProperties in interface JRPropertiesHolder

Returns:

whether the object has any properties

getPropertiesMap

public JRPropertiesMap getPropertiesMap()

Description copied from interface: JRPropertiesHolder

Returns this object's properties map.

Specified by:

getPropertiesMap in interface JRPropertiesHolder

Returns:

this object's properties map

getParentProperties

public JRPropertiesHolder getParentProperties()

Description copied from interface: JRPropertiesHolder

Returns the parent properties holder, whose properties are used as defaults for this object.

Specified by:

getParentProperties in interface JRPropertiesHolder

Returns:

the parent properties holder, or null if no parent

getPropertyExpressions

public JRPropertyExpression[] getPropertyExpressions()

Description copied from interface: JRPart

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

Specified by:

getPropertyExpressions in interface JRPart

Returns:

an array containing the expression-based properties of this report part

getEventSupport

public JRPropertyChangeSupport getEventSupport()

Description copied from interface: JRChangeEventsSupport

Returns the property change support object for this instance.

Specified by:

getEventSupport in interface JRChangeEventsSupport

Returns:

the property change support object for this instance

clone

public Object clone()

Specified by:

clone in interface JRCloneable

Overrides:

clone in class Object