Package com.luciad.lucy.map.lightspeed

Class TLcyLspMapComponentFactory

java.lang.Object

com.luciad.lucy.gui.ALcyGUIFactory<ILcyLspMapComponent>

com.luciad.lucy.map.lightspeed.TLcyLspMapComponentFactory

public class TLcyLspMapComponentFactory
extends ALcyGUIFactory<ILcyLspMapComponent>

Factory for the creation of Lightspeed map components. 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.

It uses the concept of an ALcyGUIFactory, allowing the users of this class to modify almost every part of the creation process.

Since:

2012.0

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALTITUDE_EXAGGERATION_FACTOR_ACTION	The ID for the createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the action to change the altitude exaggeration factor on the view.
static final int	AMBIENT_LIGHT_GRAPHICS_EFFECT	The ID for the ALspGraphicsEffect that represents ambient light.
static final int	ATMOSPHERE_GRAPHICS_EFFECT	The ID for the ALspGraphicsEffect that represents atmosphere.
static final int	CENTER_OVERLAY_PANEL	Constant for the center panel of the map component, which is also used as overlay panel, hovering over the map.
static final int	CENTER_SELECTION_ACTION	The ID for createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing an action which centers the view bounds on the current selection.
static final int	COPY_LAST_CLICKED_COORDINATE_ACTION	Constant for an action that copies the location of the last mouse click to the clip board in a WGS 84 reference.
static final int	COPY_POINT_COORDINATE_ACTION	Constant for an action that copies the location of the selected point to the clip board.
static final int	DELETE_SELECTION_ACTION	Constant for an action that deletes the selected objects from the ILcdModel they are contained in.
static final int	DIRECIONAL_LIGHT_GRAPHICS_EFFECT	The ID for the ALspGraphicsEffect that represents directional light.
static final int	EAST_PANEL	Constant for a panel, typically located at the east of the map.
static final int	EDIT_CURRENT_PROJECTION_ACTION	The ID for createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing an action which allows to change all the projection settings through a UI.
static final int	EDIT_MAP_COMPONENT_ACTION	Constant for an action to edit certain properties of the map, such as the name and visibility of toolbar, layer control and status bar.
static final int	ELLIPSOIDAL_EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable to enable the TLcdEllipsoidalEquidistantCylindrical projection.
static final int	EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable to enable the TLcdEquidistantCylindrical projection.
static final int	FIT_SELECTION_ACTION	The ID for createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing an action which fits the view bounds on the current selection.
static final int	FLICKER_CONTROLLER	The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the flicker controller for the view.
static final int	FLICKER_CONTROLLER_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for activating the swipe controller on an ILspView.
static final int	FOG_GRAPHICS_EFFECT	The ID for the ALspGraphicsEffect that represents fog.
static final int	FULL_SCREEN_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable to switch to full screen mode.
static final int	GEOCENTRIC_PROJECTION_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable to enable the TLcdGeocentricReference.
static final int	HEAD_LIGHT_GRAPHICS_EFFECT	The ID for the ALspGraphicsEffect that represents head light.
static final int	LAMBERT_AZIMUTHAL_EQUAL_AREA_PROJECTION_ACTIVE_SETTABLE	Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for lambert azimuthal equal area projection.
static final int	LAMBERT_CONFORMAL_PROJECTION_ACTIVE_SETTABLE	Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for lambert conformal projection.
static final int	LIGHTING_SETTINGS_ACTION	The ID for createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing an action which opens a panel to customize the lighting in Lucy.
static final int	LOGO_ICON_COMPONENT	The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the Luciad logo component.
static final int	MAGNIFIER_CONTROLLER	The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the magnifier controller for the view.
static final int	MAGNIFIER_CONTROLLER_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for activating the magnifier controller on an ILspView.
static final int	MAP_LAYER_CONTROL_COMPONENT	The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the layer control component.
static final String	MAP_TYPE_PROPERTY_NAME	The properties passed to this factory should contain the map type as well.
static final int	MENU_BAR_COMPONENT	The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the menubar component.
static final int	MERCATOR_PROJECTION_ACTIVE_SETTABLE	Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for mercator projection.
static final int	MOUSE_LOCATION_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing an active settable for showing the mouse location on the map.
static final int	MOUSE_LOCATION_COMPONENT	The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the mouse location component.
static final int	NAVIGATION_COMPONENT	Constant for a panel containing navigation controls.
static final int	NAVIGATION_COMPONENT_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable to toggle the Navigation Control Panel for an ILspView.
static final int	NORTH_PANEL	Constant for a panel, typically located at the north of the map.
static final int	ON_MAP_ACTION_BAR	The ID for the createToolBar(int, ALcyProperties) method, representing the on map action bar of the map component.
static final int	ON_MAP_ACTION_BAR_COMPONENT	The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the on map action bar component.
static final int	OPEN_FILE_ACTION	Constant for an action to load a file from disk using the handleDataSources method of the TLcyDataFormatManager.
static final int	ORTOGRAPHIC_PROJECTION_ACTIVE_SETTABLE	Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for orthographic projection.
static final int	PAN_CONTROLLER	The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the navigation controller for the view.
static final int	PAN_CONTROLLER_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing an active settable for activating the navigation controller on an ILspView.
static final int	PAN_TOUCH_CONTROLLER	The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the touch navigation controller for the view.
static final int	PAN_TOUCH_CONTROLLER_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for activating the touch navigation controller on an ILspView.
static final int	POLAR_STEREOGRAPHIC_NORTH_PROJECTION_ACTIVE_SETTABLE	Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for north polar stereographic projection.
static final int	POLAR_STEREOGRAPHIC_SOUTH_PROJECTION_ACTIVE_SETTABLE	Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for south polar stereographic projection.
static final int	PORTHOLE_CONTROLLER	The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the porthole controller for the view.
static final int	PORTHOLE_CONTROLLER_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for activating the porthole controller on an ILspView.
static final int	PROJECTION_ACTION	The ID for createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing an action to select the view's projection.
static final int	PSEUDO_MERCATOR_PROJECTION_ACTIVE_SETTABLE	Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for pseudo mercator projection
static final int	RIGHT_TOOL_BAR	The ID for the createToolBar(int, ALcyProperties) method, representing the right tool bar of the map component.
static final int	RIGHT_TOOL_BAR_COMPONENT	The ID for createComponent(int, ALcyProperties) method representing the right toolbar component.
static final int	RULER_CONTROLLER	The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the ruler controller for the view.
static final int	RULER_CONTROLLER_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for activating the ruler controller on an ILspView.
static final int	SAVE_AS_FILE_ACTION	Constant for an action to save the ILcdModel of an ILspLayer of choice to a file.
static final int	SAVE_LAYER_ACTION	Constant for an action to save the style settings of an ILspLayer of choice to a file.
static final int	SAVE_LAYER_AS_ACTION	Constant for an action to save the style settings of an ILspLayer of choice to a file.
static final int	SAVE_TO_FILE_ACTION	Constant for an action to save the ILcdModel of an ILspLayer of choice to a file.
static final int	SAVE_VIEW_AS_IMAGE_ACTION	The ID for createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing an action which saves the view as an image.
static final int	SCALE_ICON_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for showing the scale on a map of an ILspView.
static final int	SCALE_ICON_COMPONENT	The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the scale icon component.
static final int	SCALE_SELECTION_ACTION	The ID for createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the scale selection action.
static final int	SELECTION_PAN_CONTROLLER	The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the selection controller for the view.
static final int	SELECTION_PAN_CONTROLLER_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing an active settable for activating the selection controller on an ILspView.
static final int	SELECTION_PAN_TOUCH_CONTROLLER	The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the touch selection controller for the view.
static final int	SELECTION_PAN_TOUCH_CONTROLLER_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for activating the touch selection controller on an ILspView.
static final int	SOUTH_PANEL	Constant for a panel, typically located at the south of the map.
static final int	STATUS_BAR	The ID for the createToolBar(int, ALcyProperties) method, representing the status bar of the map component.
static final int	STATUS_BAR_COMPONENT	The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the status bar component.
static final int	STEREOGRAPHIC_PROJECTION_ACTIVE_SETTABLE	Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for stereographic projection.
static final int	SWIPE_CONTROLLER	The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the swipe controller for the view.
static final int	SWIPE_CONTROLLER_ACTIVE_SETTABLE	The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for activating the swipe controller on an ILspView.
static final int	TOOL_BAR	The ID for the createToolBar(int, ALcyProperties) method, representing the tool bar of the map component.
static final int	TOOL_BAR_COMPONENT	The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the toolbar component.
static final int	TRANSVERSE_MERCATOR_PROJECTION_ACTIVE_SETTABLE	Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for transverse mercator projection.
static final int	WEST_PANEL	Constant for a panel, typically located at the west of the map.

Constructor Summary

Constructors

Constructor	Description
TLcyLspMapComponentFactory(ILcyLucyEnv aLucyEnv)	Creates a new map component factory for the specified Lucy environment.

Method Summary

Modifier and Type	Method	Description
protected void	cleanup(ALcyProperties aProperties)	Performs cleanup operations, such as nullifying fields that are no longer needed.
protected ILcdAction	createAction(int aActionID, ALcyProperties aProperties)	Creates an ILcdAction for the given ID.
protected ILcyActiveSettable	createActiveSettable(int aActiveSettableID, ALcyProperties aProperties)	Creates an ILcyActiveSettable for the given ID.
protected ALcdBalloonManager	createBalloonManager(ALcyProperties aProperties)	Creates the balloon manager for the map component under construction.
protected Component	createComponent(int aComponentID, ALcyProperties aProperties)	Creates a widget for the given ID.
protected ILspController	createController(int aControllerID, ALcyProperties aProperties)	Create the controller for the ID aControllerID.
ALspGraphicsEffect	createGraphicsEffect(int aID, ALcyProperties aProperties)	Creates the graphics effects for the given id.
protected ILcyLspMapComponent	createGUIContent(ALcyProperties aProperties)	Retrieves all panels and lays them out in a java.awt.Component.
protected ILcdInitialLayerIndexProvider	createInitialLayerIndexProvider(ALcyProperties aProperties)	Creates a initial layer index provider for this map component.
protected TLcyLspMapComponent	createMapComponent(ALcyProperties aProperties)	Creates a new map component.
protected TLcyLspMapLayerControl	createMapLayerControl(ALcyProperties aProperties)	Create a new map layer control.
protected String	createMapName(ALcyProperties aProperties)	Creates a map name for the given map.
protected ILcyMenuBar	createMenuBar(ALcyProperties aProperties)	Create a new menu bar.
protected Component	createPanel(int aPanelID, ALcyProperties aProperties)	Creates a panel for the given ID.
protected ILcyPopupMenu	createPopupMenu(ALcyProperties aProperties)	Create a new pop up menu.
protected ILcyToolBar	createToolBar(int aToolBarID, ALcyProperties aProperties)	Creates an ILcyToolBar for the given ID.
protected ILspView	createView(ALcyProperties aProperties)	Creates a new view.
protected TLspViewBuilder	createViewBuilder(ALcyProperties aProperties)	This method is called by the default implementation of createView(ALcyProperties) and is responsible for creating the TLspViewBuilder which will be used in the createView method to create the Lightspeed view.
protected Object	getActionContext(int aActionID, ALcyProperties aProperties)	Returns the context of the action bars in which the action with the specified ID should be inserted.
protected Object	getActiveSettableContext(int aActiveSettableID, ALcyProperties aProperties)	Returns the context of the action bars in which the active settable with the specified ID should be inserted.
ALcdBalloonManager	getBalloonManager()	Returns the created balloon manager.
protected final ILspController	getController(int aControllerID)	Returns the created controller corresponding to the ID aControllerID.
protected ILcdIntList	getControllerIDs()	Returns the list with all controller IDs.
List<ALspGraphicsEffect>	getGraphicsEffects()	Returns the list of created graphics effects
protected final ILcdInitialLayerIndexProvider	getInitialLayerIndexProvider()	Returns the created initial layer index provider.
protected final TLcyLspMapComponent	getMapComponent()	Returns the created map component
protected final TLcyLspMapLayerControl	getMapLayerControl()	Returns the created map layer control
TLcyLspMapLayerControlFactory	getMapLayerControlFactory()	Returns the factory used to create the map layer control.
protected final ILcyMenuBar	getMenuBar()	Returns the created menu bar
protected final ILcyPopupMenu	getPopupMenu()	Returns the created map popup menu.
protected final ILcyToolBar	getToolBar(int aToolBarID)	Returns the ILcyToolBar for the given ID.
protected ILcdIntList	getToolBarIDs()	Returns the list with all toolbar IDs.
protected final ILspView	getView()	Returns the created view
protected boolean	isActiveSettableDeactivatePossible(int aActiveSettableID, ALcyProperties aProperties)	Returns whether the active settable can be deactivated or not through the action bar in which it is inserted.
void	setMapLayerControlFactory(TLcyLspMapLayerControlFactory aMapLayerControlFactory)	Set the factory which will be used to create the map layer control.
protected void	setup(ALcyProperties aProperties)	This method overrides the default behavior of the ALcyGUIFactory.setup(com.luciad.lucy.util.properties.ALcyProperties) method.

Methods inherited from class com.luciad.lucy.gui.ALcyGUIFactory

createGUI, getAction, getActionIDs, getActiveSettable, getActiveSettableIDs, getComponent, getComponentIDs, getLucyEnv, getPanel, getPanelIDs

Methods inherited from class java.lang.Object

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

Field Details

MAP_TYPE_PROPERTY_NAME

public static final String MAP_TYPE_PROPERTY_NAME

The properties passed to this factory should contain the map type as well. This constant defines the key that should be used for this property.

See Also:

• Constant Field Values

NORTH_PANEL

public static final int NORTH_PANEL

Constant for a panel, typically located at the north of the map.

By default, it contains the tool bar and the right tool bar.

See Also:

• ILcyGenericMapComponent.getToolBar()
• Constant Field Values

SOUTH_PANEL

public static final int SOUTH_PANEL

Constant for a panel, typically located at the south of the map.

By default, it contains the status bar.

See Also:

• ILcyGenericMapComponent.getStatusBar()
• Constant Field Values

EAST_PANEL

public static final int EAST_PANEL

Constant for a panel, typically located at the east of the map.

By default, it contains nothing.

See Also:

• Constant Field Values

WEST_PANEL

public static final int WEST_PANEL

Constant for a panel, typically located at the west of the map.

By default, it contains nothing.

See Also:

• Constant Field Values

CENTER_OVERLAY_PANEL

public static final int CENTER_OVERLAY_PANEL

Constant for the center panel of the map component, which is also used as overlay panel, hovering over the map.

The creation of this panel should not be overridden.

See Also:

• createView(com.luciad.lucy.util.properties.ALcyProperties)
• TLcdOverlayLayout
• ILcyGenericMapComponent.getMapOverlayPanel()
• Constant Field Values

OPEN_FILE_ACTION

public static final int OPEN_FILE_ACTION

Constant for an action to load a file from disk using the handleDataSources method of the TLcyDataFormatManager.

By default, it is added as the 'File|Open' menu item.

See Also:

• TLcyDataFormatManager.handleDataSources(String[], com.luciad.lucy.map.ILcyGenericMapComponent, com.luciad.lucy.model.ALcyFileTypeDescriptor, java.awt.Component)
• Constant Field Values

SAVE_TO_FILE_ACTION

public static final int SAVE_TO_FILE_ACTION

Constant for an action to save the ILcdModel of an ILspLayer of choice to a file. It does so by using the ILcdModelEncoder that is registered to the ILcdModel.

By default, it is added as the 'File|Save' menu item.

See Also:

• Constant Field Values

SAVE_AS_FILE_ACTION

public static final int SAVE_AS_FILE_ACTION

Constant for an action to save the ILcdModel of an ILspLayer of choice to a file. It does so by using the ILcdModelEncoders that are registered to ILcyLucyEnv.

By default, it is added as the 'File|Save As...' menu item.

See Also:

• TLcyCompositeModelEncoder
• Constant Field Values

EDIT_MAP_COMPONENT_ACTION

public static final int EDIT_MAP_COMPONENT_ACTION

Constant for an action to edit certain properties of the map, such as the name and visibility of toolbar, layer control and status bar.

By default, it is added as the 'Edit|Map Properties' menu item.

See Also:

• Constant Field Values

SAVE_LAYER_ACTION

public static final int SAVE_LAYER_ACTION

Constant for an action to save the style settings of an ILspLayer of choice to a file. It does so by using the ILcyLayerStyleEncoders that are registered as a service on the Lucy backend.

By default, it is added as the 'File|Save Layer Style' menu item.

See Also:

• ILcyLayerStyleCodec.encode(com.luciad.view.ILcdLayer, com.luciad.lucy.map.ILcyLayerStyle, java.io.OutputStream)
• Constant Field Values

SAVE_LAYER_AS_ACTION

public static final int SAVE_LAYER_AS_ACTION

Constant for an action to save the style settings of an ILspLayer of choice to a file. It does so by using the ILcyLayerStyleEncoders that are registered as a service on the Lucy backend.

By default, it is added as the 'File|Save Layer Style As' menu item.

See Also:

• ILcyLayerStyleCodec.encode(com.luciad.view.ILcdLayer, com.luciad.lucy.map.ILcyLayerStyle, java.io.OutputStream)
• Constant Field Values

DELETE_SELECTION_ACTION

public static final int DELETE_SELECTION_ACTION

Constant for an action that deletes the selected objects from the ILcdModel they are contained in. The action is enabled if the layer is editable, and if ILcdModel.canRemoveElement returns true.

By default, it is added to the right click menu of the select controller.

See Also:

• Constant Field Values

COPY_POINT_COORDINATE_ACTION

public static final int COPY_POINT_COORDINATE_ACTION

Constant for an action that copies the location of the selected point to the clip board. The coordinate system (model reference) is the native reference of that point. An exception is when ILcyLucyEnv.getDefaultModelReference() returns a non-null value: the specified reference is than used.

By default, it is added to the right click menu of the select controller.

See Also:

• Constant Field Values

COPY_LAST_CLICKED_COORDINATE_ACTION

public static final int COPY_LAST_CLICKED_COORDINATE_ACTION

Constant for an action that copies the location of the last mouse click to the clip board in a WGS 84 reference. An exception is when ILcyLucyEnv.getDefaultModelReference() returns a non-null value: the specified reference is than used, consistent with how the coordinate read-out on the map behaves.

When a point is selected, the action disables itself to avoid confusing the user. Note that when this is the case, COPY_POINT_COORDINATE_ACTION will be enabled.

By default, it is added to the right click menu of the select controller.

See Also:

• Constant Field Values

ALTITUDE_EXAGGERATION_FACTOR_ACTION

public static final int ALTITUDE_EXAGGERATION_FACTOR_ACTION

The ID for the createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the action to change the altitude exaggeration factor on the view.

See Also:

• createAction(int, com.luciad.lucy.util.properties.ALcyProperties)
• ILspView.setAltitudeExaggerationFactor(double)
• Constant Field Values

SCALE_SELECTION_ACTION

public static final int SCALE_SELECTION_ACTION

The ID for createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the scale selection action. The default action will be shown as a combobox when inserted in an ILcyToolbar. Otherwise, triggering the action will show a dialog containing the combobox.

See Also:

• createComponent(int, ALcyProperties)
• Constant Field Values

SAVE_VIEW_AS_IMAGE_ACTION

public static final int SAVE_VIEW_AS_IMAGE_ACTION

The ID for createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing an action which saves the view as an image.

See Also:

• Constant Field Values

FIT_SELECTION_ACTION

public static final int FIT_SELECTION_ACTION

The ID for createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing an action which fits the view bounds on the current selection.

See Also:

