ilog.views.maps.symbology.swing

Interface IlvSymbologyTreeViewActions

All Superinterfaces:

IlvPersistentSDMNodeFactory

All Known Implementing Classes:

IlvAbstractGroupTreeViewActions, IlvApp6aSymbologyTreeViewActions

public interface IlvSymbologyTreeViewActions
extends IlvPersistentSDMNodeFactory

IlvSymbologyTreeViewActions provides the actions to create symbols, edit symbols or edit the entire symbology. It must be installed at the IlvSymbologyTreeView to make the symbology editable by the tree view.

Note: This class was in the ilog.views.maps.defense.symbology.swing package in previous versions of JViews Maps for Defense.

Since:

JViews 8.5

Method Summary

Modifier and Type	Method and Description
void	actOnSymbologyChanged() Should be called by the symbology editors when symbology has changed.
void	createGroup(IlvSDMModel model, Object parentgroup, IlvApplyObject applier) Creates a new group interactively.
void	createSymbol(IlvSDMModel model, Object group, IlvApplyObject applier) Creates a new symbol interactively.
Object	dropSymbolAt(IlvSDMModel model, Object data, Double lonRad, Double latRad) Acts on symbol data dropped on the view.
Object	duplicateSymbol(IlvSDMModel model, Object node) Duplicates the input symbol.
void	editGroup(IlvSDMModel model, Object group, IlvApplyObject applier) Edits a specific group.
void	editSymbol(IlvSDMModel model, Object node, IlvApplyObject applier) Edits a specific symbol.
void	editSymbology(IlvSDMModel model, IlvApplyObject applier) Edits the entire symbology as a whole.
boolean	isCreateGroupEnabled(IlvSDMModel model) Returns true if the method createGroup is enabled.
boolean	isCreateSymbolEnabled(IlvSDMModel model) Returns true if the method createSymbol is enabled.
boolean	isDuplicateSymbolEnabled(IlvSDMModel model) Returns true if the method duplicateSymbol is enabled.
boolean	isEditGroupEnabled(IlvSDMModel model) Returns true if the method editGroup is enabled.
boolean	isEditSymbolEnabled(IlvSDMModel model) Returns true if the method editSymbol is enabled.
boolean	isEditSymbologyEnabled(IlvSDMModel model) Returns true if the method editSymbology is enabled.
void	setView(IlvSymbologyTreeView view) Sets the symbology tree view that uses these actions.

Methods inherited from interface ilog.views.maps.symbology.swing.IlvPersistentSDMNodeFactory

getPersistentContext, isPropertyIgnored, newSymbol, setPersistentContext

Method Detail

setView

void setView(IlvSymbologyTreeView view)

Sets the symbology tree view that uses these actions.

Parameters:

view - symbology tree view

editSymbology

void editSymbology(IlvSDMModel model,
                   IlvApplyObject applier)

Edits the entire symbology as a whole. For instance, a symbology might use a library of icons, and this method allows the replacement of the library of icons. This method is called by the symbology tree view when the user double-clicks the root node.

Parameters:

model - The symbol model of the symbology

applier - The apply object to be called when the symbology changes

isEditSymbologyEnabled

boolean isEditSymbologyEnabled(IlvSDMModel model)

Returns true if the method editSymbology is enabled.

Parameters:

model - The symbol model

Returns:

true if the operation is allowed

createSymbol

void createSymbol(IlvSDMModel model,
                  Object group,
                  IlvApplyObject applier)

Creates a new symbol interactively. This method is called by the symbology tree view when the user clicks the Create button to add a symbol. A typical implementation opens a dialog box that allows the user to enter the name and properties of the symbol. Then it calls model.createNode() to create the new symbol and sets the symbol properties. It adds the new symbol using model.addObject and sets its group using model.setGroup. Finally, it must call applier.apply(null, symbol) to update the symbol tree panel.

Here is a simple sample implementation:

 public void createSymbol(IlvSDMModel model, Object group, IlvApplyObject applier) {
   Object node = newSymbol("symbol");
   model.setObjectProperty(node, "name", "NewSymbol");
   model.addObject(node, null, null);
   model.setGroup(node, group);
   applier.apply(null, node);
 }
 

Parameters:

model - The symbol model to which the new symbol will belong

group - The group of the new symbol or null

applier - The apply object to be called when the symbol is created

isCreateSymbolEnabled

boolean isCreateSymbolEnabled(IlvSDMModel model)

