Package net.sf.jasperreports.engine.component

Class ComponentsEnvironment

java.lang.Object

net.sf.jasperreports.engine.component.ComponentsEnvironment

public final class ComponentsEnvironment
extends Object

A class that provides access to component bundles.

Component bundles are registered as JasperReports extensions of type ComponentsBundle 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<ComponentsBundle>	findBundles()
Collection<ComponentsBundle>	getBundles()	Returns the set of all component bundles present in the registry.
protected List<ComponentsBundle>	getCachedBundles()
String	getComponentName(Class<? extends Component> componentType)
List<String>	getComponentNames()
static ComponentsEnvironment	getInstance(JasperReportsContext jasperReportsContext)
ComponentManager	getManager(Class<? extends Component> componentType)	Returns a component manager that corresponds to a particular component type.
ComponentManager	getManager(Component component)	Returns a component manager that corresponds to a particular component.

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 ComponentsEnvironment getInstance(JasperReportsContext jasperReportsContext)

getBundles

public Collection<ComponentsBundle> getBundles()

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

Returns:

the set of component bundles

getCachedBundles

protected List<ComponentsBundle> getCachedBundles()

findBundles

protected List<ComponentsBundle> findBundles()

getManager

public ComponentManager getManager(Component component)

Returns a component manager that corresponds to a particular component.

Parameters:

component - the component

Returns:

the manager for the component type

Throws:

JRRuntimeException - if the registry does not contain the specified component

getManager

public ComponentManager getManager(Class<? extends Component> componentType)

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

Parameters:

componentType - the component type

Returns:

the manager for the component type

Throws:

JRRuntimeException - if the registry does not contain the specified component

getComponentName

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

getComponentNames

public List<String> getComponentNames()