org.eclipse.rse.ui.view.scratchpad
Class SystemScratchpadViewPart

java.lang.Object
  org.eclipse.core.commands.common.EventManager
      org.eclipse.ui.part.WorkbenchPart
          org.eclipse.ui.part.ViewPart
              org.eclipse.rse.ui.view.scratchpad.SystemScratchpadViewPart

All Implemented Interfaces:

EventListener, IAdaptable, IExecutableExtension, IPersistable, IRSEViewPart, ISelectionChangedListener, ISelectionListener, ISystemMessageLine, ISystemResourceChangeListener, IViewPart, IWorkbenchPart, IWorkbenchPart2, IWorkbenchPartOrientation

public class SystemScratchpadViewPart

extends ViewPart

implements ISelectionListener, ISelectionChangedListener, ISystemResourceChangeListener, ISystemMessageLine, IRSEViewPart

This class is the Remote Scratchpad view.

Field Summary

static String

ID

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

SystemScratchpadViewPart()

Method Summary

void	clearErrorMessage() Clears the currently displayed error message and redisplayes the message which was active before the error message was set.
void	clearMessage() Clears the currently displayed message.
void	createPartControl(Composite parent)
void	dispose()
void	fillLocalToolBar()
String	getErrorMessage() Get the currently displayed error text.
String	getMessage() Get the currently displayed message.
Viewer	getRSEViewer()
Shell	getShell() This is the method in your class that will be called to return the shell for your viewer
SystemMessage	getSystemErrorMessage() Get the currently displayed error text.
SystemScratchpadView	getViewer()
void	selectionChanged(IWorkbenchPart part, ISelection sel)
void	selectionChanged(SelectionChangedEvent e)
void	setErrorMessage(String message) Display the given error message.
void	setErrorMessage(SystemMessage message) Display the given error message.
void	setErrorMessage(Throwable exc) Display the given error message.
void	setFocus()
void	setInput(IAdaptable object)
void	setInput(IAdaptable object, String[] filters)
void	setMessage(String message) Set the message text.
void	setMessage(SystemMessage message) If the message line currently displays an error, the message is stored and will be shown after a call to clearErrorMessage
void	systemResourceChanged(ISystemResourceChangeEvent event) Used to asynchronously update the view whenever properties change.
void	updateActionStates()

Methods inherited from class org.eclipse.ui.part.ViewPart

checkSite, getViewSite, init, init, saveState, setContentDescription, setInitializationData, setPartName

Methods inherited from class org.eclipse.ui.part.WorkbenchPart

addPropertyListener, firePropertyChange, getAdapter, getConfigurationElement, getContentDescription, getDefaultImage, getOrientation, getPartName, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener, setSite, setTitle, setTitleImage, setTitleToolTip, showBusy

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ui.IWorkbenchPart

addPropertyListener, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

Constructor Detail

SystemScratchpadViewPart

public SystemScratchpadViewPart()

Method Detail

setFocus

public void setFocus()

Specified by:

setFocus in interface IWorkbenchPart

getViewer

public SystemScratchpadView getViewer()

getRSEViewer

public Viewer getRSEViewer()

Specified by:

getRSEViewer in interface IRSEViewPart

createPartControl

public void createPartControl(Composite parent)

Specified by:

createPartControl in interface IWorkbenchPart

selectionChanged

public void selectionChanged(IWorkbenchPart part,
                             ISelection sel)

Specified by:

selectionChanged in interface ISelectionListener

dispose

public void dispose()

Specified by:

dispose in interface IWorkbenchPart

updateActionStates

public void updateActionStates()

fillLocalToolBar

public void fillLocalToolBar()

selectionChanged

public void selectionChanged(SelectionChangedEvent e)

Specified by:

selectionChanged in interface ISelectionChangedListener

setInput

public void setInput(IAdaptable object)

setInput

public void setInput(IAdaptable object,
                     String[] filters)

systemResourceChanged

public void systemResourceChanged(ISystemResourceChangeEvent event)

Used to asynchronously update the view whenever properties change.

Specified by:

systemResourceChanged in interface ISystemResourceChangeListener

See Also:

ISystemResourceChangeEvent

getShell

public Shell getShell()

Description copied from interface: ISystemResourceChangeListener

This is the method in your class that will be called to return the shell for your viewer

Specified by:

getShell in interface ISystemResourceChangeListener

clearErrorMessage

public void clearErrorMessage()

Clears the currently displayed error message and redisplayes the message which was active before the error message was set.

Specified by:

clearErrorMessage in interface ISystemMessageLine

clearMessage

public void clearMessage()

Clears the currently displayed message.

Specified by:

clearMessage in interface ISystemMessageLine

getErrorMessage

public String getErrorMessage()

Get the currently displayed error text.

Specified by:

getErrorMessage in interface ISystemMessageLine

Returns:

The error message. If no error message is displayed null is returned.

getMessage

public String getMessage()

Get the currently displayed message.

Specified by:

getMessage in interface ISystemMessageLine

Returns:

The message. If no message is displayed null is returned.

setErrorMessage

public void setErrorMessage(String message)

Display the given error message. A currently displayed message is saved and will be redisplayed when the error message is cleared.

Specified by:

setErrorMessage in interface ISystemMessageLine

getSystemErrorMessage

public SystemMessage getSystemErrorMessage()

Get the currently displayed error text.

Specified by:

getSystemErrorMessage in interface ISystemMessageLine

Returns:

The error message. If no error message is displayed null is returned.

setErrorMessage

public void setErrorMessage(SystemMessage message)

Display the given error message. A currently displayed message is saved and will be redisplayed when the error message is cleared.

Specified by:

setErrorMessage in interface ISystemMessageLine

setErrorMessage

public void setErrorMessage(Throwable exc)

Display the given error message. A currently displayed message is saved and will be redisplayed when the error message is cleared.

Specified by:

setErrorMessage in interface ISystemMessageLine

setMessage

public void setMessage(String message)

Set the message text. If the message line currently displays an error, the message is stored and will be shown after a call to clearErrorMessage

Specified by:

setMessage in interface ISystemMessageLine

setMessage

public void setMessage(SystemMessage message)

If the message line currently displays an error, the message is stored and will be shown after a call to clearErrorMessage

Specified by:

setMessage in interface ISystemMessageLine