Returns true if the method createSymbol is enabled.

Parameters:

model - The symbol model

Returns:

true if the operation is allowed

createGroup

void createGroup(IlvSDMModel model,
                 Object parentgroup,
                 IlvApplyObject applier)

Creates a new group interactively. This method is called by the symbology tree view when user clicks the Create button to add a group. A typical implementation opens a dialog box that allows the user to enter the name and properties of the group. Then it calls model.createGroup() to create the new group and sets the group properties. It adds the new group using model.addRootGroup or model.setGroup. Finally, it must call applier.apply(null, symbol) to update the symbol tree panel.

Here is a simple sample implementation:

 public void createGroup(IlvSDMModel model, IlvApplyObject applier) {
   Object group = model.createGroup("group");
   model.setObjectProperty(group, "name", "NewGroup");
   if (parentGroup == null)
     model.addRootGroup(group);
   else
     model.setGroup(group, parentGroup);
   applier.apply(null, group);
 }
 

Parameters:

model - The symbol model to which the new group will belong

parentgroup - The parent group of the new group, or null

applier - The apply object to be called when the group is created

isCreateGroupEnabled

boolean isCreateGroupEnabled(IlvSDMModel model)

Returns true if the method createGroup is enabled.

Parameters:

model - The symbol model

Returns:

true if the operation is allowed

editSymbol

void editSymbol(IlvSDMModel model,
                Object node,
                IlvApplyObject applier)

Edits a specific symbol. This method is called by the symbology tree view when the user clicks the Edit button to edit a selected symbol. A typical implementation opens a dialog box that allows the user to change the properties of the symbol. Finally, it must call applier.apply(null, symbol).

Here is a simple sample implementation:

 public void editSymbol(IlvSDMModel model, Object node, IlvApplyObject applier) {
   model.setObjectProperty(node, "name", "NewName");
   applier.apply(null, node);
 }
 

Parameters:

model - The symbol model to which the symbol will belong.

node - The symbol model node to be edited.

applier - The apply object to be called when the symbol is changed.

isEditSymbolEnabled

boolean isEditSymbolEnabled(IlvSDMModel model)

Returns true if the method editSymbol is enabled.

Parameters:

model - The symbol model

Returns:

true if the operation is allowed

editGroup

void editGroup(IlvSDMModel model,
               Object group,
               IlvApplyObject applier)

Edits a specific group. This method is called by the symbology tree view when the user clicks the Edit button to edit a selected group. A typical implementation opens a dialog box that allows the user to change the properties of the group. Finally, it must call applier.apply(null, group).

Here is a simple sample implementation:

 public void editGroup(IlvSDMModel model, Object group, IlvApplyObject applier) {
   model.setObjectProperty(group, "name", "NewGroupName");
   applier.apply(null, group);
 }
 

Parameters:

model - The symbol model to which the symbol will belong

group - The symbol model group to be edited

applier - The apply object to be called when the group is changed

isEditGroupEnabled

boolean isEditGroupEnabled(IlvSDMModel model)

Returns true if the method editGroup is enabled.

Parameters:

model - The symbol model

Returns:

true if the operation is allowed

duplicateSymbol

Object duplicateSymbol(IlvSDMModel model,
                       Object node)

Duplicates the input symbol. This should also duplicate all necessary properties of the symbol. The duplicated symbol has not yet been added to the symbol model.

Parameters:

model - The symbol model to which the new symbol will belong

node - The symbol model node to be duplicated

Returns:

The symbol model node that has been created

isDuplicateSymbolEnabled

boolean isDuplicateSymbolEnabled(IlvSDMModel model)

Returns true if the method duplicateSymbol is enabled.

Parameters:

model - The symbol model

Returns:

true if the operation is allowed

actOnSymbologyChanged

void actOnSymbologyChanged()

Should be called by the symbology editors when symbology has changed. This method should make sure all symbols currently in the model respect the new symbology definition.

dropSymbolAt

Object dropSymbolAt(IlvSDMModel model,
                    Object data,
                    Double lonRad,
                    Double latRad)

Acts on symbol data dropped on the view.

Parameters:

model - The model to drop symbol into.

data - Transferable data as per Transferable.getTransferData(java.awt.datatransfer.DataFlavor).

lonRad - Latitude in radians matching the mouse cursor for the drop.

latRad - Longitude in radians matching the mouse cursor for the drop.

Returns:

The object created if the drop succeeded