Package com.luciad.lucy.addons.print.lightspeed

Class TLcyLspPrintableMapComponentFactory

java.lang.Object

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

com.luciad.lucy.addons.print.lightspeed.TLcyLspPrintableMapComponentFactory

public class TLcyLspPrintableMapComponentFactory
extends ALcyPrintableMapComponentFactory<ILcyLspMapComponent>

Factory for the creation of printable java.awt.Components containing a Lightspeed view. This factory was designed so that it is easy to modify small parts of the creation process. This can be done by subclassing this class and overriding certain methods.

The main create function createPrintableComponent will first create all usable parts, eg. the map view, the header text, the scale icon,... using the functions createView and createComponent. Then it calls createPrintableComponentContent, which will create the content of the printable component using the created objects by calling getView and getComponent. And finally it will create the actual TLcyPrintableMapComponent.

ID's are used to identify different types of components that can be created: the legend, the scale icon, the footer/header text,... All possible ID's that can be passed to the createComponent method all end with the same suffix "component". The same thing goes for "view" in createView.

As an example, imagine you want to change the behaviour of the footer text. Browsing this class learns there is a FOOTER_TEXT_COMPONENT constant. Because it ends with "component", this constant can only be passed to the createComponent method. Therefore we can override the method createComponent, check if the ID is FOOTER_TEXT_COMPONENT and return a custom component instance. Or use super.createComponent and change some settings before returning it. If you want to remove the component completely, you can simply return null.

The method createPrintableComponent(com.luciad.lucy.map.lightspeed.ILcyLspMapComponent, com.luciad.lucy.util.TLcyProperties) should not be overridden without using the super function. Changing the layout of the TLcyPrintableMapComponent can be done by overriding createPrintableComponentContent(). The internal elements are already created and should be retrieved by calling getView(id) and getComponent(id).

Since:

2013.0

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CLASSIFICATION_COMPONENT	The id for creating the classification component
static final int	FOOTER_TEXT_COMPONENT	The id for creating the footer text component.
static final int	HEADER_TEXT_COMPONENT	The id for creating the header text component.
static final int	LEGEND_COMPONENT	The id for creating the legend component.
static final int	MAIN_VIEW	The id for creating the view of the current map component.
static final int	MODIFIABLE_HEADER_TEXT_COMPONENT	The id for creating the header text component which can be altered by the user in the UI.
static final int	OVERVIEW_VIEW	The id for creating the view of the current map overview component.
static final int	SCALE_ICON_COMPONENT	The id for creating the scale icon component.
static final int	SCALE_LABEL_COMPONENT	The id for creating the scale indication component.
static final int	TITLE_TEXT_COMPONENT	The id for creating the title text component.

Constructor Summary

Constructors

Constructor	Description
TLcyLspPrintableMapComponentFactory()	Default constructor.
TLcyLspPrintableMapComponentFactory(ILcyLucyEnv aLucyEnv)	Creates a new TLcyLspPrintableMapComponentFactory.

Method Summary

Modifier and Type	Method	Description
protected Component	createComponent(int aID, ILcyLspMapComponent aMapComponent, TLcyProperties aProperties)	Creates a java.awt.Component for the given ID.
TLcyPrintableMapComponent	createPrintableComponent(ILcyLspMapComponent aMapComponent, TLcyProperties aProperties)	This function will first create all internal components using createView and createComponent.
protected Component	createPrintableComponentContent(ILcyLspMapComponent aMapComponent, TLcyProperties aProperties)	Creates the content of the TLcyPrintableMapComponent.
protected ILcdView	createView(int aID, ILcyLspMapComponent aMapComponent, TLcyProperties aProperties)	Creates an ILcdView for the given ID.
protected Component	getComponent(int aID)	Returns the java.awt.Component for the given ID.
ILcyLucyEnv	getLucyEnv()	Returns the associated lucy environment.
protected ILcdView	getView(int aID)	Returns the ILcdView for the given ID.
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

Field Details

MAIN_VIEW

public static final int MAIN_VIEW

The id for creating the view of the current map component. For this ID, it is not allowed to return null.

See Also:

• Constant Field Values

OVERVIEW_VIEW

public static final int OVERVIEW_VIEW

The id for creating the view of the current map overview component.

See Also:

• Constant Field Values

LEGEND_COMPONENT

public static final int LEGEND_COMPONENT

The id for creating the legend component.

See Also:

• Constant Field Values

SCALE_ICON_COMPONENT

public static final int SCALE_ICON_COMPONENT

The id for creating the scale icon component.

See Also:

• Constant Field Values

SCALE_LABEL_COMPONENT

public static final int SCALE_LABEL_COMPONENT

The id for creating the scale indication component.

See Also:

• Constant Field Values

HEADER_TEXT_COMPONENT

public static final int HEADER_TEXT_COMPONENT

The id for creating the header text component.

See Also:

• Constant Field Values

FOOTER_TEXT_COMPONENT

public static final int FOOTER_TEXT_COMPONENT

The id for creating the footer text component.

See Also:

• Constant Field Values

TITLE_TEXT_COMPONENT

public static final int TITLE_TEXT_COMPONENT

The id for creating the title text component.

See Also:

• Constant Field Values

MODIFIABLE_HEADER_TEXT_COMPONENT

public static final int MODIFIABLE_HEADER_TEXT_COMPONENT

The id for creating the header text component which can be altered by the user in the UI.

Since:

2016.1.1

See Also:

• Constant Field Values

CLASSIFICATION_COMPONENT

public static final int CLASSIFICATION_COMPONENT

The id for creating the classification component

Since:

2016.1.1

See Also:

• Constant Field Values

Constructor Details

TLcyLspPrintableMapComponentFactory

public TLcyLspPrintableMapComponentFactory()

Default constructor. Creates a new TLcyLspPrintableMapComponentFactory. Note that you will have to set an ILcyLucyEnv before this instance can be used.

TLcyLspPrintableMapComponentFactory

public TLcyLspPrintableMapComponentFactory(ILcyLucyEnv aLucyEnv)

Creates a new TLcyLspPrintableMapComponentFactory.

Parameters:

aLucyEnv - The lucy environment, contextual information.

Method Details

getLucyEnv

public ILcyLucyEnv getLucyEnv()

Description copied from class: ALcyPrintableMapComponentFactory

Returns the associated lucy environment.

Specified by:

getLucyEnv in class ALcyPrintableMapComponentFactory<ILcyLspMapComponent>

Returns:

the associated lucy environment.

See Also:

• ALcyPrintableMapComponentFactory.setLucyEnv(com.luciad.lucy.ILcyLucyEnv)

setLucyEnv

public void setLucyEnv(ILcyLucyEnv aLucyEnv)

Description copied from class: ALcyPrintableMapComponentFactory

Sets the associated lucy environment.

Specified by:

setLucyEnv in class ALcyPrintableMapComponentFactory<ILcyLspMapComponent>

Parameters:

aLucyEnv - The lucy environment.

See Also:

• ALcyPrintableMapComponentFactory.getLucyEnv()

createPrintableComponent

public TLcyPrintableMapComponent createPrintableComponent(ILcyLspMapComponent aMapComponent,
 TLcyProperties aProperties)

This function will first create all internal components using createView and createComponent. Then it calls createPrintableComponentContent, which will create the content of the printable component using the internal components by calling getView and getComponent. And finally it will create the actual TLcyPrintableMapComponent.

Warning: Should not be overridden without calling the super function.

Specified by:

createPrintableComponent in class ALcyPrintableMapComponentFactory<ILcyLspMapComponent>

Parameters:

aMapComponent - The map component to use.

aProperties - The property node to use.

Returns:

the created printable component.

createPrintableComponentContent

protected Component createPrintableComponentContent(ILcyLspMapComponent aMapComponent,
 TLcyProperties aProperties)

Creates the content of the TLcyPrintableMapComponent. The methods getView(id) and getComponent(id) are used to safely retrieve the previously created objects. The retrieved components are layed out in for example a javax.swing.JPanel. This function should be overridden when you want to change the layout of the TLcyPrintableMapComponent.

If you would like to put components on the map (for example a legend), a JLayeredPane can be useful to overlay them.

Parameters:

aMapComponent - The map component to use.

aProperties - The property node to use.

Returns:

the created content.

createView

protected ILcdView createView(int aID,
 ILcyLspMapComponent aMapComponent,
 TLcyProperties aProperties)

Creates an ILcdView for the given ID.

The return value for the MAIN_VIEW constant must not be null.

Parameters:

aID - The id describing which view to create. This is a constant that ends in VIEW.

aMapComponent - The map component to use.

aProperties - The property node to use.

Returns:

The newly created ILcdView, or null. null is however not returned for the MAIN_VIEW constant.

getView

protected ILcdView getView(int aID)

Returns the ILcdView for the given ID.

Parameters:

aID - The id describing which view to create. This is a constant that ends in VIEW.

Returns:

the ILcdView for the given ID.

createComponent

protected Component createComponent(int aID,
 ILcyLspMapComponent aMapComponent,
 TLcyProperties aProperties)

Creates a java.awt.Component for the given ID.

The map component is provided as contextual information, and could for example be used to build a legend.

The properties can be used to tweak the component creation. For example when the legend is created (see LEGEND_COMPONENT), null is returned if the value of TLcyPrintAddOn.LEGEND_VISIBLE_KEY is false. If the value of TLcyPrintAddOn.LEGEND_SELECTED_KEY changes (even after the component is returned), the legend will toggle its visibility. One can detect changes in the given aProperties by using ALcyProperties.addPropertyChangeListener(java.beans.PropertyChangeListener).

Parameters:

aID - The id describing which component to create. This is a constant that ends in COMPONENT.

aMapComponent - The map component, provided as contextual information.

aProperties - The property node.

Returns:

The newly created java.awt.Component, or null.

getComponent

protected Component getComponent(int aID)

Returns the java.awt.Component for the given ID.

Parameters:

aID - The id describing which component to create. This is a constant that ends in COMPONENT.

Returns:

the java.awt.Component for the given ID.