org.eclipse.ptp.remote.ui
Interface IRemoteUIFileManager

public interface IRemoteUIFileManager

Interface for providing file management operations in the UI. Clients can call these methods to open generic dialogs for operations on remote resources.

Method Summary

java.lang.String	browseDirectory(org.eclipse.swt.widgets.Shell shell, java.lang.String message, java.lang.String initialPath, int flags) Browse for a remote directory.
java.lang.String	browseFile(org.eclipse.swt.widgets.Shell shell, java.lang.String message, java.lang.String initialPath, int flags) Browse for a remote file.
java.lang.String[]	browseFiles(org.eclipse.swt.widgets.Shell shell, java.lang.String message, java.lang.String initialPath, int flags) Browse for a set of remote files.
IRemoteConnection	getConnection() Get the last connection that was selected in the browser.
void	setConnection(IRemoteConnection connection) Set the connection to use for file browsing
void	showConnections(boolean enable) Show a list of available connections if possible.

Method Detail

browseDirectory

java.lang.String browseDirectory(org.eclipse.swt.widgets.Shell shell,
                                 java.lang.String message,
                                 java.lang.String initialPath,
                                 int flags)

Browse for a remote directory. The return value is the path of the directory on the remote system. Equivalent to DirectoryDialog.

Parameters:

shell - workbench shell

message - message to display in dialog

initialPath - initial path to use when displaying files

flags - option settings for dialog (not currently used) valid values are NONE (@see IRemoteUIConstants)

Returns:

the path to the directory relative to the remote system or null if the browser was cancelled

browseFile

java.lang.String browseFile(org.eclipse.swt.widgets.Shell shell,
                            java.lang.String message,
                            java.lang.String initialPath,
                            int flags)

Browse for a remote file. The return value is the path of the file on the remote system. Equivalent to FileDialog.

Parameters:

shell - workbench shell

message - message to display in dialog

initialPath - initial path to use when displaying files

flags - options settings for dialog valid values are NONE, SAVE, or OPEN (@see IRemoteUIConstants)

Returns:

the path to the file relative to the remote system or null if the browser was cancelled

browseFiles

java.lang.String[] browseFiles(org.eclipse.swt.widgets.Shell shell,
                               java.lang.String message,
                               java.lang.String initialPath,
                               int flags)

Browse for a set of remote files. The return value is an array of paths of the files on the remote system. Equivalent to FileDialog.

Parameters:

shell - workbench shell

message - message to display in dialog

initialPath - initial path to use when displaying files

flags - options settings for dialog (@see IRemoteUIConstants) valid values are NONE, SAVE, or OPEN (@see IRemoteUIConstants)

Returns:

the path to the file relative to the remote system or null if the browser was cancelled

getConnection

IRemoteConnection getConnection()

Get the last connection that was selected in the browser.

Returns:

selected connection

setConnection

void setConnection(IRemoteConnection connection)

Set the connection to use for file browsing

Parameters:

connection - connection to use for file browsing

showConnections

void showConnections(boolean enable)

Show a list of available connections if possible.

Parameters:

enable - enable connection list