org.eclipse.rse.ui.model
Interface ISystemRegistryUI

All Superinterfaces:

ISystemShellProvider

public interface ISystemRegistryUI

extends ISystemShellProvider

Registry and control center for RSE UI related operations.

Method Summary

void	clearRunnableContext() Clear the current active runnable context to be used for a progress monitor.
void	expandHost(IHost conn) Select and expand the given connection in the RSE, if the RSE is the active perspective.
void	expandSubSystem(ISubSystem subsystem) Select and expand the given subsystem in the RSE, if the RSE is the active perspective.
boolean	getQualifiedHostNames() Are connection names to be qualified by profile name?
IRunnableContext	getRunnableContext() Return the current registered runnable context, or null if none registered.
Clipboard	getSystemClipboard() Returns the clipboard used for copy actions
List	getSystemClipboardObjects(int srcType) Returns the list of objects on the system clipboard
void	postEvent(ISystemResourceChangeEvent event) Notify all listeners of a change to a system resource such as a connection.
void	postEvent(ISystemResourceChangeListener listener, ISystemResourceChangeEvent event) Notify a specific listener of a change to a system resource such as a connection.
void	setQualifiedHostNames(boolean set) Set if connection names are to be qualified by profile name
void	setRunnableContext(Shell shell, IRunnableContext context) Set the current active runnable context to be used for a progress monitor by the subsystem methods that go to the host.
void	setShowFilterPools(boolean show) Reflect the user changing the preference for showing filter pools.
void	setShowNewHostPrompt(boolean show) Reflect the user changing the preference for showing new connection prompt
void	showRSEPerspective() Show the RSE perspective if it is not already showing

Methods inherited from interface org.eclipse.rse.ui.model.ISystemShellProvider

getShell

Method Detail

showRSEPerspective

public void showRSEPerspective()

Show the RSE perspective if it is not already showing

expandHost

public void expandHost(IHost conn)

Select and expand the given connection in the RSE, if the RSE is the active perspective.

Parameters:

conn - the host connection to expand

expandSubSystem

public void expandSubSystem(ISubSystem subsystem)

Select and expand the given subsystem in the RSE, if the RSE is the active perspective.

Parameters:

subsystem - the subsystem to expand

getSystemClipboard

public Clipboard getSystemClipboard()

Returns the clipboard used for copy actions

getSystemClipboardObjects

public List getSystemClipboardObjects(int srcType)

Returns the list of objects on the system clipboard

Parameters:

srcType - the transfer type

Returns:

the list of clipboard objects

getQualifiedHostNames

public boolean getQualifiedHostNames()

Are connection names to be qualified by profile name?

Since:

3.0

setQualifiedHostNames

public void setQualifiedHostNames(boolean set)

Set if connection names are to be qualified by profile name

Since:

3.0

setShowFilterPools

public void setShowFilterPools(boolean show)

Reflect the user changing the preference for showing filter pools.

Since:

3.0

setShowNewHostPrompt

public void setShowNewHostPrompt(boolean show)

Reflect the user changing the preference for showing new connection prompt

Since:

3.0

setRunnableContext

public void setRunnableContext(Shell shell,
                               IRunnableContext context)

Set the current active runnable context to be used for a progress monitor by the subsystem methods that go to the host. Called by wizards and dialogs that have a built-in progress monitor and hence removes the need to popup an intrusive pm dialog.

You must call clearRunnableContext when your dialog/wizard is disposed!

Parameters:

shell - The shell of the wizard/dialog. This is recorded so it can be tested if it is disposed before attempting to use the context

context - The dialog/wizard/view that implements IRunnableContext

clearRunnableContext

public void clearRunnableContext()

Clear the current active runnable context to be used for a progress monitor. Be sure to call this from you dispose method.

getRunnableContext

public IRunnableContext getRunnableContext()

Return the current registered runnable context, or null if none registered. Use this for long running operations instead of an intrusive progress monitor dialog as it is more user friendly. Many dialogs/wizards have these built in so it behooves us to use it.

postEvent

public void postEvent(ISystemResourceChangeEvent event)

Notify all listeners of a change to a system resource such as a connection. You would not normally call this as the methods in this class call it when appropriate.

This version calls fireEvent at the next reasonable opportunity, leveraging SWT's Display.asyncExec() method.

postEvent

public void postEvent(ISystemResourceChangeListener listener,
                      ISystemResourceChangeEvent event)

Notify a specific listener of a change to a system resource such as a connection.

This version calls fireEvent at the next reasonable opportunity, leveraging SWT's Display.asyncExec() method.