• Constant Field Values

CENTER_SELECTION_ACTION

public static final int CENTER_SELECTION_ACTION

The ID for createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing an action which centers the view bounds on the current selection.

See Also:

• Constant Field Values

EDIT_CURRENT_PROJECTION_ACTION

public static final int EDIT_CURRENT_PROJECTION_ACTION

The ID for createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing an action which allows to change all the projection settings through a UI.

See Also:

• Constant Field Values

PROJECTION_ACTION

public static final int PROJECTION_ACTION

The ID for createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing an action to select the view's projection. The default action will be shown as a combobox when inserted in an ILcyToolbar. Otherwise, triggering the action will show a dialog containing the combobox. The projections to choose from are the actions that are configured to be inserted into the "projectionBar" action bar.

See Also:

• Constant Field Values

LIGHTING_SETTINGS_ACTION

public static final int LIGHTING_SETTINGS_ACTION

The ID for createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method representing an action which opens a panel to customize the lighting in Lucy.

See Also:

• Constant Field Values

AMBIENT_LIGHT_GRAPHICS_EFFECT

public static final int AMBIENT_LIGHT_GRAPHICS_EFFECT

The ID for the ALspGraphicsEffect that represents ambient light.

See Also:

• Constant Field Values

HEAD_LIGHT_GRAPHICS_EFFECT

public static final int HEAD_LIGHT_GRAPHICS_EFFECT

The ID for the ALspGraphicsEffect that represents head light.

See Also:

• Constant Field Values

DIRECIONAL_LIGHT_GRAPHICS_EFFECT

public static final int DIRECIONAL_LIGHT_GRAPHICS_EFFECT

The ID for the ALspGraphicsEffect that represents directional light.

See Also:

• Constant Field Values

FOG_GRAPHICS_EFFECT

public static final int FOG_GRAPHICS_EFFECT

The ID for the ALspGraphicsEffect that represents fog.

See Also:

• Constant Field Values

ATMOSPHERE_GRAPHICS_EFFECT

public static final int ATMOSPHERE_GRAPHICS_EFFECT

The ID for the ALspGraphicsEffect that represents atmosphere.

See Also:

• Constant Field Values

SELECTION_PAN_CONTROLLER

public static final int SELECTION_PAN_CONTROLLER

The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the selection controller for the view.

See Also:

• createController(int, com.luciad.lucy.util.properties.ALcyProperties)
• Constant Field Values

PAN_CONTROLLER

public static final int PAN_CONTROLLER

The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the navigation controller for the view.

See Also:

• createController(int, com.luciad.lucy.util.properties.ALcyProperties)
• Constant Field Values

RULER_CONTROLLER

public static final int RULER_CONTROLLER

The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the ruler controller for the view.

See Also:

• createController(int, com.luciad.lucy.util.properties.ALcyProperties)
• Constant Field Values

SELECTION_PAN_TOUCH_CONTROLLER

public static final int SELECTION_PAN_TOUCH_CONTROLLER

The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the touch selection controller for the view.

See Also:

• Constant Field Values

PAN_TOUCH_CONTROLLER

public static final int PAN_TOUCH_CONTROLLER

The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the touch navigation controller for the view.

See Also:

• Constant Field Values

SWIPE_CONTROLLER

public static final int SWIPE_CONTROLLER

The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the swipe controller for the view.

Since:

2016.0

See Also:

• Constant Field Values

FLICKER_CONTROLLER

public static final int FLICKER_CONTROLLER

The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the flicker controller for the view.

Since:

2016.0

See Also:

• Constant Field Values

PORTHOLE_CONTROLLER

public static final int PORTHOLE_CONTROLLER

The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the porthole controller for the view.

Since:

2016.0

See Also:

• Constant Field Values

MAGNIFIER_CONTROLLER

public static final int MAGNIFIER_CONTROLLER

