Package com.luciad.lucy.addons.print
Class 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:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract TLcyPrintableMapComponent
createPrintableComponent
(M aMapComponent, TLcyProperties aProperties) Creates a printable component for the givenILcyMapComponent
.abstract ILcyLucyEnv
Returns the associated lucy environment.abstract void
setLucyEnv
(ILcyLucyEnv aLucyEnv) Sets the associated lucy environment.
-
Constructor Details
-
ALcyPrintableMapComponentFactory
protected ALcyPrintableMapComponentFactory()Default constructor.
-
-
Method Details
-
getLucyEnv
Returns the associated lucy environment.- Returns:
- the associated lucy environment.
- See Also:
-
setLucyEnv
Sets the associated lucy environment.- Parameters:
aLucyEnv
- The lucy environment.- See Also:
-
createPrintableComponent
public abstract TLcyPrintableMapComponent createPrintableComponent(M aMapComponent, TLcyProperties aProperties) Creates a printable component for the givenILcyMapComponent
. 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 parameterTLcyProperties
contains a number of settings, which can be used while creating theTLcyPrintableMapComponent
, for example to find out if an overview needs to be added or not. Furthermore, theTLcyPrintableMapComponent
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 ofTLcyPrintAddOn
.- Parameters:
aMapComponent
- The map component.aProperties
- The property node.- Returns:
- the created printable component
-