org.eclipse.rse.ui.view.search
Class SystemSearchViewPart

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

All Implemented Interfaces:

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

public class SystemSearchViewPart

extends ViewPart

implements ISystemResourceChangeListener, IMenuListener, ISelectionChangedListener, ISystemMessageLine, IRSEViewPart

This class defines the Remote Search view.

Nested Class Summary

class	SystemSearchViewPart.CancelAction
class	SystemSearchViewPart.SystemSearchDoubleClickListener Double click listener.

Field Summary

Fields inherited from interface org.eclipse.ui.IWorkbenchPart

PROP_TITLE

Constructor Summary

SystemSearchViewPart()
Constructor for SystemSearchViewPart.

Method Summary

void	addSearchResult(IAdaptable resultSet) Add a search result set.
void	addSelectionChangedListener(ISelectionChangedListener listener)
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)
boolean	deleteAllPages() Deletes all the pages in the view.
boolean	deleteCurrentPage() Deletes the current page.
boolean	deleteSelected() Delete the selected object in the view.
void	dispose()
void	fillContextMenu(IMenuManager menu) Fill context for the tree view pop-up menu.
ISystemViewElementAdapter	getAdapter(Object element) Get the adapter for the given object.
StructuredViewer	getCurrentViewer() Gets the current viewer, i.e. the viewer whose control is being currently displayed in the view.
String	getErrorMessage() Get the currently displayed error text.
String	getMessage() Get the currently displayed message.
Viewer	getRSEViewer()
ISelection	getSelection() Returns the current selection for this provider.
Shell	getShell() Get the shell.
SystemMessage	getSystemErrorMessage() Get the currently displayed error text.
void	init(IViewSite site, IMemento memento)
void	menuAboutToShow(IMenuManager menu) Called when the context menu is about to open.
void	removeSelectionChangedListener(ISelectionChangedListener listener) Removes the given selection change listener from this selection provider.
boolean	sameParent() This is called to ensure all elements in a multiple-selection have the same parent in the tree viewer.
void	saveState(IMemento memento)
void	selectionChanged(SelectionChangedEvent event)
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	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	setSelection(ISelection selection) Sets the current selection for this selection provider.
void	setViewPartTitle(String title) Set the title of this view part
void	showSearchResult(int index) Show search result with the given index.
void	systemResourceChanged(ISystemResourceChangeEvent event) This is the method in your class that will be called when a system resource changes.

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

checkSite, getViewSite, init, 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

Constructor Detail

SystemSearchViewPart

public SystemSearchViewPart()

Constructor for SystemSearchViewPart.

Method Detail

createPartControl

public void createPartControl(Composite parent)

Specified by:

createPartControl in interface IWorkbenchPart

See Also:

IWorkbenchPart.createPartControl(Composite)

setFocus

public void setFocus()

Specified by:

setFocus in interface IWorkbenchPart

See Also:

IWorkbenchPart.setFocus()

init

public void init(IViewSite site,
                 IMemento memento)
          throws PartInitException

Specified by:

init in interface IViewPart

Throws:

PartInitException

See Also:

IViewPart.init(IViewSite, IMemento)

saveState

public void saveState(IMemento memento)

Specified by:

saveState in interface IViewPart

See Also:

IViewPart.saveState(IMemento)

addSearchResult

public void addSearchResult(IAdaptable resultSet)

Add a search result set.

Parameters:

resultSet - the search result set

dispose

public void dispose()

Specified by:

dispose in interface IWorkbenchPart

See Also:

IWorkbenchPart.dispose()

showSearchResult

public void showSearchResult(int index)

Show search result with the given index.

Parameters:

index - the index in the result history list

deleteSelected

public boolean deleteSelected()

Delete the selected object in the view.

Returns:

true if the selection has been deleted, false otherwise.

deleteAllPages

public boolean deleteAllPages()

Deletes all the pages in the view.

Returns:

true if all pages have been deleted, false otherwise.

deleteCurrentPage

public boolean deleteCurrentPage()

Deletes the current page.

Returns:

true if the current page has been deleted, false otherwise.

getAdapter

public ISystemViewElementAdapter getAdapter(Object element)

Get the adapter for the given object.

Parameters:

element - the object the object for which I want the adapter.

Returns:

the adapter for the object.

getShell

public Shell getShell()

Get the shell.

Specified by:

getShell in interface ISystemResourceChangeListener

Returns:

the shell

systemResourceChanged

public void systemResourceChanged(ISystemResourceChangeEvent event)

Description copied from interface: ISystemResourceChangeListener

This is the method in your class that will be called when a system resource changes.

Specified by:

systemResourceChanged in interface ISystemResourceChangeListener

See Also:

ISystemResourceChangeEvent

fillContextMenu

public void fillContextMenu(IMenuManager menu)

Fill context for the tree view pop-up menu.

Parameters:

menu - the menu manager.

sameParent

public boolean sameParent()

This is called to ensure all elements in a multiple-selection have the same parent in the tree viewer. If they don't we automatically disable all actions.

Designed to be as fast as possible by going directly to the SWT widgets

menuAboutToShow

public void menuAboutToShow(IMenuManager menu)

Called when the context menu is about to open. Calls fillContextMenu(IMenuManager)

Specified by:

menuAboutToShow in interface IMenuListener

addSelectionChangedListener

public void addSelectionChangedListener(ISelectionChangedListener listener)

getSelection

public ISelection getSelection()

Returns the current selection for this provider.

Returns:

the current selection

removeSelectionChangedListener

public void removeSelectionChangedListener(ISelectionChangedListener listener)

Removes the given selection change listener from this selection provider. Has no affect if an identical listener is not registered.

Parameters:

listener - a selection changed listener

setSelection

public void setSelection(ISelection selection)

Sets the current selection for this selection provider.

Parameters:

selection - the new selection

setViewPartTitle

public void setViewPartTitle(String title)

Set the title of this view part

Parameters:

title -

selectionChanged

public void selectionChanged(SelectionChangedEvent event)

Specified by:

selectionChanged in interface ISelectionChangedListener

See Also:

ISelectionChangedListener.selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent)

getCurrentViewer

public StructuredViewer getCurrentViewer()

Gets the current viewer, i.e. the viewer whose control is being currently displayed in the view.

Returns:

the current viewer, or null if there is no current viewer.

getRSEViewer

public Viewer getRSEViewer()

Specified by:

getRSEViewer in interface IRSEViewPart

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