The ID for the createController(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing the magnifier controller for the view.

Since:

2020.0

See Also:

• Constant Field Values

TOOL_BAR_COMPONENT

public static final int TOOL_BAR_COMPONENT

The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the toolbar component. It typically is ILcyToolBar.getComponent().

See Also:

• createComponent(int, ALcyProperties)
• Constant Field Values

MENU_BAR_COMPONENT

public static final int MENU_BAR_COMPONENT

The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the menubar component. It typically is ILcyMenuBar.getComponent().

See Also:

• createComponent(int, ALcyProperties)
• Constant Field Values

MAP_LAYER_CONTROL_COMPONENT

public static final int MAP_LAYER_CONTROL_COMPONENT

The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the layer control component.

See Also:

• createComponent(int, ALcyProperties)
• Constant Field Values

STATUS_BAR_COMPONENT

public static final int STATUS_BAR_COMPONENT

The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the status bar component. It typically is ILcyToolBar.getComponent().

See Also:

• createComponent(int, ALcyProperties)
• Constant Field Values

NAVIGATION_COMPONENT

public static final int NAVIGATION_COMPONENT

Constant for a panel containing navigation controls.

It's usually added to the main view as an overlay.

See Also:

• createComponent(int, ALcyProperties)
• Constant Field Values

ON_MAP_ACTION_BAR_COMPONENT

public static final int ON_MAP_ACTION_BAR_COMPONENT

The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the on map action bar component. It typically is ILcyToolBar.getComponent().

See Also:

• createComponent(int, ALcyProperties)
• Constant Field Values

SCALE_ICON_COMPONENT

public static final int SCALE_ICON_COMPONENT

The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the scale icon component. By default, it is located at the bottom right of the main view.

See Also:

• createComponent(int, ALcyProperties)
• Constant Field Values

MOUSE_LOCATION_COMPONENT

public static final int MOUSE_LOCATION_COMPONENT

The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the mouse location component. By default, it is located at the bottom center of the main view.

See Also:

• createComponent(int, com.luciad.lucy.util.properties.ALcyProperties)
• Constant Field Values

LOGO_ICON_COMPONENT

public static final int LOGO_ICON_COMPONENT

The ID for createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method representing the Luciad logo component. By default, it is located at the lower left of the main view.

See Also:

• createComponent(int, com.luciad.lucy.util.properties.ALcyProperties)
• Constant Field Values

RIGHT_TOOL_BAR_COMPONENT

public static final int RIGHT_TOOL_BAR_COMPONENT

The ID for createComponent(int, ALcyProperties) method representing the right toolbar component. It typically is ILcyToolBar.getComponent().

Since:

2016.0

See Also:

• createComponent(int, ALcyProperties)
• Constant Field Values

SELECTION_PAN_CONTROLLER_ACTIVE_SETTABLE

public static final int SELECTION_PAN_CONTROLLER_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing an active settable for activating the selection controller on an ILspView.

By default, it is added on the map tool bar, and in the menu bar.

See Also:

• SELECTION_PAN_CONTROLLER
• createActiveSettable(int, ALcyProperties)
• Constant Field Values

PAN_CONTROLLER_ACTIVE_SETTABLE

public static final int PAN_CONTROLLER_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing an active settable for activating the navigation controller on an ILspView.

By default, it is added on the map tool bar, and in the menu bar.

See Also:

• PAN_CONTROLLER
• createActiveSettable(int, ALcyProperties)
• Constant Field Values

RULER_CONTROLLER_ACTIVE_SETTABLE

public static final int RULER_CONTROLLER_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for activating the ruler controller on an ILspView.

By default, it is added on the map tool bar, and in the menu bar.

See Also:

• RULER_CONTROLLER
• createActiveSettable(int, ALcyProperties)
• Constant Field Values

SELECTION_PAN_TOUCH_CONTROLLER_ACTIVE_SETTABLE

public static final int SELECTION_PAN_TOUCH_CONTROLLER_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for activating the touch selection controller on an ILspView.

See Also:

• SELECTION_PAN_TOUCH_CONTROLLER
• createActiveSettable(int, ALcyProperties)
• Constant Field Values

PAN_TOUCH_CONTROLLER_ACTIVE_SETTABLE

public static final int PAN_TOUCH_CONTROLLER_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for activating the touch navigation controller on an ILspView.

See Also:

• PAN_TOUCH_CONTROLLER
• createActiveSettable(int, ALcyProperties)
• Constant Field Values

SWIPE_CONTROLLER_ACTIVE_SETTABLE

public static final int SWIPE_CONTROLLER_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for activating the swipe controller on an ILspView.

By default, it is added in the menu bar.

Since:

2016.0

See Also:

• SWIPE_CONTROLLER
• createActiveSettable(int, ALcyProperties)
• Constant Field Values

FLICKER_CONTROLLER_ACTIVE_SETTABLE

public static final int FLICKER_CONTROLLER_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for activating the swipe controller on an ILspView.

By default, it is added in the menu bar.

Since:

2016.0

See Also:

• FLICKER_CONTROLLER
• createActiveSettable(int, ALcyProperties)
• Constant Field Values

PORTHOLE_CONTROLLER_ACTIVE_SETTABLE

public static final int PORTHOLE_CONTROLLER_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for activating the porthole controller on an ILspView.

By default, it is added in the menu bar.

Since:

2016.0

See Also:

• PORTHOLE_CONTROLLER
• createActiveSettable(int, ALcyProperties)
• Constant Field Values

MAGNIFIER_CONTROLLER_ACTIVE_SETTABLE

public static final int MAGNIFIER_CONTROLLER_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for activating the magnifier controller on an ILspView.

By default, it is added in the menu bar.

Since:

2020.0

See Also:

• MAGNIFIER_CONTROLLER
• createActiveSettable(int, ALcyProperties)
• Constant Field Values

NAVIGATION_COMPONENT_ACTIVE_SETTABLE

public static final int NAVIGATION_COMPONENT_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable to toggle the Navigation Control Panel for an ILspView.

See Also:

• Constant Field Values

FULL_SCREEN_ACTIVE_SETTABLE

public static final int FULL_SCREEN_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable to switch to full screen mode.

See Also:

• Constant Field Values

GEOCENTRIC_PROJECTION_ACTIVE_SETTABLE

public static final int GEOCENTRIC_PROJECTION_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable to enable the TLcdGeocentricReference. Mostly referred to as 3D.

See Also:

• Constant Field Values

EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE

public static final int EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable to enable the TLcdEquidistantCylindrical projection.

See Also:

• Constant Field Values

ORTOGRAPHIC_PROJECTION_ACTIVE_SETTABLE

public static final int ORTOGRAPHIC_PROJECTION_ACTIVE_SETTABLE

Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for orthographic projection.

See Also:

• Constant Field Values

STEREOGRAPHIC_PROJECTION_ACTIVE_SETTABLE

public static final int STEREOGRAPHIC_PROJECTION_ACTIVE_SETTABLE

Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for stereographic projection.

See Also:

• Constant Field Values

MERCATOR_PROJECTION_ACTIVE_SETTABLE

public static final int MERCATOR_PROJECTION_ACTIVE_SETTABLE

Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for mercator projection.

See Also:

• Constant Field Values

PSEUDO_MERCATOR_PROJECTION_ACTIVE_SETTABLE

public static final int PSEUDO_MERCATOR_PROJECTION_ACTIVE_SETTABLE

Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for pseudo mercator projection

See Also:

• Constant Field Values

TRANSVERSE_MERCATOR_PROJECTION_ACTIVE_SETTABLE

public static final int TRANSVERSE_MERCATOR_PROJECTION_ACTIVE_SETTABLE

Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for transverse mercator projection.

See Also:

• Constant Field Values

LAMBERT_CONFORMAL_PROJECTION_ACTIVE_SETTABLE

public static final int LAMBERT_CONFORMAL_PROJECTION_ACTIVE_SETTABLE

Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for lambert conformal projection.

See Also:

• Constant Field Values

LAMBERT_AZIMUTHAL_EQUAL_AREA_PROJECTION_ACTIVE_SETTABLE

public static final int LAMBERT_AZIMUTHAL_EQUAL_AREA_PROJECTION_ACTIVE_SETTABLE

Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for lambert azimuthal equal area projection.

See Also:

• Constant Field Values

POLAR_STEREOGRAPHIC_NORTH_PROJECTION_ACTIVE_SETTABLE

public static final int POLAR_STEREOGRAPHIC_NORTH_PROJECTION_ACTIVE_SETTABLE

Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for north polar stereographic projection.

See Also:

• Constant Field Values

POLAR_STEREOGRAPHIC_SOUTH_PROJECTION_ACTIVE_SETTABLE

public static final int POLAR_STEREOGRAPHIC_SOUTH_PROJECTION_ACTIVE_SETTABLE

Similar to EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE, but for south polar stereographic projection.

See Also:

• Constant Field Values

ELLIPSOIDAL_EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE

public static final int ELLIPSOIDAL_EQUIDISTANT_CYLINDRICAL_PROJECTION_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable to enable the TLcdEllipsoidalEquidistantCylindrical projection.

Since:

2015.1

See Also:

• Constant Field Values

SCALE_ICON_ACTIVE_SETTABLE

public static final int SCALE_ICON_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, ALcyProperties) method, representing an active settable for showing the scale on a map of an ILspView.

By default, it is added in the menu bar.

See Also:

• createActiveSettable(int, ALcyProperties)
• Constant Field Values

MOUSE_LOCATION_ACTIVE_SETTABLE

