IBM DB2 UDB
Plugin Interface
for Extending the Control Center

com.ibm.db2.tools.cc.navigator
Interface MultiSelectable


public interface MultiSelectable

The MultiSelectable interface is to be used by implementers of CCMenuAction to specify when a plugin menu item should appear in a menu.

Some actions can apply when multiple objects of the same type are selected at the same time. If your CCMenuAction applies when multiple objects are selected, implement this interface.

See Also:
CCMenuAction

Field Summary
static int MULTI_HANDLE_FOCUSED
          The action is available only if the object is selected and has focus.
static int MULTI_HANDLE_MULTI
          The action is available if it can be performed against all the selected objects.
static int MULTI_HANDLE_NONE
          The action is available only if the object containing this action is selected.
static int MULTI_HANDLE_ONE
          The action is available if it can be performed against all the selected objects.
 
Method Summary
 int getSelectionMode()
          Specifies when and on which objects this action applies.
 

Field Detail

MULTI_HANDLE_NONE

public static final int MULTI_HANDLE_NONE
The action is available only if the object containing this action is selected. This is the default selection mode.

See Also:
Constant Field Values

MULTI_HANDLE_ONE

public static final int MULTI_HANDLE_ONE
The action is available if it can be performed against all the selected objects. There will be a single handler for all the selected objects.

See Also:
Constant Field Values

MULTI_HANDLE_MULTI

public static final int MULTI_HANDLE_MULTI
The action is available if it can be performed against all the selected objects. There will be a separate handler for each selected object.

Note: This selection mode is discouraged in the Control Center user interface.

See Also:
Constant Field Values

MULTI_HANDLE_FOCUSED

public static final int MULTI_HANDLE_FOCUSED
The action is available only if the object is selected and has focus. Even if the action appears when multiple objects are selected, it will be performed only against the focused object.

See Also:
Constant Field Values
Method Detail

getSelectionMode

public int getSelectionMode()
Specifies when and on which objects this action applies. This action can apply to only the first selected object (MULTI_HANDLE_NONE), to all selected objects (MULTI_HANDLE_ONE or MULTI_HANDLE_MULTI), or to only the first selected and focused object (MULTI_HANDLE_FOCUSED).

Returns:
One of four possible values that specify when and on which objects this action applies.

IBM DB2 UDB
Plugin Interface
for Extending the Control Center

(C)Copyright IBM Corp. 2002, 2004. All rights reserved.

Links on this page are made available for your convenience and may take you to non-IBM sites. IBM does not warrant any sample code provided on these sites.