Package net.sf.jasperreports.engine.part

Class PartComponentsEnvironment

java.lang.Object

net.sf.jasperreports.engine.part.PartComponentsEnvironment

public final class PartComponentsEnvironment
extends Object

A class that provides access to component bundles.

Component bundles are registered as JasperReports extensions of type PartComponentsBundle via the central extension framework (see ExtensionsEnvironment).

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXCEPTION_MESSAGE_KEY_COMPONENT_MANAGER_NOT_FOUND

Method Summary

Modifier and Type	Method	Description
protected List<PartComponentsBundle>	findBundles()
Collection<PartComponentsBundle>	getBundles()	Returns the set of all component bundles present in the registry.
protected List<PartComponentsBundle>	getCachedBundles()
String	getComponentName(Class<? extends PartComponent> componentType)
static PartComponentsEnvironment	getInstance(JasperReportsContext jasperReportsContext)
PartComponentManager	getManager(PartComponent component)	Returns a component manager that corresponds to a particular component type key.

Methods inherited from class java.lang.Object

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

Field Details

EXCEPTION_MESSAGE_KEY_COMPONENT_MANAGER_NOT_FOUND

public static final String EXCEPTION_MESSAGE_KEY_COMPONENT_MANAGER_NOT_FOUND

See Also:

• Constant Field Values

Method Details

getInstance

public static PartComponentsEnvironment getInstance(JasperReportsContext jasperReportsContext)

getBundles

public Collection<PartComponentsBundle> getBundles()

Returns the set of all component bundles present in the registry.

Returns:

the set of component bundles

getCachedBundles

protected List<PartComponentsBundle> getCachedBundles()

findBundles

protected List<PartComponentsBundle> findBundles()

getManager

public PartComponentManager getManager(PartComponent component)

Returns a component manager that corresponds to a particular component type key.

Parameters:

component - the component type key

Returns:

the manager for the component type

Throws:

JRRuntimeException - if the registry does not contain the specified component type

getComponentName

public String getComponentName(Class<? extends PartComponent> componentType)