The predefined interactors available in the equipment view are the following:

Each view interactor works with one equipment view only and is managed by the equipment controller. An equipment view can have several interactors, but only one interactor is active at a time.

With the default view interactors, you can:

View interactors have two modes of operation:

In transient mode, the view interactor removes itself from the equipment view when it has performed its action.

In permanent mode, the view interactor remains in the view until the controller removes it.

By default, view interactors are permanent.

View interactors can display a pop-up menu.

How to Wrap a Predefined View Interactor when Installing It

IlvManagerViewInteractor iltInteractor = new Ilt...Interactor();
IlpViewInteractor ilpInteractor =
  new IlpViewsViewInteractor(iltInteractor);
controller.setViewInteractor(ilpInteractor);

Setting the View Interactor

Some interactors are one-shot interactors, that is, they have the attribute permanent:false in CSS. When such an interactor finishes its interaction, it is replaced by the default view interactor.

View Interactor and Default View Interactor

The following example combines both methods:

// Configuring the default view interactor and making
// it active
IltSelectInteractor selInteractor = new IltSelectInteractor();
selInteractor.setEditingAllowed(true);
IlpViewsViewInteractor viewsInteractor = 
      new IlpViewsViewInteractor(selInteractor);
 
equipment.setDefaultViewInteractor(viewsInteractor);
equipment.setViewInteractor(viewsInteractor);

How to Associate an Action with a Mouse Event in the Equipment View

You can associate actions with mouse events by using either CSS or the API.

The following extract shows how to customize the default view interactor in CSS:

Equipment {
  interactor: true;
}
 
Interactor {
  viewInteractor: @+viewInt;
} 
 
Subobject#viewInt {
  class: 'ilog.cpl.graphic.views.IlpViewsViewInteractor';
  action[0]: @+viewAction0;
}
 
Subobject#viewAction0 {
  class: 'ilog.cpl.interactor.IlpGestureAction';
  gesture: BUTTON3_CLICKED;
  action: @+myAction;
}
 
Subobject#myAction {
  class: MyAction;
} 

The same configuration can be achieved through the API, as follows:

IlpEquipment equipment = // ...
 
// Retrieve the view interactor
IlpViewInteractor viewInteractor = equipment.getDefaultViewInteractor();
 
// Create an actionAction 
myAction = new MyAction();
 
// Clicking the 3rd mouse button will trigger myAction
viewInteractor.setGestureAction(IlpGesture.BUTTON3_CLICKED,myAction); 

You can also customize the actions that are associated with the interactors defined in the equipment component toolbar. This configuration is done with the toolbar button definition. The following CSS extract illustrates how this can be achieved:

How to Associate an Action with a Mouse Event for a Equipment ToolBar Button interactor

You can associate actions with mouse events when one of the interactors defined in the equipment component toolbar is active. The following CSS extract illustrates this configuration:

Equipment {
  toolbar: true;
}
 
ToolBar {
  enabled: true;
  button[0]: @+SelectButton;
}
 
Subobject#SelectButton {
  actionType: "Select";
  usingObjectInteractor: true;
  opaqueMove: true;
  action[0]: @+action0;
}
 
Subobject#action0 {
  gesture: BUTTON1_DOUBLE_CLICKED;
  class: "ShowDetailsAction";
}

In this configuration, the action "ShowDetailsAction" is triggered when a double-click event occurs while the selection interactor is set in the equipment view. You can define any list of actions associated with gestures by using the indexed property action. To be accepted by the CSS customization, the action class must be a JavaBean.

You can find out whether this event occurred on an IlpObject by means of the following code (which should be in the MyAction class):

How to Check whether a Given Action Occurred in the Equipment View Interactor

// Implementation of the ActionListener interface
public void actionPerformed(ActionEvent e) {
  // ILOG JTGO interactors use IlpViewActionEvent
  IlpViewActionEvent viewEvent = (IlpViewActionEvent)e;
  // Get the IlpObject (if any) where the interaction occurred
  IlpObject ilpObj = viewEvent.getIlpObject();
  // Perform operation on the given object
} 

How to Associate an Action with a Keyboard Event in the Equipment View

You can associate actions with keyboard events by using either CSS or the API.

The following extract shows how to proceed in CSS:

Equipment {
  interactor: true;
}  
 
Interactor {
  viewInteractor: @+viewInt;
}
 
Subobject#viewInt {
  class: 'ilog.cpl.graphic.views.IlpViewsViewInteractor';
  action[0]: @+viewAction0;
}
 
Subobject#viewAction0 {
  class: 'ilog.cpl.interactor.IlpKeyStrokeAction';
  keyStroke: 'typed D';
  action: @+myAction;
}
 
