org.eclipse.rse.ui.model
Interface ISystemRegistryUI

All Superinterfaces:

ISystemShellProvider

public interface ISystemRegistryUI
extends ISystemShellProvider

Registry and control center for RSE UI related operations.

This interface is not intended to be implemented by clients.

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.
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	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	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

void showRSEPerspective()

Show the RSE perspective if it is not already showing

expandHost

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

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

Clipboard getSystemClipboard()

Returns the clipboard used for copy actions

getSystemClipboardObjects

List getSystemClipboardObjects(int srcType)

Returns the list of objects on the system clipboard

Parameters:

srcType - the transfer type

Returns:

the list of clipboard objects

setRunnableContext

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

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

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

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

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.