public static final int MOUSE_LOCATION_ACTIVE_SETTABLE

The ID for the createActiveSettable(int, com.luciad.lucy.util.properties.ALcyProperties) method, representing an active settable for showing the mouse location on the map. By default, it is added in the menu bar.

See Also:

• createActiveSettable(int, com.luciad.lucy.util.properties.ALcyProperties)
• Constant Field Values

TOOL_BAR

public static final int TOOL_BAR

The ID for the createToolBar(int, ALcyProperties) method, representing the tool bar of the map component. By default, this tool bar is located at the top of the main view.

See Also:

• ILcyGenericMapComponent.getToolBar()
• Constant Field Values

STATUS_BAR

public static final int STATUS_BAR

The ID for the createToolBar(int, ALcyProperties) method, representing the status bar of the map component. By default, this tool bar is located at the bottom of the main view.

See Also:

• ILcyGenericMapComponent.getStatusBar()
• Constant Field Values

ON_MAP_ACTION_BAR

public static final int ON_MAP_ACTION_BAR

The ID for the createToolBar(int, ALcyProperties) method, representing the on map action bar of the map component. By default, this tool bar is located in the north west corner of the main view.

See Also:

• ILcyGenericMapComponent.getStatusBar()
• Constant Field Values

RIGHT_TOOL_BAR

public static final int RIGHT_TOOL_BAR

The ID for the createToolBar(int, ALcyProperties) method, representing the right tool bar of the map component. By default, this tool bar is located at the right side of the regular tool bar.

Inserting actions or active settables in this tool bar will visually align them to the right.

Since:

2016.0

See Also:

• TOOL_BAR
• Constant Field Values

Constructor Details

TLcyLspMapComponentFactory

public TLcyLspMapComponentFactory(ILcyLucyEnv aLucyEnv)

Creates a new map component factory for the specified Lucy environment.

It will create all the default actions, active settables, ... of which the IDs can be found as static fields of this class.

Parameters:

aLucyEnv - The Lucy backend

Method Details

setup

protected void setup(ALcyProperties aProperties)

This method overrides the default behavior of the ALcyGUIFactory.setup(com.luciad.lucy.util.properties.ALcyProperties) method. It will create all the components in a certain order. It will

