com.luciad.lucy.addons.drawing.lightspeed.gui

LuciadLightspeedClass TLcyLspDrawingToolBarFactory

java.lang.Object

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

com.luciad.lucy.addons.drawing.gui.ALcyDrawingToolBarFactory<ILspView,ILspLayer>

com.luciad.lucy.addons.drawing.lightspeed.gui.TLcyLspDrawingToolBarFactory

public class TLcyLspDrawingToolBarFactory
extends ALcyDrawingToolBarFactory<ILspView,ILspLayer>

Lightspeed version of the ALcyDrawingToolBarFactory.

Consult the class javadoc of that class for more information about the customization options of this class.

This class also creates create controller models and matching active settables for each of the domain object suppliers registered to the drawing format. The active settable allows to activate the create controller through the UI, providing the Lucy end-user with the ability to draw new shapes on the map.The active settable is only added to the tool bar if this is indicated in the configuration.

The create controller models can be obtained through the getCreateControllerModelForDomainObjectSupplier method and the active settables using getActiveSettableForDomainObjectSupplier. The create controller modes are created before the active settables, and the active settables are created before the components (see also the setup method).

Since:

2012.1

See Also:

ALcyDrawingToolBarFactory

Field Summary

Fields

Modifier and Type	Field and Description
static int	TERRAIN_FOLLOW_ACTIVE_SETTABLE Determines terrain-follow behavior.

Fields inherited from class com.luciad.lucy.addons.drawing.gui.ALcyDrawingToolBarFactory

ARROW_COMPONENT, BUFFER_3D_ACTION, BUFFER_ACTION, CHANGE_ARROW_STYLE_ACTION, CHANGE_FILL_COLOR_ACTION, CHANGE_LINE_SIZE_ACTION, CHANGE_LINE_STYLE_ACTION, CHANGE_POINT_STYLE_ACTION, COPY_STYLE_ACTION, DELETE_ACTION, DOME_ACTION, DRAWING_TOOL_BAR_ID, DUPLICATE_ACTION, EXTRUDE_ACTION, FILL_COLOR_COMPONENT, FONT_ACTION, GROUP_ACTION, INTERSECTION_ACTION, LINE_COLOR_ACTION, LINE_SIZE_COMPONENT, LINE_STYLE_COMPONENT, LOAD_ACTION, MAIN_PANEL, NEW_LAYER_ACTION, PARALLEL_ACTION, PERPENDICULAR_ACTION, POINT_ACTION, POINT_COMPONENT, POLYGON_CONVEX_HULL_ACTION, POLYGON_DIFFERENCE_ACTION, POLYGON_INTERSECTION_ACTION, POLYGON_INVERTED_DIFFERENCE_ACTION, POLYGON_SYMMETRIC_DIFFERENCE_ACTION, POLYGON_UNION_ACTION, SAVE_ACTION, SPHERE_ACTION, TRANSLATE_ACTION, UNEXTRUDE_ACTION, UNGROUP_ACTION, VARIABLE_BUFFER_3D_ACTION

Constructor Summary

Constructors

Constructor and Description
TLcyLspDrawingToolBarFactory(TLcyLspDrawingAddOn aLspDrawingAddOn) Constructs a new factory able to create a drawing tool bar which can be use on ILcyLspMapComponent instances.

Method Summary

Modifier and Type	Method and 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 ILcyActiveSettable	createActiveSettableForDomainObjectSupplier(ALcyLspDomainObjectSupplier aDomainObjectSupplier, ALcyProperties aProperties) Creates an ILcyActiveSettable for the given domain object supplier.
protected ALspCreateControllerModel	createCreateControllerModelForDomainObjectSupplier(ALcyLspDomainObjectSupplier aDomainObjectSupplier, ALcyProperties aProperties) Creates an ALspCreateControllerModel for the given ALcyLspDomainObjectSupplier.
protected Object	getActiveSettableContextForDomainObjectSupplier(ALcyLspDomainObjectSupplier aDomainObjectSupplier, ALcyProperties aProperties) Returns the context with which the dynamic active settable for the domain object supplier aDomainObjectSupplier will be inserted in the configured action bars.
protected ILcyActiveSettable	getActiveSettableForDomainObjectSupplier(ALcyLspDomainObjectSupplier aDomainObjectSupplier) Returns the ILcyActiveSettable for the given domain object supplier.
protected Enumeration<ALcyLspDomainObjectSupplier>	getAvailableDomainObjectSuppliers() Returns an enumeration of all available domain object suppliers.
protected ALspCreateControllerModel	getCreateControllerModelForDomainObjectSupplier(ALcyLspDomainObjectSupplier aDomainObjectSupplier) Returns the ALspCreateControllerModel for the given ALcyLspDomainObjectSupplier.
protected String	getFormatBarPropertiesKey() Returns the complete key (including the prefix) which was used to store the format bar in the ALcyProperties passed to the ALcyDrawingToolBarFactory.createGUI(com.luciad.lucy.util.properties.ALcyProperties) method.
TLcyLspDrawingAddOn	getLspDrawingAddOn() Returns the Lightspeed drawing add-on
protected ILcyLspMapComponent	getMapComponent(ALcyProperties aProperties) Convenience method to return the map component contained in the properties with key ALcyDrawingToolBarFactory.getMapComponentPropertiesKey().
protected String	getMapComponentPropertiesKey() Returns the complete key (including the prefix) which was used to store the map component in the ALcyProperties passed to the ALcyDrawingToolBarFactory.createGUI(com.luciad.lucy.util.properties.ALcyProperties) method.
protected void	setup(ALcyProperties aProperties) This functions creates all the components for the user interface, in a certain order.

