Package com.luciad.lucy.addons.tea.visibility

Class TLcyVisibilityGUIFactory

java.lang.Object

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

com.luciad.lucy.addons.tea.visibility.TLcyVisibilityGUIFactory

public class TLcyVisibilityGUIFactory
extends ALcyGUIFactory<Component>

Determines the GUI elements to add to the visibility application pane. The GUI elements can read and write their run-time state from the properties that the factory has been initialized with.

Each GUI element can be replaced by overriding the respective create* method to return a custom element for the respective GUI ID. For example, to change the functionality of the layer update action, override the createAction(int, com.luciad.lucy.util.properties.ALcyProperties) method to return a custom action for the UPDATE_LAYER_ACTION ID.

Similarly, one can override the createGUIContent method to produce a customized layout for the GUI elements.

See Also:

• ALcyGUIFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ACTION_PANEL	The id for creating the action panel.
static final int	ACTION_PANEL_AUTO_UPDATE_COMPONENT	Part of ACTION_PANEL that shows the auto-update component.
static final int	ACTION_PANEL_CREATE_LAYER_COMPONENT	Part of ACTION_PANEL that shows the create layer button.
static final int	ACTION_PANEL_UPDATE_LAYER_COMPONENT	Part of ACTION_PANEL that shows the update layer button.
static final int	CREATE_LAYER_ACTION	The id for creating the action that creates a new layer.
static final int	FROM_SHAPE_PANEL	The id for creating the From shape panel.
static final int	FROM_SHAPE_PANEL_SHAPE_LIST_COMPONENT	Part of FROM_SHAPE_PANEL that shows the shape list from which the visibility needs to be computed.
static final int	OUTPUT_PANEL	The id for creating the output panel.
static final int	OUTPUT_PANEL_OUTPUT_FORMAT_COMPONENT	Part of OUTPUT_PANEL that shows the output format of the visibility results.
static final int	PROPAGATION_CHOICE_PANEL	The id for creating the propagation choice panel.
static final int	PROPAGATION_CHOICE_PANEL_CURRENT_QUALITY_COMPONENT	Part of PROPAGATION_CHOICE_PANEL that shows a description for the TLcyVisibilityAddOn.QUALITY_KEY property.
static final int	PROPAGATION_CHOICE_PANEL_PROPAGATION_FUNCTION_COMPONENT	Part of PROPAGATION_CHOICE_PANEL that shows the computation mode component.
static final int	PROPAGATION_CHOICE_PANEL_QUALITY_COMPONENT	Part of PROPAGATION_CHOICE_PANEL that shows the quality component.
static final int	PROPAGATION_SETTINGS_PANEL	The id for creating the propagation settings panel.
static final int	PROPAGATION_SETTINGS_PROPAGATION_FUNCTION_NORMAL_COMPONENT	Part of PROPAGATION_CHOICE_PANEL that shows the settings specific to the normal propagation function.
static final int	PROPAGATION_SETTINGS_PROPAGATION_FUNCTION_SKY_BACKGROUND_COMPONENT	Part of PROPAGATION_CHOICE_PANEL that shows the settings specific to the sky-in-background propagation function.
static final int	STYLE_PANEL	The id for creating the style panel.
static final int	STYLE_PANEL_COLOR_INVISIBLE_COMPONENT	Part of STYLE_PANEL that shows the settings for invisible visibility results.
static final int	STYLE_PANEL_COLOR_UNKNOWN_COMPONENT	Part of STYLE_PANEL that shows the settings for unknown visibility results.
static final int	STYLE_PANEL_COLOR_VISIBLE_COMPONENT	Part of STYLE_PANEL that shows the settings for visible visibility results.
static final int	SWAP_PANEL	The id for creating the Swap shapes panel.
static final int	SWAP_PANEL_SWAP_SELECTED_FROM_SHAPE_COMPONENT	Part of SWAP_PANEL that swaps the shapes in the From list with the shapes in the To list.
static final int	SWAP_PANEL_SWAP_SELECTED_TO_SHAPE_COMPONENT	Part of SWAP_PANEL that swaps the shapes in the From list with the shapes in the To list.
static final int	SWAP_PANEL_SWAP_SHAPES_COMPONENT	Part of SWAP_PANEL that swaps the shapes in the From list with the shapes in the To list.
static final int	SWAP_SELECTED_FROM_SHAPE_ACTION	The id for creating the action that swaps the selected shape from the From list to the To list.
static final int	SWAP_SELECTED_TO_SHAPE_ACTION	The id for creating the action that swaps the selected shape from the To list to the From list.
static final int	SWAP_SHAPES_ACTION	The id for creating the action that swaps all shapes from the From list to the To list.
static final int	TO_SHAPE_PANEL	The id for creating the To shape panel.
static final int	TO_SHAPE_PANEL_SHAPE_LIST_COMPONENT	Part of TO_SHAPE_PANEL that shows the shape list to which the visibility needs to be computed.
static final int	UPDATE_LAYER_ACTION	The ID for creating the action that computes the visibility.

Constructor Summary

Constructors

Constructor	Description
TLcyVisibilityGUIFactory(ILcyLucyEnv aLucyEnv)	Default constructor that builds all actions, component and panels.

Method Summary

Modifier and Type	Method	Description
protected ILcdAction	createAction(int aID, ALcyProperties aProperties)	Creates an ILcdAction for the given ID.
protected ILcyActiveSettable	createActiveSettable(int aActiveSettableID, ALcyProperties aProperties)	Creates an ILcyActiveSettable for the given ID.
protected Component	createComponent(int aID, ALcyProperties aProperties)	Creates a widget for the given ID.
protected Component	createGUIContent(ALcyProperties aProperties)	Retrieves all panels and lays them out in a java.awt.Component.
protected Component	createPanel(int aID, ALcyProperties aProperties)	Creates a panel for the given ID.

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

cleanup, createGUI, getAction, getActionContext, getActionIDs, getActiveSettable, getActiveSettableContext, getActiveSettableIDs, getComponent, getComponentIDs, getLucyEnv, getPanel, getPanelIDs, isActiveSettableDeactivatePossible, setup

Methods inherited from class java.lang.Object

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

Field Details

CREATE_LAYER_ACTION

public static final int CREATE_LAYER_ACTION

The id for creating the action that creates a new layer.

See Also:

• Constant Field Values

UPDATE_LAYER_ACTION

public static final int UPDATE_LAYER_ACTION

The ID for creating the action that computes the visibility. When the Update button is pressed, the GUI properties starting with "TLcyVisibilityAddOn.layer.tea." are stored for the selected TEA layer (see TLcyVisibilityAddOn.LINKED_LAYER_KEY), and a new visibility calculation starts.

This calculation interacts with the back-end as follows:

• a propagation function is created using the TLcyVisibilityAddOn.SELECTED_PROPAGATION_KEY property and its sub-properties;
• an altitude provider is retrieved using the TLcyVisibilityAddOn.QUALITY_KEY property;
• the altitude provider and quality value is used to create raster matrix view's of all FROM and TO shapes in the TLcyVisibilityAddOn.FROM_SHAPE_LIST_KEY and TLcyVisibilityAddOn.TO_SHAPE_LIST_KEY lists;
• a visibility descriptor is created;
• a visibility factory is obtained;
• the matrix views, visibility descriptor, altitude provider, quality value and propagation function are used to create a visibility matrix view;
• depending on the TLcyVisibilityAddOn.OUTPUT_FORMAT_KEY property, TLcyVisibilityBackEnd.createContourFinder(com.luciad.lucy.util.properties.ALcyProperties) or TLcyVisibilityBackEnd.createMatrixViewRasterFactory(com.luciad.lucy.util.properties.ALcyProperties) is called.

The results of the computation are placed in the selected layer's model.

See Also:

• Constant Field Values

SWAP_SELECTED_FROM_SHAPE_ACTION

public static final int SWAP_SELECTED_FROM_SHAPE_ACTION

The id for creating the action that swaps the selected shape from the From list to the To list.

See Also:

• Constant Field Values

SWAP_SELECTED_TO_SHAPE_ACTION

public static final int SWAP_SELECTED_TO_SHAPE_ACTION

The id for creating the action that swaps the selected shape from the To list to the From list.

See Also:

• Constant Field Values

SWAP_SHAPES_ACTION

public static final int SWAP_SHAPES_ACTION

The id for creating the action that swaps all shapes from the From list to the To list.

See Also:

• Constant Field Values

FROM_SHAPE_PANEL

public static final int FROM_SHAPE_PANEL

The id for creating the From shape panel. It allows to choose the shapes from which the visibility needs to be computed.

See Also:

• Constant Field Values

TO_SHAPE_PANEL

public static final int TO_SHAPE_PANEL

The id for creating the To shape panel. It allows to choose the shapes to which the visibility needs to be computed.

See Also:

• Constant Field Values

PROPAGATION_CHOICE_PANEL

public static final int PROPAGATION_CHOICE_PANEL

The id for creating the propagation choice panel. It allows to choose the quality and the propagation function.

See Also:

• Constant Field Values