Subobject#myAction {
  class: MyAction;
} 

The same configuration can be achieved through the API, as follows:

// Create an actionAction myAction = new MyAction();
// Typing CTRL+D will trigger myAction
viewInteractor.setKeyStrokeAction(KeyStroke.getKeyStroke('D',java.awt.Event.CTRL_MASK),myAction); 

You can also customize the keystroke actions that are associated with the interactors defined in the equipment component toolbar. This configuration is performed with the toolbar button definition. The following CSS extract illustrates how this can be achieved:

How to Associate an Action with a Keyboard Event for a Equipment ToolBar Button interactor

You can associate actions with keyboard events when one of the interactors defined in the equipment component toolbar is active. The following CSS extract illustrates this configuration:

Equipment {
  toolbar: true;
}
 
ToolBar {
  enabled: true;
  button[0]: @+SelectButton;
}
 
Subobject#SelectButton {
  actionType: "Select";
  usingObjectInteractor: true;
  opaqueMove: true;
  action[0]: @+action0;
}
 
Subobject#action0 {
  key: "control A";
  class: "ilog.cpl.graph.action.IlpSelectAllObjectsAction";
}

In this configuration, the action "IlpSelectAllObjectsAction" is triggered when a Control-A keyboard event occurs while the selection interactor is set in the equipment view. You can define any list of actions associated with keyboard events by using the indexed property action. To be accepted by the CSS customization, the action class must be a JavaBean.

How to Define a Pop-up Menu Factory for the Equipment View

You can customize a pop-up menu factory for the equipment view either through CSS or through the API.

The following extract shows how to add a pop-up menu factory through CSS:

Equipment {
  interactor: true;
}
 
Interactor {
  viewInteractor: @+viewInt;
}
 
Subobject#viewInt {
  class: 'ilog.cpl.graphic.views.IlpViewsViewInteractor';
  popupMenuFactory: @+viewPopupMenuFactory;
}
 
Subobject#viewPopupMenuFactory {
  class: MyPopupMenuFactory;
} 

The same configuration can be achieved through the API, as follows:

// Subclass IlpAbstractPopupMenuFactory, which has useful shortcuts
IlpPopupMenuFactory popupMenuFactory = new IlpAbstractPopupMenuFactory() {
  // Add the identifier of each of the selected objects to the menu
  public JPopupMenu createPopupMenu (IlpObjectSelectionModel ilpSelectionModel)  {
    // Create an empty popup menu
    JPopupMenu menu = new JPopupMenu();
    // Access the selected objects from the selection model
    Collection selectedObjects = ilpSelectionModel.getSelectedObjects();
    // fill the menu according to the current selection
    return menu;
 
  }
}; 

The following code shows you how to associate the defined pop-up menu factory with the equipment component:

How to Associate a Pop-up Menu Factory with the Equipment Component

// Set the popup menu factory to the view interactor
viewInteractor.setPopupMenuFactory(popupMenuFactory); 

You can also customize a pop-up menu factory that is associated with the interactors defined in the equipment component toolbar. This configuration is performed with the toolbar button definition. The following CSS extract illustrates how this can be achieved:

How to Define a Pop-up Menu Factory for a Equipment Toolbar Button interactor

The following CSS extract illustrates this configuration:

Equipment {
  toolbar: true;
}
 
ToolBar {
  enabled: true;
  button[0]: @+SelectButton;
}
 
Subobject#SelectButton {
  actionType: "Select";
  usingObjectInteractor: true;
  opaqueMove: true;
  popupMenuFactory: @=viewPopupMenuFactory;
}
 
Subobject#viewPopupMenuFactory {
  class: 'AlarmPopupMenuFactory';
}

The pop-up menu factory is customized using property popupMenuFactory in the button configuration. To be accepted during the CSS customization, the pop-up menu factory class must be a JavaBean.

Selection Interactor

If setUsingObjectInteractor(true) is called on the interactor, then you can also:

You can configure the selection interactor to use Ctrl-click instead of Shift-click for multiple selection.

How to Configure the Selection Interactor for Multiple Selection in the Equipment View

In CSS, use the following rules:

Subobject#SelectButton {
  multipleSelectionModifier: "java.awt.event.InputEvent.CTRL_MASK";
  selectionModifier: "java.awt.event.InputEvent.SHIFT_MASK";
}

In the API, use the following code:

setMultipleSelectionModifier(InputEvent.CTRL_MASK);
setSelectionModifer(InputEvent.SHIFT_MASK);

Group Reshape Interactor

For polygonal and linear groups:

Make Rectangular Node Interactor

Make Polygonal Node Interactor

Make Polyline Node Interactor

Make Link Interactor