Methods inherited from class com.luciad.lucy.addons.drawing.gui.ALcyDrawingToolBarFactory

createComponent, createEmptyToolBar, createEmptyToolBar, createGUI, createGUIContent, createPanel, createToolBarID, getActionContext, getActiveSettableContext, getFormatBar, getPropertyPrefix, getToolBar, getToolBarID

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

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

Methods inherited from class java.lang.Object

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

Field Detail

TERRAIN_FOLLOW_ACTIVE_SETTABLE

public static final int TERRAIN_FOLLOW_ACTIVE_SETTABLE

Determines terrain-follow behavior. If this active settable is active, interactive shape translations retain the height above the terrain. For example, if you drag a point with height H from a location with height Z1 to a location with height Z2, the new height will be H - Z1 + Z2.

See Also:

Constant Field Values

Constructor Detail

TLcyLspDrawingToolBarFactory

public TLcyLspDrawingToolBarFactory(TLcyLspDrawingAddOn aLspDrawingAddOn)

Constructs a new factory able to create a drawing tool bar which can be use on ILcyLspMapComponent instances.

Parameters:

aLspDrawingAddOn - The Lightspeed drawing add-on

Method Detail

setup

protected void setup(ALcyProperties aProperties)

Description copied from class: ALcyGUIFactory

This functions creates all the components for the user interface, in a certain order. It

1. creates all actions using createAction with all given action ID's (see ALcyGUIFactory.getActionIDs()) and insert them in all configured action bars using TLcyActionBarUtil.insertInConfiguredActionBars(com.luciad.gui.ILcdAction, Object, TLcyActionBarManager, com.luciad.lucy.util.properties.ALcyProperties) with the specified properties. The context is determined by calling ALcyGUIFactory.getActionContext(int, com.luciad.lucy.util.properties.ALcyProperties).
   Only actions where the ID_KEY is specified will be inserted (see TLcyActionBarUtil.ID_KEY).
2. creates all active settables createActiveSettable with all given active settable ID's (see ALcyGUIFactory.getActiveSettableIDs() and insert them in all configured action bars using TLcyActionBarUtil.insertInConfiguredActionBars(ILcyActiveSettable, Object, TLcyActionBarManager, com.luciad.lucy.util.properties.ALcyProperties) with the specified properties. The context is determined by calling ALcyGUIFactory.getActiveSettableContext(int, com.luciad.lucy.util.properties.ALcyProperties).
   Only active settables where the ID_KEY is specified will be inserted (see TLcyActionBarUtil.ID_KEY).
3. creates all components using ALcyGUIFactory.createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) with all given component ID's (see ALcyGUIFactory.getComponentIDs() ).
4. creates all panels using ALcyGUIFactory.createPanel(int, com.luciad.lucy.util.properties.ALcyProperties) with all given panel ID's (see ALcyGUIFactory.getPanelIDs() ).

Note that because of this order, panels can be composed of components, and components can use the active settables and actions. So the ALcyGUIFactory.createPanel(int, com.luciad.lucy.util.properties.ALcyProperties) method can use ALcyGUIFactory.getComponent(int) to retrieve its sub components, and the ALcyGUIFactory.createComponent(int, com.luciad.lucy.util.properties.ALcyProperties) method can use ALcyGUIFactory.getAction(int) and ALcyGUIFactory.getActiveSettable(int) to retrieve needed actions and active settables.

Warning: It is possible that this method is called on a worker thread. When overriding this method, care should be taken to ensure that all code that should be run on the EDT thread (Swing code etc...) is invoked using for example TLcdAWTUtil.invokeAndWait(java.lang.Runnable). Also, don't override this method without calling the super function.

Overrides:

setup in class ALcyDrawingToolBarFactory<ILspView,ILspLayer>

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 ALcyDrawingToolBarFactory<ILspView,ILspLayer>

Parameters:

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

getMapComponent

protected ILcyLspMapComponent getMapComponent(ALcyProperties aProperties)

Description copied from class: ALcyDrawingToolBarFactory

Convenience method to return the map component contained in the properties with key ALcyDrawingToolBarFactory.getMapComponentPropertiesKey().

Overrides:

getMapComponent in class ALcyDrawingToolBarFactory<ILspView,ILspLayer>

Parameters:

aProperties - The properties in which to look for a map component

Returns:

The map component

getLspDrawingAddOn

public final TLcyLspDrawingAddOn getLspDrawingAddOn()

