com.luciad.lucy.addons.tea.extremepoint

LuciadLightspeedClass TLcyExtremePointGUIFactory

java.lang.Object

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

com.luciad.lucy.addons.tea.extremepoint.TLcyExtremePointGUIFactory

public class TLcyExtremePointGUIFactory
extends ALcyGUIFactory<Component>

Determines the GUI elements to add to the extreme points 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 and Description
static int	ACTION_PANEL The id for creating the action panel.
static int	ACTION_PANEL_AUTO_UPDATE_COMPONENT Part of ACTION_PANEL that shows the auto-update component.
static int	ACTION_PANEL_CREATE_LAYER_COMPONENT Part of ACTION_PANEL that shows the create layer button.
static int	ACTION_PANEL_UPDATE_LAYER_COMPONENT Part of ACTION_PANEL that shows the update layer button.
static int	CREATE_LAYER_ACTION The id for creating the action that creates a new layer.
static int	INPUT_PANEL The id for creating the input panel.
static int	INPUT_PANEL_CURRENT_QUALITY_COMPONENT Part of INPUT_PANEL that shows a description for the TLcyExtremePointAddOn.QUALITY_KEY property.
static int	INPUT_PANEL_EXTREME_POINT_COUNT_COMPONENT Part of INPUT_PANEL that shows the extreme point count component.
static int	INPUT_PANEL_EXTREME_POINT_MODE_COMPONENT Part of INPUT_PANEL that shows the extreme point mode component.
static int	INPUT_PANEL_QUALITY_COMPONENT Part of INPUT_PANEL that shows the quality component.
static int	INPUT_PANEL_SEPARATION_DISTANCE_COMPONENT Part of INPUT_PANEL that shows the separation distance component.
static int	INPUT_PANEL_SEPARATION_HEIGHT_COMPONENT Part of INPUT_PANEL that shows the separation height component.
static int	SHAPE_PANEL The id for creating the shape panel.
static int	SHAPE_PANEL_SHAPE_LIST_COMPONENT Part of SHAPE_PANEL that shows the shape list for which the extreme points need to be computed.
static int	UPDATE_LAYER_ACTION The id for creating the action that computes the contours.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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 Detail

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 contours. When the Update button is pressed, the GUI properties starting with "TLcyExtremePointAddOn.layer.tea." are stored for the selected TEA layer (see TLcyExtremePointAddOn.LINKED_LAYER_KEY), and a new extreme point calculation starts.

This calculation interacts with the back-end as follows:

• an altitude provider is retrieved using the GUI's TLcyExtremePointAddOn.QUALITY_KEY property
• a referenced matrix view is created for the map's selected objects, using the GUI's TLcyExtremePointAddOn.QUALITY_KEY property
• an extreme point finder is created and used to insert the extreme points in the linked layer.

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

See Also:

Constant Field Values

SHAPE_PANEL

public static final int SHAPE_PANEL

The id for creating the shape panel. It allows to choose the shapes for which the extreme points need to be computed.

See Also:

Constant Field Values

INPUT_PANEL

public static final int INPUT_PANEL

The id for creating the input panel. The input panel allows to choose the quality and the extreme point calculation settings.

See Also:

Constant Field Values

ACTION_PANEL

public static final int ACTION_PANEL

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

See Also:

Constant Field Values

SHAPE_PANEL_SHAPE_LIST_COMPONENT

public static final int SHAPE_PANEL_SHAPE_LIST_COMPONENT

Part of SHAPE_PANEL that shows the shape list for which the extreme points need to be computed. It uses the properties TLcyExtremePointAddOn.SHAPE_LIST_KEY and TLcyExtremePointAddOn.SELECTED_SHAPE_KEY, and the coverage's sub-property TLcyExtremePointBackEnd.DOMAIN_OBJECT_CONTEXT_KEY.

See Also:

TLcyExtremePointAddOn.SELECTED_SHAPE_KEY, Constant Field Values

INPUT_PANEL_EXTREME_POINT_MODE_COMPONENT

public static final int INPUT_PANEL_EXTREME_POINT_MODE_COMPONENT

Part of INPUT_PANEL that shows the extreme point mode component. It uses the TLcyExtremePointAddOn.EXTREME_POINT_MODE_KEY property.

See Also:

Constant Field Values

INPUT_PANEL_EXTREME_POINT_COUNT_COMPONENT

public static final int INPUT_PANEL_EXTREME_POINT_COUNT_COMPONENT

Part of INPUT_PANEL that shows the extreme point count component. It uses the TLcyExtremePointAddOn.EXTREME_POINT_COUNT_KEY property.

See Also:

Constant Field Values

INPUT_PANEL_QUALITY_COMPONENT

public static final int INPUT_PANEL_QUALITY_COMPONENT

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

See Also:

Constant Field Values

INPUT_PANEL_CURRENT_QUALITY_COMPONENT

public static final int INPUT_PANEL_CURRENT_QUALITY_COMPONENT

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

See Also:

Constant Field Values

INPUT_PANEL_SEPARATION_HEIGHT_COMPONENT

public static final int INPUT_PANEL_SEPARATION_HEIGHT_COMPONENT

Part of INPUT_PANEL that shows the separation height component. The separation value uses the property TLcyExtremePointAddOn.SEPARATION_HEIGHT_KEY.

See Also:

Constant Field Values

INPUT_PANEL_SEPARATION_DISTANCE_COMPONENT

public static final int INPUT_PANEL_SEPARATION_DISTANCE_COMPONENT

Part of INPUT_PANEL that shows the separation distance component. The separation value uses the property TLcyExtremePointAddOn.SEPARATION_DISTANCE_KEY.

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

Constructor Detail

TLcyExtremePointGUIFactory

public TLcyExtremePointGUIFactory(ILcyLucyEnv aLucyEnv)

Default constructor that builds all actions, component and panels.

Parameters:

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

Method Detail

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

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.