Package org.eclipse.remote.ui
Interface IRemoteUIFileService
- All Superinterfaces:
IRemoteConnectionType.Service
- All Known Implementing Classes:
RemoteUIFileService
Interface for providing file management operations in the UI. Clients can call these methods to open generic dialogs for
operations on remote resources.
- Since:
- 2.0
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.eclipse.remote.core.IRemoteConnectionType.Service
IRemoteConnectionType.Service.Factory -
Method Summary
Modifier and TypeMethodDescriptionbrowseDirectory(org.eclipse.swt.widgets.Shell shell, String message, String initialPath, int flags) Browse for a remote directory.browseFile(org.eclipse.swt.widgets.Shell shell, String message, String initialPath, int flags) Browse for a remote file.browseFiles(org.eclipse.swt.widgets.Shell shell, String message, String initialPath, int flags) Browse for a set of remote files.Get the last connection that was selected in the browser.voidsetConnection(IRemoteConnection connection) Set the connection to use for file browsing.voidshowConnections(boolean enable) Show a list of available connections if possible.Methods inherited from interface org.eclipse.remote.core.IRemoteConnectionType.Service
getConnectionType
-
Method Details
-
browseDirectory
String browseDirectory(org.eclipse.swt.widgets.Shell shell, String message, String initialPath, int flags) Browse for a remote directory. The return value is the path of the directory on the remote system. Equivalent toDirectoryDialog.- Parameters:
shell- workbench shellmessage- message to display in dialoginitialPath- initial path to use when displaying filesflags- 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
String browseFile(org.eclipse.swt.widgets.Shell shell, String message, String initialPath, int flags) Browse for a remote file. The return value is the path of the file on the remote system. Equivalent toFileDialog.- Parameters:
shell- workbench shellmessage- message to display in dialoginitialPath- initial path to use when displaying filesflags- 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
List<String> browseFiles(org.eclipse.swt.widgets.Shell shell, String message, String initialPath, int flags) Browse for a set of remote files. The return value is a list of paths of the files on the remote system. Equivalent toFileDialog.- Parameters:
shell- workbench shellmessage- message to display in dialoginitialPath- initial path to use when displaying filesflags- options settings for dialog (@see IRemoteUIConstants) valid values are NONE, SAVE, or OPEN (@see IRemoteUIConstants)- Returns:
- list of paths to the files 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
Set the connection to use for file browsing. The connection must support the IRemoteFileService service or it will be ignored.- 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
-