Returns the Lightspeed drawing add-on

Returns:

the Lightspeed drawing add-on

getMapComponentPropertiesKey

protected final String getMapComponentPropertiesKey()

Returns the complete key (including the prefix) which was used to store the map component in the ALcyProperties passed to the ALcyDrawingToolBarFactory.createGUI(com.luciad.lucy.util.properties.ALcyProperties) method.

Specified by:

getMapComponentPropertiesKey in class ALcyDrawingToolBarFactory<ILspView,ILspLayer>

Returns:

TLcyLspDrawingFormat.MAP_COMPONENT_KEY

See Also:

TLcyLspDrawingFormat.MAP_COMPONENT_KEY

getFormatBarPropertiesKey

protected final String getFormatBarPropertiesKey()

Returns the complete key (including the prefix) which was used to store the format bar in the ALcyProperties passed to the ALcyDrawingToolBarFactory.createGUI(com.luciad.lucy.util.properties.ALcyProperties) method.

Specified by:

getFormatBarPropertiesKey in class ALcyDrawingToolBarFactory<ILspView,ILspLayer>

Returns:

TLcyLspDrawingFormat.FORMAT_BAR_KEY

See Also:

TLcyLspDrawingFormat.FORMAT_BAR_KEY

getAvailableDomainObjectSuppliers

protected final Enumeration<ALcyLspDomainObjectSupplier> getAvailableDomainObjectSuppliers()

Returns an enumeration of all available domain object suppliers. This enumeration will be used to automatically create active settables which allow to construct new shapes for the domain object suppliers. Consult the class javadoc for more information.

Returns:

an enumeration of all available domain object suppliers

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).

Overrides:

createActiveSettable in class ALcyDrawingToolBarFactory<ILspView,ILspLayer>

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.

getCreateControllerModelForDomainObjectSupplier

protected final ALspCreateControllerModel getCreateControllerModelForDomainObjectSupplier(ALcyLspDomainObjectSupplier aDomainObjectSupplier)

Returns the ALspCreateControllerModel for the given ALcyLspDomainObjectSupplier.

Parameters:

aDomainObjectSupplier - The ALcyLspDomainObjectSupplier describing which ALspCreateControllerModel to return

Returns:

The ALspCreateControllerModel for the given ALcyLspDomainObjectSupplier.

createCreateControllerModelForDomainObjectSupplier

protected ALspCreateControllerModel createCreateControllerModelForDomainObjectSupplier(ALcyLspDomainObjectSupplier aDomainObjectSupplier,
                                                                                       ALcyProperties aProperties)

Creates an ALspCreateControllerModel for the given ALcyLspDomainObjectSupplier. This create controller model is typically used by the active settable.

Parameters:

aDomainObjectSupplier - The ALcyDomainObjectSupplier for which to create the ALcdGXYNewControllerModel2.

aProperties - The ALcyProperties containing the configuration of the addon and the ALcyDomainObjectSupplier.

Returns:

The newly created ALcdGXYNewControllerModel2

See Also:

createActiveSettableForDomainObjectSupplier(com.luciad.lucy.addons.drawing.lightspeed.ALcyLspDomainObjectSupplier, com.luciad.lucy.util.properties.ALcyProperties)

createActiveSettableForDomainObjectSupplier

protected ILcyActiveSettable createActiveSettableForDomainObjectSupplier(ALcyLspDomainObjectSupplier aDomainObjectSupplier,
                                                                         ALcyProperties aProperties)

Creates an ILcyActiveSettable for the given domain object supplier. Typically, the active settable is based on the create controller model which can be retrieved using getCreateControllerModelForDomainObjectSupplier.

Parameters:

aDomainObjectSupplier - The domain object supplier for which to create the active settable

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

Returns:

am ILcyActiveSettable for the given domain object supplier. May be null.

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).

Overrides:

createAction in class ALcyDrawingToolBarFactory<ILspView,ILspLayer>

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)

getActiveSettableForDomainObjectSupplier

protected ILcyActiveSettable getActiveSettableForDomainObjectSupplier(ALcyLspDomainObjectSupplier aDomainObjectSupplier)

Returns the ILcyActiveSettable for the given domain object supplier.

Parameters:

aDomainObjectSupplier - The domain object supplier describing which ILcyActiveSettable to return.

Returns:

The ILcyActiveSettable for the given domain object supplier. Can be null.

getActiveSettableContextForDomainObjectSupplier

protected Object getActiveSettableContextForDomainObjectSupplier(ALcyLspDomainObjectSupplier aDomainObjectSupplier,
                                                                 ALcyProperties aProperties)

Returns the context with which the dynamic active settable for the domain object supplier aDomainObjectSupplier will be inserted in the configured action bars.

Parameters:

aDomainObjectSupplier - The domain object supplier

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

Returns:

the context with which the dynamic active settable will be inserted in the configured action bars.

See Also:

ALcyDrawingToolBarFactory.getActiveSettableContext(int, com.luciad.lucy.util.properties.ALcyProperties)