1. create the empty map component using createMapComponent(com.luciad.lucy.util.properties.ALcyProperties).
2. create the menu bar using createMenuBar(com.luciad.lucy.util.properties.ALcyProperties).
3. create the toolbars using createToolBar(int, com.luciad.lucy.util.properties.ALcyProperties) with all given tool bar ids (see getToolBarIDs().
4. create the map popup menu using createPopupMenu(com.luciad.lucy.util.properties.ALcyProperties).
5. create the view using createView(com.luciad.lucy.util.properties.ALcyProperties).
6. create all the controllers using createController(int, com.luciad.lucy.util.properties.ALcyProperties) with all given controller IDs (see getControllerIDs() ).
7. create the map layer control using createMapLayerControl(com.luciad.lucy.util.properties.ALcyProperties).
8. create the initial layer index provider using createInitialLayerIndexProvider(com.luciad.lucy.util.properties.ALcyProperties).
9. create all actions, active settables, components and panels using ALcyGUIFactory.setup(com.luciad.lucy.util.properties.ALcyProperties).
10. create the balloon manager
11. create all graphics effects

Overrides:

setup in class ALcyGUIFactory<ILcyLspMapComponent>

Parameters:

aProperties - a properties object that can be used to tune the behavior of this factory.

cleanup

protected void cleanup(ALcyProperties aProperties)

Description copied from class: ALcyGUIFactory

Performs cleanup operations, such as nullifying fields that are no longer needed.

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

Overrides:

cleanup in class ALcyGUIFactory<ILcyLspMapComponent>

Parameters:

aProperties - a properties object that can be used to tune the behavior of this factory.

createGUIContent

protected ILcyLspMapComponent createGUIContent(ALcyProperties aProperties)

Description copied from class: ALcyGUIFactory

Retrieves all panels and lays them out in a java.awt.Component. Therefore, this method uses ALcyGUIFactory.getPanel(int) with all ID's that end in PANEL, and lays out those components in for example a javax.swing.JPanel.

This function should be overridden when the global layout of the panel needs to be changed, for example when the main panels need to be rearranged, or when a new panel needs to be added.

An example implementation could be:

 public Component createGUIContent( ALcyProperties aProperties ) {
   JPanel content = new JPanel( new BorderLayout() );

   Component somePanel = getPanel( SOME_PANEL );
   if ( somePanel != null ) content.add( somePanel, BorderLayout.NORTH );

   Component otherPanel = getPanel( OTHER_PANEL );
   if ( otherPanel != null ) content.add( otherPanel, BorderLayout.CENTER );

   return content;
  }
 

Specified by:

createGUIContent in class ALcyGUIFactory<ILcyLspMapComponent>

Parameters:

aProperties - a properties object that can be used to tune the behavior of this factory.

Returns:

the component containing all panels, layed out appropriately.

createMapComponent

protected TLcyLspMapComponent createMapComponent(ALcyProperties aProperties)

Creates a new map component. This map component must not contain a view. The view will be created in createView(com.luciad.lucy.util.properties.ALcyProperties) and set on the map component afterwards.

Override this method if you want to change the default map component.

Parameters:

aProperties - a properties object that can be used to tune the behavior of this factory.

Returns:

The empty map component. Must not be null.

getMapComponent

protected final TLcyLspMapComponent getMapComponent()

Returns the created map component

Returns:

the map component, or null

See Also:

• createMapComponent(com.luciad.lucy.util.properties.ALcyProperties)

createMapName

protected String createMapName(ALcyProperties aProperties)

Creates a map name for the given map.

Parameters:

aProperties - a properties object that can be used to tune the behavior of this factory.

Returns:

a map name.

createMenuBar

protected ILcyMenuBar createMenuBar(ALcyProperties aProperties)

Create a new menu bar.

Override this method if you want to change the default menu bar.

Parameters:

aProperties - a properties object that can be used to tune the behavior of this factory.

Returns:

The menu bar, or null.

getMenuBar

protected final ILcyMenuBar getMenuBar()

Returns the created menu bar

Returns:

the menu bar, or null

See Also:

• createMenuBar(com.luciad.lucy.util.properties.ALcyProperties)

createToolBar

protected ILcyToolBar createToolBar(int aToolBarID,
 ALcyProperties aProperties)

Creates an ILcyToolBar for the given ID.

Parameters:

aToolBarID - the ID describing which tool bar to create. This is normally a constant that ends with _BAR.

aProperties - a properties object that can be used to tune the behavior of this factory.

Returns:

the newly created ILcyToolBar, or null.

getToolBar

protected final ILcyToolBar getToolBar(int aToolBarID)

Returns the ILcyToolBar for the given ID.

Please refer to setup(com.luciad.lucy.util.properties.ALcyProperties) to know when this method can be used.

Parameters:

aToolBarID - the id describing which ILcyToolBar to return. This is normally a constant that ends in _BAR.

Returns:

the ILcyToolBar for the given ID.

getToolBarIDs

protected ILcdIntList getToolBarIDs()

Returns the list with all toolbar IDs.

By default, this list only contains the IDs defined in this class. Adding and/or removing toolbar IDs to/from this factory is achieved by altering this list.

Warning: do not alter the list when the factory is creating the GUI. Only modify it before or after the ALcyGUIFactory.createGUI(com.luciad.lucy.util.properties.ALcyProperties) method.

Returns:

a list with the toolbar IDs

createPopupMenu

protected ILcyPopupMenu createPopupMenu(ALcyProperties aProperties)

Create a new pop up menu.

Override this method if you want to change the default pop up menu.

Parameters:

aProperties - a properties object that can be used to tune the behavior of this factory.

Returns:

The popup menu, or null

getPopupMenu

protected final ILcyPopupMenu getPopupMenu()

Returns the created map popup menu.

Returns:

the created map popup menu, or null

See Also:

• createPopupMenu(com.luciad.lucy.util.properties.ALcyProperties)

createBalloonManager

protected ALcdBalloonManager createBalloonManager(ALcyProperties aProperties)

Creates the balloon manager for the map component under construction.

Override this method if you want to change the default balloon manager.

The default implementation also adds an ILcdSelectionListener to the view of the map component, which calls ALcdBalloonManager.setBalloonDescriptor(com.luciad.view.swing.ALcdBalloonDescriptor) when only one object is selected on the view.

Parameters:

aProperties - a properties object that can be used to tune the behavior of this factory.

Returns:

the created balloon manager. May be null

See Also:

• getBalloonManager()

getBalloonManager

public ALcdBalloonManager getBalloonManager()

Returns the created balloon manager.

Returns:

the created balloon manager. Can be null

See Also:

• createBalloonManager(com.luciad.lucy.util.properties.ALcyProperties)

createGraphicsEffect

public ALspGraphicsEffect createGraphicsEffect(int aID,
 ALcyProperties aProperties)

Creates the graphics effects for the given id.

Override this method if you want custom lighting, fog (or other graphics effects) behavior in a map component.

Parameters:

aID - the ID describing the graphics effect to create. This is generally a constant that ends in GRAPHICS_EFFECT.

aProperties - the properties object for this map component

Returns:

The newly created and configured ALspGraphicsEffect.

getGraphicsEffects

public List<ALspGraphicsEffect> getGraphicsEffects()

Returns the list of created graphics effects

Returns:

a list of created graphics effects.

createView

protected ILspView createView(ALcyProperties aProperties)

Creates a new view. To facilitate customization of the view creation, this method uses a TLspViewBuilder which is created by the createViewBuilder(ALcyProperties) method to build the view.

Once the view has been created through the view builder, this method associates navigation constraints to the view (based on the configured scale range) and a layer factory.

Override this method if you want to change the default main view.

Parameters:

aProperties - a properties object that can be used to tune the behavior of this factory.

Returns:

a new view. Must not be null, and should be an instance of ILspAWTView.

See Also:

• createViewBuilder(ALcyProperties)

createViewBuilder

protected TLspViewBuilder createViewBuilder(ALcyProperties aProperties)

This method is called by the default implementation of createView(ALcyProperties) and is responsible for creating the TLspViewBuilder which will be used in the createView method to create the Lightspeed view.

Parameters:

aProperties - a properties object that can be used to tune the behavior of this factory

Returns:

a new non-null view builder instance.

Since:

2017.0

See Also:

• createView(ALcyProperties)

getView

protected final ILspView getView()

Returns the created view

Returns:

the created view, or null

See Also:

• createView(com.luciad.lucy.util.properties.ALcyProperties)

createController

protected ILspController createController(int aControllerID,
 ALcyProperties aProperties)

Create the controller for the ID aControllerID.

Note that this method will be called several times for the PAN_CONTROLLER and PAN_TOUCH_CONTROLLER ids. Once to create the actual (touch) pan controller, and then other times if another controller wants to append navigation capabilities. For example if you create a ruler controller and you want to append navigation capabilities, you can append a new pan controller instance to your ruler controller. The benefit of this mechanism is that you can override this method for those ids to customize the navigation behavior, and still have consistent navigation behavior for all controllers.

Parameters:

aControllerID - the ID for the controller. This is typically a constant ending in _CONTROLLER.

aProperties - a properties object that can be used to tune the behavior of this factory.

Returns:

the controller corresponding to the ID aControllerID, or null

getController

protected final ILspController getController(int aControllerID)

Returns the created controller corresponding to the ID aControllerID.

Parameters:

aControllerID - the ID for the controller. This is typically a constant ending in _CONTROLLER.

Returns:

the created controller for the ID aControllerID or null

getControllerIDs

protected ILcdIntList getControllerIDs()

Returns the list with all controller IDs.

By default, this list only contains the IDs defined in this class. Adding and/or removing controller IDs to/from this factory is achieved by altering this list.

Warning: do not alter the list when the factory is creating the GUI. Only modify it before or after the ALcyGUIFactory.createGUI(com.luciad.lucy.util.properties.ALcyProperties) method.

Returns:

a list with the controller IDs

createAction

protected ILcdAction createAction(int aActionID,
 ALcyProperties aProperties)

Description copied from class: ALcyGUIFactory

Creates an ILcdAction for the given ID.

Note: if the action should be inserted in the configured action bars, the ID_KEY of the returned action must be set (see TLcyActionBarUtil.ID_KEY).

Specified by:

createAction in class ALcyGUIFactory<ILcyLspMapComponent>

Parameters:

aActionID - the ID describing which action to create. This is normally a constant that ends with ACTION.

aProperties - a properties object that can be used to tune the behavior of this factory.

Returns:

the newly created ILcdAction, or null.

See Also:

• ALcyGUIFactory.setup(com.luciad.lucy.util.properties.ALcyProperties)

createActiveSettable

protected ILcyActiveSettable createActiveSettable(int aActiveSettableID,
 ALcyProperties aProperties)

Description copied from class: ALcyGUIFactory

Creates an ILcyActiveSettable for the given ID.

Note: if the active settable should be inserted in the configured action bars, the ID_KEY of the returned active settable must be set (see TLcyActionBarUtil.ID_KEY).

Specified by:

createActiveSettable in class ALcyGUIFactory<ILcyLspMapComponent>

Parameters:

aActiveSettableID - the ID describing which active settable to create. This is normally a constant that ends with ACTIVE_SETTABLE.

aProperties - a properties object that can be used to tune the behavior of this factory.

Returns:

the newly created ILcyActiveSettable, or null.

createComponent

protected Component createComponent(int aComponentID,
 ALcyProperties aProperties)

Description copied from class: ALcyGUIFactory

Creates a widget for the given ID. It is safe to use the ALcyGUIFactory.getAction(int) and ALcyGUIFactory.getActiveSettable(int) methods in this method, to build widgets that use an action or active settable.

These widgets might interact with the given properties object, to retrieve or store some state. Such a widget could for example be a check box whose 'selected' state is synchronized with some property.

Specified by:

createComponent in class ALcyGUIFactory<ILcyLspMapComponent>

Parameters:

aComponentID - the ID describing which component to create. This is normally a constant that ends with COMPONENT.

aProperties - a properties object that can be used to tune the behavior of this factory. state.

Returns:

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

createPanel

protected Component createPanel(int aPanelID,
 ALcyProperties aProperties)

Creates a panel for the given ID. It is safe to use ALcyGUIFactory.getComponent(int) in this method, to build panels that are composed of components.

An example implementation could be:

 protected Component createPanel( int aPanelID, ALcyProperties aProperties ) {
   if ( aPanelID == SOME_PANEL ) {
     JPanel content = new JPanel( new BorderLayout() );

     Component someComponent = getComponent( SOME_COMPONENT );
     if ( someComponent != null ) content.add( someComponent, BorderLayout.NORTH );

     Component otherComponent = getComponent( OTHER_COMPONENT );
     if ( otherComponent != null ) content.add( otherComponent, BorderLayout.CENTER );

     return content;
   }
   else if ( aPanelID == ... ) {
     ...
   }
 }
 

Warning: do not override this method for the CENTER_OVERLAY_PANEL.

Specified by:

createPanel in class ALcyGUIFactory<ILcyLspMapComponent>

Parameters:

aPanelID - the ID describing which panel to create. This is normally a constant that ends with PANEL.

aProperties - a properties object that can be used to tune the behavior of this factory.

Returns:

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

getActionContext

protected Object getActionContext(int aActionID,
 ALcyProperties aProperties)

Description copied from class: ALcyGUIFactory

Returns the context of the action bars in which the action with the specified ID should be inserted.

All actions are inserted in the action bars by TLcyActionBarUtil.insertInConfiguredActionBars(com.luciad.gui.ILcdAction, Object, com.luciad.lucy.gui.TLcyActionBarManager, com.luciad.lucy.util.properties.ALcyProperties). This method specifies the context for which the action with ID aActionID is inserted.

By default this method returns null.

Overrides:

getActionContext in class ALcyGUIFactory<ILcyLspMapComponent>

Parameters:

aActionID - the ID of the action.

aProperties - The properties. Can be used to tune the behavior of this factory.

Returns:

the context of the action with the specified ID

getActiveSettableContext

protected Object getActiveSettableContext(int aActiveSettableID,
 ALcyProperties aProperties)

Description copied from class: ALcyGUIFactory

Returns the context of the action bars in which the active settable with the specified ID should be inserted.

All active settables are inserted in the action bars by TLcyActionBarUtil#insertInConfiguredActionBars. This method specifies the context for which the active settable with ID aActiveSettableID is inserted.

By default this method returns null.

Overrides:

getActiveSettableContext in class ALcyGUIFactory<ILcyLspMapComponent>

Parameters:

aActiveSettableID - the ID of the active settable

aProperties - The properties. Can be used to tune the behavior of this factory.

Returns:

the context of the active settable with the specified ID.

isActiveSettableDeactivatePossible

protected boolean isActiveSettableDeactivatePossible(int aActiveSettableID,
 ALcyProperties aProperties)

Description copied from class: ALcyGUIFactory

Returns whether the active settable can be deactivated or not through the action bar in which it is inserted.

All active settables are inserted in the action bars by TLcyActionBarUtil#insertInConfiguredActionBars. This method specifies the value of the isDeactivatePossible parameter for the active settable with ID aActiveSettableID is inserted.

Overrides:

isActiveSettableDeactivatePossible in class ALcyGUIFactory<ILcyLspMapComponent>

Parameters:

aActiveSettableID - the ID of the active settable

aProperties - The properties. Can be used to tune the behavior of this factory

Returns:

true when the active settable can be deactivated through the action bar, false otherwise

See Also:

• TLcyActionBarUtil.insertInConfiguredActionBars(ILcyActiveSettable, Object, TLcyActionBarManager, com.luciad.lucy.util.properties.ALcyProperties, boolean)

getMapLayerControlFactory

public TLcyLspMapLayerControlFactory getMapLayerControlFactory()

Returns the factory used to create the map layer control.

Returns:

the factory used to create the map layer control.

setMapLayerControlFactory

public void setMapLayerControlFactory(TLcyLspMapLayerControlFactory aMapLayerControlFactory)

Set the factory which will be used to create the map layer control.

Parameters:

aMapLayerControlFactory - the map layer control factory

See Also:

• createMapLayerControl(com.luciad.lucy.util.properties.ALcyProperties)
• TLcyLspMapLayerControlFactory

createMapLayerControl

protected TLcyLspMapLayerControl createMapLayerControl(ALcyProperties aProperties)

Create a new map layer control.

By default, this method uses the map layer control factory set on this factory, or a default factory when no such factory has been set. The recommended approach to modify the map layer control is to implement your own map layer control factory and plug it into this factory.

The properties passed to the map layer control factory will contain the map component that is currently under construction.

Parameters:

aProperties - a properties object that can be used to tune the behavior of this factory.

Returns:

the map layer control, or null.

See Also:

• setMapLayerControlFactory(TLcyLspMapLayerControlFactory)
• getMapLayerControl()

getMapLayerControl

protected final TLcyLspMapLayerControl getMapLayerControl()

Returns the created map layer control

Returns:

the map layer control, or null

See Also:

• createMapLayerControl(com.luciad.lucy.util.properties.ALcyProperties)

createInitialLayerIndexProvider

protected ILcdInitialLayerIndexProvider createInitialLayerIndexProvider(ALcyProperties aProperties)

Creates a initial layer index provider for this map component.

Parameters:

aProperties - a properties object that can be used to tune the behavior of this factory.

Returns:

the initial layer index provider, or null.

getInitialLayerIndexProvider

protected final ILcdInitialLayerIndexProvider getInitialLayerIndexProvider()

Returns the created initial layer index provider.

Returns:

the created layer index provider or null.

See Also:

• createInitialLayerIndexProvider(ALcyProperties)