org.eclipse.ptp.remote.ui.widgets
Class RemoteDirectoryWidget

java.lang.Object
  Composite
      org.eclipse.ptp.remote.ui.widgets.RemoteDirectoryWidget

public class RemoteDirectoryWidget
extends Composite

Widget to allow the user to select a remote directory. Provides a "Browse" button that uses the currently specified connection and a "Restore Default" button to revert to the initial setting. If title is supplied then the widget will be placed in a group. The browse message can be modified using setBrowseMessage(String)

Constructor Summary

RemoteDirectoryWidget(Composite parent, int style, java.lang.String title, java.lang.String defaultPath)

Method Summary

void	addModifyListener(ModifyListener listener) Add a listener that will be notified when the directory path is modified.
java.lang.String	getLocationPath() Get the directory location path.
void	removeModifyListener(ModifyListener listener) Remove a listener that will be notified when the directory path is modified.
void	setBrowseMessage(java.lang.String message) Set the message that will be displayed in the remote directory browser dialog.
void	setConnection(IRemoteConnection conn) Set the remote connection to use for browsing for the remote directory.
void	setLocationPath(java.lang.String path) Set the initial remote location that will be displayed in the widget.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteDirectoryWidget

public RemoteDirectoryWidget(Composite parent,
                             int style,
                             java.lang.String title,
                             java.lang.String defaultPath)

Method Detail

addModifyListener

public void addModifyListener(ModifyListener listener)

Add a listener that will be notified when the directory path is modified.

Parameters:

listener - listener to add

getLocationPath

public java.lang.String getLocationPath()

Get the directory location path. This path will be relative to the remote machine.

Returns:

directory location path

removeModifyListener

public void removeModifyListener(ModifyListener listener)

Remove a listener that will be notified when the directory path is modified.

Parameters:

listener - listener to remove

setBrowseMessage

public void setBrowseMessage(java.lang.String message)

Set the message that will be displayed in the remote directory browser dialog.

Parameters:

message - message to be displayed

setConnection

public void setConnection(IRemoteConnection conn)

Set the remote connection to use for browsing for the remote directory.

Parameters:

conn - remote connection

Since:

4.0

setLocationPath

public void setLocationPath(java.lang.String path)

Set the initial remote location that will be displayed in the widget.

Parameters:

path -