com.luciad.lucy.addons.print

LuciadLightspeedClass ALcyPrintableMapComponentFactory<M extends ILcyGenericMapComponent>

java.lang.Object

com.luciad.lucy.addons.print.ALcyPrintableMapComponentFactory<M>

Direct Known Subclasses:

ALcyPrintableComponentFactory, TLcyLspPrintableMapComponentFactory

public abstract class ALcyPrintableMapComponentFactory<M extends ILcyGenericMapComponent>
extends Object

Creates an AWT component meant for printing the contents of a map. It will typically return a component that contains the same data as the given map component, possibly decorated with a legend, overview, header text, ...

Since:

2013.0

See Also:

createPrintableComponent(M, com.luciad.lucy.util.TLcyProperties)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ALcyPrintableMapComponentFactory() Default constructor.

Method Summary

Modifier and Type	Method and Description
abstract TLcyPrintableMapComponent	createPrintableComponent(M aMapComponent, TLcyProperties aProperties) Creates a printable component for the given ILcyMapComponent.
abstract ILcyLucyEnv	getLucyEnv() Returns the associated lucy environment.
abstract void	setLucyEnv(ILcyLucyEnv aLucyEnv) Sets the associated lucy environment.

Methods inherited from class java.lang.Object

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

Constructor Detail

ALcyPrintableMapComponentFactory

protected ALcyPrintableMapComponentFactory()

Default constructor.

Method Detail

getLucyEnv

public abstract ILcyLucyEnv getLucyEnv()

Returns the associated lucy environment.

Returns:

the associated lucy environment.

See Also:

setLucyEnv(com.luciad.lucy.ILcyLucyEnv)

setLucyEnv

public abstract void setLucyEnv(ILcyLucyEnv aLucyEnv)

Sets the associated lucy environment.

Parameters:

aLucyEnv - The lucy environment.

See Also:

getLucyEnv()

createPrintableComponent

public abstract TLcyPrintableMapComponent createPrintableComponent(M aMapComponent,
                                                                   TLcyProperties aProperties)

Creates a printable component for the given ILcyMapComponent. It will typically return a component that contains the same data as the given map component, possibly decorated with a legend, overview, header text, ...

The parameter TLcyProperties contains a number of settings, which can be used while creating the TLcyPrintableMapComponent, for example to find out if an overview needs to be added or not. Furthermore, the TLcyPrintableMapComponent should update itself whenever applicable properties in aProperties are changed. What properties are applicable, depends on the implementation of this factory. It could for example show/hide the overview based on a boolean value of the properties object.

The keys and values that can be expected in aProperties are described in the various _KEY and _VALUE constants of TLcyPrintAddOn.

Parameters:

aMapComponent - The map component.

aProperties - The property node.

Returns:

the created printable component