|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.dialogs.Dialog
com.ibm.etools.systems.core.ui.dialogs.SystemPromptDialog
com.ibm.etools.systems.core.ui.dialogs.SystemSelectConnectionDialog
Dialog for allowing users to select an existing connection, or optionally create a new one. * There are a number of methods to configure the dialog so only connections of a particular system type, * or containing subsystems from a particular subsystem factory or class of subsystem factories, are shown. *
* Call these methods to configure the functionality of the dialog *
or #setDefaultConnection(SystemConnection)
* setShowNewConnectionPrompt(boolean)
* setSystemTypes(String[])
* #setAutoExpandDepth(int)
* #setRootFolder(SystemConnection, String)
or #setRootFolder(IRemoteFile)
or #setPreSelection(IRemoteFile)
* #setFileTypes(String[])
or #setFileTypes(String)
* setShowPropertySheet(boolean)
* #enableAddMode(ISystemAddFileListener)
* setMultipleSelectionMode(boolean)
* #setSelectionValidator(IValidatorRemoteSelection)
* * Call these methods to configure the text on the dialog *
SystemPromptDialog.setMessage(String)
* #setSelectionTreeToolTipText(String)
* * After running, call these methods to get the output: *
* * @see com.ibm.etools.systems.files.ui.actions.SystemSelectRemoteFileAction * @see com.ibm.etools.systems.files.ui.actions.SystemSelectRemoteFolderAction
Field Summary | |
---|---|
static String |
copyright
|
static boolean |
FILE_MODE
|
static boolean |
FOLDER_MODE
|
Constructor Summary | |
---|---|
SystemSelectConnectionDialog(Shell shell)
Constructor * * @param shell The shell to hang the dialog off of * |
|
SystemSelectConnectionDialog(Shell shell,
String title)
Constructor when you want to supply your own title |
Method Summary | |
---|---|
boolean |
close()
We have to override close to ensure that we reset the form to null |
protected Control |
createInner(Composite parent)
Private method |
protected ISystemMessageLine |
createMessageLine(Composite c)
Create message line. |
protected SystemSelectConnectionForm |
getForm(Shell shell)
Private method |
protected Control |
getInitialFocusControl()
Private method |
boolean |
getMultipleSelectionMode()
Return the multiple selection mode as set by setMultipleSelectionMode(boolean) |
SystemConnection |
getSelectedConnection()
Return selected connection |
SystemConnection[] |
getSelectedConnections()
Return selected connections in multiple selection mode |
Object |
getSelectedObject()
Return selected file or folder |
Object[] |
getSelectedObjects()
Return all selected objects. |
protected boolean |
processDetails(boolean hideMode)
Private method |
protected boolean |
processOK()
Private method |
void |
setDefaultConnection(SystemConnection conn)
Set the connection to default the selection to |
void |
setInstructionLabel(String message)
Set the instruction label shown at the top of the dialog |
void |
setMultipleSelectionMode(boolean multiple)
Set multiple selection mode. |
void |
setPageComplete(boolean complete)
The callback method |
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)
Show the property sheet on the right hand side, to show the properties of the * selected object |
void |
setShowPropertySheet(boolean show,
boolean initialState)
Show the property sheet on the right hand side, to show the properties of the * selected object |
void |
setSystemType(String systemType)
Restrict to a certain system type * @param systemType the system type to restrict what connections are shown and what types of connections * the user can create * @see com.ibm.etools.systems.core.ISystemTypes |
void |
setSystemTypes(String[] systemTypes)
Restrict to certain system types * @param systemTypes the system types to restrict what connections are shown and what types of connections * the user can create * @see com.ibm.etools.systems.core.ISystemTypes |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String copyright
public static final boolean FILE_MODE
public static final boolean FOLDER_MODE
Constructor Detail |
public SystemSelectConnectionDialog(Shell shell)
public SystemSelectConnectionDialog(Shell shell, String title)
Method Detail |
public void setDefaultConnection(SystemConnection conn)
public void setSystemTypes(String[] systemTypes)
public void setSystemType(String systemType)
public void setShowNewConnectionPrompt(boolean show)
public void setInstructionLabel(String message)
public void setShowPropertySheet(boolean show)
* This overload always shows the property sheet *
* Default is false
public void setShowPropertySheet(boolean show, boolean initialState)
* This overload shows a Details>>> button so the user can decide if they want to see the * property sheet. *
* Default is true, false *
* @param show True if show the property sheet within the dialog * @param initialState True if the property is to be initially displayed, false if it is not * to be displayed until the user presses the Details button.
public void setMultipleSelectionMode(boolean multiple)
* If you turn on multiple selection mode, you must use the getSelectedObjects() * method to retrieve the list of selected objects. *
* Further, if you turn this on, it has the side effect of allowing the user * to select any remote object. The assumption being if you are prompting for * files, you also want to allow the user to select a folder, with the meaning * being that all files within the folder are implicitly selected. * * @see #getSelectedObjects()
public Object getSelectedObject()
public Object[] getSelectedObjects()
public SystemConnection getSelectedConnection()
public SystemConnection[] getSelectedConnections()
public boolean getMultipleSelectionMode()
protected Control getInitialFocusControl()
getInitialFocusControl
in class SystemPromptDialog
protected Control createInner(Composite parent)
createInner
in class SystemPromptDialog
protected SystemSelectConnectionForm getForm(Shell shell)
protected ISystemMessageLine createMessageLine(Composite c)
createMessageLine
in class SystemPromptDialog
protected boolean processOK()
* Called when user presses OK button. * Return true to close dialog. * Return false to not close dialog.
processOK
in class SystemPromptDialog
protected boolean processDetails(boolean hideMode)
* Called when user presses DETAILS button. *
* Note the text is automatically toggled for us! We need only * do whatever the functionality is that we desire * * @param hideMode the current state of the details toggle, prior to this request. If we return true from * this method, this state and the button text will be toggled. * * @return true if the details state toggle was successful, false if it failed.
processDetails
in class SystemPromptDialog
hideMode
- the current state of the details toggle, prior to this request. If you return true from
this method, this state and the button text will be toggled.
public boolean close()
close
in class SystemPromptDialog
public void setPageComplete(boolean complete)
SystemBaseForm#addPageCompleteListener(ISystemPageCompleteListener)
setPageComplete
in interface ISystemPageCompleteListener
setPageComplete
in class SystemPromptDialog
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |