Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.rse.ui.actions.select
Interface IIBMiSelectAction

All Known Subinterfaces:
IQSYSSelectCommandAction, IQSYSSelectFieldAction, IQSYSSelectFileAction, IQSYSSelectLibraryAction, IQSYSSelectMemberAction, IQSYSSelectObjectAction
All Known Implementing Classes:
ClBrowseCommandDialog, QSYSSelectAbstractAction, QSYSSelectCommandAction, QSYSSelectFieldAction, QSYSSelectFileObjectAction, QSYSSelectLibraryAction, QSYSSelectMemberAction, QSYSSelectObjectAction, QSYSSelectProgramModuleAction

public interface IIBMiSelectAction

An interface shared by all IBM i select actions


Field Summary
static String Copyright
           
 
Method Summary
 void addFilter(String filterString)
          Add a filter that users can expand to start their search
 void addLibraryFilter(String filterString)
          Add a library filter that users can expand to start their search.
 Object getSelected()
          Return selected ISeriesXXX object
 IHost getSelectedConnection()
          Return selected connection
 String getSelectedLibraryName()
          Get the name of the selected library or library containing the selected object
 String getSelectedName()
          Return name of selected object
 Object[] getSelectedObjects()
          Return all selected objects.
 void reset()
          Reset all attributes to initial values.
 void setDefaultConnection(IHost conn)
          Set the default connection to preselect and expand
 void setDialogTitle(String title)
          Set the dialog title.
 void setMessage(String message)
          Set the verbage shown at the top.
 void setMultipleSelectionMode(boolean multiple)
           
 void setSelectionTreeToolTipText(String tip)
          Set the tooltip text for the remote systems tree from which an item is selected.
 void setShowNewConnectionPrompt(boolean show)
          Set to true if a "New Connection..." special connection is to be shown for creating new connections
 void setShowPropertySheet(boolean show, boolean showByDefault)
          Specify whether to show a details>> button that allows display of a property sheet within the dialog.
 void setShowYourLibrariesPrompt(boolean show)
          Set to false to not show "YourLibraries..." special filter prompt
 void setSystemConnection(IHost conn)
          Set the system connection to restrict the user to seeing objects in
 

Field Detail

Copyright

static final String Copyright
See Also:
Constant Field Values
Method Detail

setSystemConnection

void setSystemConnection(IHost conn)
Set the system connection to restrict the user to seeing objects in


setDefaultConnection

void setDefaultConnection(IHost conn)
Set the default connection to preselect and expand


setShowNewConnectionPrompt

void setShowNewConnectionPrompt(boolean show)
Set to true if a "New Connection..." special connection is to be shown for creating new connections


setShowYourLibrariesPrompt

void setShowYourLibrariesPrompt(boolean show)
Set to false to not show "YourLibraries..." special filter prompt


addFilter

void addFilter(String filterString)
Add a filter that users can expand to start their search


addLibraryFilter

void addLibraryFilter(String filterString)
Add a library filter that users can expand to start their search. This is just a specialization of addFilter(String)


setShowPropertySheet

void setShowPropertySheet(boolean show,
                          boolean showByDefault)
Specify whether to show a details>> button that allows display of a property sheet within the dialog. Second parm specifies if the property sheet should be shown by default or not.


reset

void reset()
Reset all attributes to initial values. Useful when reusing an action object


setDialogTitle

void setDialogTitle(String title)
Set the dialog title. Must be called prior to run().


setMessage

void setMessage(String message)
Set the verbage shown at the top. Default is "Browse for object"


setSelectionTreeToolTipText

void setSelectionTreeToolTipText(String tip)
Set the tooltip text for the remote systems tree from which an item is selected.


getSelectedName

String getSelectedName()
Return name of selected object


getSelectedConnection

IHost getSelectedConnection()
Return selected connection


getSelectedLibraryName

String getSelectedLibraryName()
Get the name of the selected library or library containing the selected object


getSelected

Object getSelected()
Return selected ISeriesXXX object


getSelectedObjects

Object[] getSelectedObjects()
Return all selected objects. This method will return an array of one unless you have called setMultipleSelectionMode(true)!

It will always return null if the user cancelled the dialog.

See Also:
setMultipleSelectionMode(boolean)

setMultipleSelectionMode

void setMultipleSelectionMode(boolean multiple)

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.