PROPAGATION_SETTINGS_PANEL

public static final int PROPAGATION_SETTINGS_PANEL

The id for creating the propagation settings panel. It allows to choose the propagation function specific settings.

See Also:

• Constant Field Values

STYLE_PANEL

public static final int STYLE_PANEL

The id for creating the style panel. It allows to choose the style settings.

See Also:

• Constant Field Values

OUTPUT_PANEL

public static final int OUTPUT_PANEL

The id for creating the output panel. It allows to choose the output type.

See Also:

• Constant Field Values

ACTION_PANEL

public static final int ACTION_PANEL

The id for creating the action panel. It shows the action components.

See Also:

• Constant Field Values

SWAP_PANEL

public static final int SWAP_PANEL

The id for creating the Swap shapes panel. It allows to swap the shapes between the to and from panel.

See Also:

• Constant Field Values

FROM_SHAPE_PANEL_SHAPE_LIST_COMPONENT

public static final int FROM_SHAPE_PANEL_SHAPE_LIST_COMPONENT

Part of FROM_SHAPE_PANEL that shows the shape list from which the visibility needs to be computed. It uses the properties TLcyVisibilityAddOn.FROM_SHAPE_LIST_KEY, TLcyVisibilityAddOn.FROM_SELECTED_SHAPE_KEY, and the shape's sub-property TLcyVisibilityBackEnd.DOMAIN_OBJECT_CONTEXT_KEY.

See Also:

• TLcyVisibilityAddOn.FROM_SELECTED_SHAPE_KEY
• Constant Field Values

TO_SHAPE_PANEL_SHAPE_LIST_COMPONENT

public static final int TO_SHAPE_PANEL_SHAPE_LIST_COMPONENT

Part of TO_SHAPE_PANEL that shows the shape list to which the visibility needs to be computed. It uses the properties TLcyVisibilityAddOn.TO_SHAPE_LIST_KEY, TLcyVisibilityAddOn.TO_SELECTED_SHAPE_KEY, and the shape's sub-property TLcyVisibilityBackEnd.DOMAIN_OBJECT_CONTEXT_KEY.

See Also:

• TLcyVisibilityAddOn.TO_SELECTED_SHAPE_KEY
• Constant Field Values

PROPAGATION_CHOICE_PANEL_QUALITY_COMPONENT

public static final int PROPAGATION_CHOICE_PANEL_QUALITY_COMPONENT

Part of PROPAGATION_CHOICE_PANEL that shows the quality component. It allows to choose the quality, storing it in the TLcyVisibilityAddOn.QUALITY_KEY property. The list to choose from is based on the property TLcyVisibilityAddOn.QUALITY_ITEMS_KEY.

See Also:

• Constant Field Values

PROPAGATION_CHOICE_PANEL_CURRENT_QUALITY_COMPONENT

public static final int PROPAGATION_CHOICE_PANEL_CURRENT_QUALITY_COMPONENT

Part of PROPAGATION_CHOICE_PANEL that shows a description for the TLcyVisibilityAddOn.QUALITY_KEY property. The description is based on the property TLcyVisibilityAddOn.QUALITY_DESCRIPTIONS_KEY.

See Also:

• Constant Field Values

PROPAGATION_CHOICE_PANEL_PROPAGATION_FUNCTION_COMPONENT

public static final int PROPAGATION_CHOICE_PANEL_PROPAGATION_FUNCTION_COMPONENT

Part of PROPAGATION_CHOICE_PANEL that shows the computation mode component. It uses the TLcyVisibilityAddOn.PROPAGATION_LIST_KEY and TLcyVisibilityAddOn.SELECTED_PROPAGATION_KEY properties, as well as TLcyVisibilityBackEnd.retrievePropagationFunctionLabel(java.lang.String).

See Also:

• TLcyVisibilityAddOn.SELECTED_PROPAGATION_KEY
• Constant Field Values

PROPAGATION_SETTINGS_PROPAGATION_FUNCTION_NORMAL_COMPONENT

public static final int PROPAGATION_SETTINGS_PROPAGATION_FUNCTION_NORMAL_COMPONENT

Part of PROPAGATION_CHOICE_PANEL that shows the settings specific to the normal propagation function.

See Also:

• Constant Field Values

PROPAGATION_SETTINGS_PROPAGATION_FUNCTION_SKY_BACKGROUND_COMPONENT

public static final int PROPAGATION_SETTINGS_PROPAGATION_FUNCTION_SKY_BACKGROUND_COMPONENT

Part of PROPAGATION_CHOICE_PANEL that shows the settings specific to the sky-in-background propagation function. It uses the selection propagation's TLcyVisibilityBackEnd.SKY_DISTANCE_KEY sub-property.

See Also:

• Constant Field Values

STYLE_PANEL_COLOR_UNKNOWN_COMPONENT

public static final int STYLE_PANEL_COLOR_UNKNOWN_COMPONENT

Part of STYLE_PANEL that shows the settings for unknown visibility results. It uses the TLcyVisibilityAddOn.COLOR_UNKNOWN_KEY property.

See Also:

• Constant Field Values

STYLE_PANEL_COLOR_INVISIBLE_COMPONENT

public static final int STYLE_PANEL_COLOR_INVISIBLE_COMPONENT

Part of STYLE_PANEL that shows the settings for invisible visibility results. It uses the TLcyVisibilityAddOn.COLOR_INVISIBLE_KEY property.

See Also:

• Constant Field Values

STYLE_PANEL_COLOR_VISIBLE_COMPONENT

public static final int STYLE_PANEL_COLOR_VISIBLE_COMPONENT

Part of STYLE_PANEL that shows the settings for visible visibility results. It uses the TLcyVisibilityAddOn.COLOR_VISIBLE_KEY property.

See Also:

• Constant Field Values

OUTPUT_PANEL_OUTPUT_FORMAT_COMPONENT

public static final int OUTPUT_PANEL_OUTPUT_FORMAT_COMPONENT

Part of OUTPUT_PANEL that shows the output format of the visibility results. It uses the TLcyVisibilityAddOn.OUTPUT_FORMAT_KEY property.

See Also:

• Constant Field Values

ACTION_PANEL_CREATE_LAYER_COMPONENT

public static final int ACTION_PANEL_CREATE_LAYER_COMPONENT

Part of ACTION_PANEL that shows the create layer button. It uses the CREATE_LAYER_ACTION to create that button.

See Also:

• Constant Field Values

ACTION_PANEL_UPDATE_LAYER_COMPONENT

public static final int ACTION_PANEL_UPDATE_LAYER_COMPONENT

Part of ACTION_PANEL that shows the update layer button. It uses the UPDATE_LAYER_ACTION to create that button.

See Also:

• Constant Field Values

ACTION_PANEL_AUTO_UPDATE_COMPONENT

public static final int ACTION_PANEL_AUTO_UPDATE_COMPONENT

Part of ACTION_PANEL that shows the auto-update component. It uses the UPDATE_LAYER_ACTION to create that component.

See Also:

• Constant Field Values

SWAP_PANEL_SWAP_SELECTED_FROM_SHAPE_COMPONENT

public static final int SWAP_PANEL_SWAP_SELECTED_FROM_SHAPE_COMPONENT

Part of SWAP_PANEL that swaps the shapes in the From list with the shapes in the To list. It uses the SWAP_SELECTED_FROM_SHAPE_ACTION to create that component.

See Also:

• Constant Field Values

SWAP_PANEL_SWAP_SELECTED_TO_SHAPE_COMPONENT

public static final int SWAP_PANEL_SWAP_SELECTED_TO_SHAPE_COMPONENT

Part of SWAP_PANEL that swaps the shapes in the From list with the shapes in the To list. It uses the SWAP_SELECTED_TO_SHAPE_ACTION to create that component.

See Also:

• Constant Field Values

SWAP_PANEL_SWAP_SHAPES_COMPONENT

public static final int SWAP_PANEL_SWAP_SHAPES_COMPONENT

Part of SWAP_PANEL that swaps the shapes in the From list with the shapes in the To list. It uses the SWAP_SHAPES_ACTION to create that component.

See Also:

• Constant Field Values

Constructor Details

TLcyVisibilityGUIFactory

public TLcyVisibilityGUIFactory(ILcyLucyEnv aLucyEnv)

Default constructor that builds all actions, component and panels.

Parameters:

aLucyEnv - the Lucy environment in which the GUI will be built

Method Details

createGUIContent

protected Component createGUIContent(ALcyProperties aProperties)

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<Component>

Parameters:

aProperties - properties that define the default preferences and values of the GUI elements. The properties are also changed by the GUI elements, according to the property names defined in TLcyVisibilityAddOn.

Returns:

the component containing all panels, layed out appropriately.

createAction

protected ILcdAction createAction(int aID,
 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<Component>

Parameters:

aID - 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<Component>

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 aID,
 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<Component>

Parameters:

aID - 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 aID,
 ALcyProperties aProperties)

Description copied from class: ALcyGUIFactory

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 == ... ) {
     ...
   }
 }
 

Specified by:

createPanel in class ALcyGUIFactory<Component>

Parameters:

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