org.eclipse.sphinx.emf.search.ui.pages

Class ModelSearchResultViewPage

java.lang.Object

org.eclipse.ui.part.Page

org.eclipse.sphinx.emf.search.ui.pages.ModelSearchResultViewPage

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, org.eclipse.search.ui.ISearchResultPage, org.eclipse.ui.part.IPage, org.eclipse.ui.part.IPageBookViewPage, org.eclipse.ui.views.properties.tabbed.ITabbedPropertySheetPageContributor

public class ModelSearchResultViewPage
extends org.eclipse.ui.part.Page
implements org.eclipse.search.ui.ISearchResultPage, org.eclipse.ui.views.properties.tabbed.ITabbedPropertySheetPageContributor, org.eclipse.core.runtime.IAdaptable

Field Summary

Fields

Modifier and Type	Field and Description
protected static ModelSearchMatch[]	EMPTY_MATCH_ARRAY
static int	FLAG_LAYOUT_FLAT Flag (value 1) denoting flat list layout.
static int	FLAG_LAYOUT_TREE Flag (value 2) denoting tree layout.
protected java.util.Set<org.eclipse.ui.views.properties.IPropertySheetPage>	propertySheetPages

Constructor Summary

Constructors

Constructor and Description
ModelSearchResultViewPage()
ModelSearchResultViewPage(int supportedLayouts) This constructor must be passed a combination of layout flags combined with bitwise or.

Method Summary

Modifier and Type	Method and Description
protected boolean	canRemoveMatchesWith(org.eclipse.jface.viewers.ISelection selection) Determines whether the provided selection can be used to remove matches from the result.
protected void	clear()
protected void	configureTableViewer(org.eclipse.jface.viewers.TableViewer tableViewer)
protected void	configureTreeViewer(org.eclipse.jface.viewers.TreeViewer treeViewer)
void	createControl(org.eclipse.swt.widgets.Composite parent)
protected org.eclipse.jface.viewers.TableViewer	createTableViewer(org.eclipse.swt.widgets.Composite parent) Creates the table viewer to be shown on this page.
protected org.eclipse.jface.viewers.TreeViewer	createTreeViewer(org.eclipse.swt.widgets.Composite parent) Creates the tree viewer to be shown on this page.
protected void	elementsChanged(java.lang.Object[] updatedElements)
protected void	evaluateChangedElements(ModelSearchMatch[] matches, java.util.Set<java.lang.Object> changedElements) Evaluates the elements to that are later passed to elementsChanged(Object[]).
protected void	fillContextMenu(org.eclipse.jface.action.IMenuManager mgr) Fills the context menu for this page.
protected void	fillToolbar(org.eclipse.jface.action.IToolBarManager tbm) Fills the toolbar contribution for this page.
java.lang.Object	getAdapter(java.lang.Class adapter)
java.lang.String	getContributorId()
org.eclipse.swt.widgets.Control	getControl()
ModelSearchMatch	getCurrentMatch() Returns the currently selected match.
int	getDisplayedMatchCount(java.lang.Object element)
ModelSearchMatch[]	getDisplayedMatches(java.lang.Object element) Returns the matches that are currently displayed for the given element.
java.lang.Integer	getElementLimit() Gets the maximal number of top level elements to be shown in a viewer.
java.lang.String	getID()
ModelSearchResult	getInput() Returns the currently shown result.
java.lang.String	getLabel()
int	getLayout() Return the layout this page is currently using.
org.eclipse.ui.views.properties.IPropertySheetPage	getPropertySheetPage() This creates a new property sheet page instance and manages it in the cache.
protected org.eclipse.jface.dialogs.IDialogSettings	getSettings() Returns a dialog settings object for this search result page.
java.lang.Object	getUIState()
org.eclipse.jface.viewers.StructuredViewer	getViewer() Returns the viewer currently used in this page.
protected org.eclipse.search.ui.ISearchResultViewPart	getViewPart() Returns the view part set with setViewPart(ISearchResultViewPart).
void	gotoNextMatch() Selects the element corresponding to the next match and shows the match in an editor.
void	gotoPreviousMatch() Selects the element corresponding to the previous match and shows the match in an editor.
protected void	handleOpen(org.eclipse.jface.viewers.OpenEvent event) This method is called when the search page gets an 'open' event from its underlying viewer (for example on double click).
protected void	handleSearchResultChanged(org.eclipse.search.ui.SearchResultEvent e) Handles a search result event for the current search result.
void	internalRemoveSelected() Note: this is internal API and should not be called from clients outside of the search plug-in.
boolean	isLayoutSupported(int layout) Determines whether a certain layout is supported by this search result page.
protected void	postEnsureSelection() Posts a UI update to make sure an element is selected.
void	restoreState(org.eclipse.ui.IMemento memento)
void	saveState(org.eclipse.ui.IMemento memento)
void	setElementLimit(java.lang.Integer limit) Sets the maximal number of top level elements to be shown in a viewer.
void	setFocus()
void	setID(java.lang.String id)
void	setInput(org.eclipse.search.ui.ISearchResult newSearch, java.lang.Object uiState)
void	setLayout(int layout) Sets the layout of this search result page.
void	setViewPart(org.eclipse.search.ui.ISearchResultViewPart part)

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

dispose, getSite, init, makeContributions, setActionBars

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

getSite, init

Methods inherited from interface org.eclipse.ui.part.IPage

dispose, setActionBars

Field Detail

EMPTY_MATCH_ARRAY

protected static final ModelSearchMatch[] EMPTY_MATCH_ARRAY

propertySheetPages

protected java.util.Set<org.eclipse.ui.views.properties.IPropertySheetPage> propertySheetPages

FLAG_LAYOUT_FLAT

public static final int FLAG_LAYOUT_FLAT

Flag (value 1) denoting flat list layout.

See Also:

Constant Field Values

FLAG_LAYOUT_TREE

public static final int FLAG_LAYOUT_TREE

Flag (value 2) denoting tree layout.

See Also:

Constant Field Values

Constructor Detail

ModelSearchResultViewPage

public ModelSearchResultViewPage(int supportedLayouts)

This constructor must be passed a combination of layout flags combined with bitwise or. At least one flag must be passed in (i.e. 0 is not a permitted value).

Parameters:

supportedLayouts - flags determining which layout options this page supports. Must not be 0

See Also:

FLAG_LAYOUT_FLAT, FLAG_LAYOUT_TREE

ModelSearchResultViewPage

public ModelSearchResultViewPage()

Method Detail

getUIState

public java.lang.Object getUIState()

Specified by:

getUIState in interface org.eclipse.search.ui.ISearchResultPage

setInput

public void setInput(org.eclipse.search.ui.ISearchResult newSearch,
                     java.lang.Object uiState)

Specified by:

setInput in interface org.eclipse.search.ui.ISearchResultPage

isLayoutSupported

public boolean isLayoutSupported(int layout)

Determines whether a certain layout is supported by this search result page.

Parameters:

layout - the layout to test for

Returns:

whether the given layout is supported or not

See Also:

ModelSearchResultViewPage(int)

gotoNextMatch

public void gotoNextMatch()

Selects the element corresponding to the next match and shows the match in an editor. Note that this will cycle back to the first match after the last match.

gotoPreviousMatch

public void gotoPreviousMatch()

Selects the element corresponding to the previous match and shows the match in an editor. Note that this will cycle back to the last match after the first match.

getInput

public ModelSearchResult getInput()

Returns the currently shown result.

Returns:

the previously set result or null

See Also:

setInput(ISearchResult, Object)

getDisplayedMatchCount

public int getDisplayedMatchCount(java.lang.Object element)

getViewPart

protected org.eclipse.search.ui.ISearchResultViewPart getViewPart()

Returns the view part set with setViewPart(ISearchResultViewPart).

Returns:

The view part or null if the view part hasn't been set yet (or set to null).

setViewPart

public void setViewPart(org.eclipse.search.ui.ISearchResultViewPart part)

Specified by:

setViewPart in interface org.eclipse.search.ui.ISearchResultPage

restoreState

public void restoreState(org.eclipse.ui.IMemento memento)

Specified by:

restoreState in interface org.eclipse.search.ui.ISearchResultPage

saveState

public void saveState(org.eclipse.ui.IMemento memento)

Specified by:

saveState in interface org.eclipse.search.ui.ISearchResultPage

setID

public void setID(java.lang.String id)

Specified by:

setID in interface org.eclipse.search.ui.ISearchResultPage

getID

public java.lang.String getID()

Specified by:

getID in interface org.eclipse.search.ui.ISearchResultPage

getLabel

public java.lang.String getLabel()

Specified by:

getLabel in interface org.eclipse.search.ui.ISearchResultPage

getSettings

protected org.eclipse.jface.dialogs.IDialogSettings getSettings()

Returns a dialog settings object for this search result page. There will be one dialog settings object per search result page id.

Returns:

the dialog settings for this search result page

See Also:

getID()

getViewer

public org.eclipse.jface.viewers.StructuredViewer getViewer()

Returns the viewer currently used in this page.

Returns:

the currently used viewer or null if none has been created yet.

internalRemoveSelected

public void internalRemoveSelected()

Note: this is internal API and should not be called from clients outside of the search plug-in.

Removes the currently selected match. Does nothing if no match is selected.

createControl

public void createControl(org.eclipse.swt.widgets.Composite parent)

Specified by:

createControl in interface org.eclipse.ui.part.IPage

Specified by:

createControl in class org.eclipse.ui.part.Page

configureTreeViewer

protected void configureTreeViewer(org.eclipse.jface.viewers.TreeViewer treeViewer)

configureTableViewer

protected void configureTableViewer(org.eclipse.jface.viewers.TableViewer tableViewer)

handleOpen

protected void handleOpen(org.eclipse.jface.viewers.OpenEvent event)

This method is called when the search page gets an 'open' event from its underlying viewer (for example on double click). The default implementation will open the first match on any element that has matches. If the element to be opened is an inner node in the tree layout, the node will be expanded if it's collapsed and vice versa. Subclasses are allowed to override this method.

Parameters:

event - the event sent for the currently shown viewer

See Also:

IOpenListener

fillToolbar

protected void fillToolbar(org.eclipse.jface.action.IToolBarManager tbm)

Fills the toolbar contribution for this page. Subclasses may override this method.

Parameters:

tbm - the tool bar manager representing the view's toolbar

setLayout

public void setLayout(int layout)

Sets the layout of this search result page. The layout must be on of FLAG_LAYOUT_FLAT or FLAG_LAYOUT_TREE and it must be one of the values passed during construction of this search result page.

Parameters:

layout - the new layout

See Also:

isLayoutSupported(int)

createTreeViewer

protected org.eclipse.jface.viewers.TreeViewer createTreeViewer(org.eclipse.swt.widgets.Composite parent)

Creates the tree viewer to be shown on this page. Clients may override this method.

Parameters:

parent - the parent widget

Returns:

returns a newly created TreeViewer.

createTableViewer

protected org.eclipse.jface.viewers.TableViewer createTableViewer(org.eclipse.swt.widgets.Composite parent)

Creates the table viewer to be shown on this page. Clients may override this method.

Parameters:

parent - the parent widget

Returns:

returns a newly created TableViewer

postEnsureSelection

protected void postEnsureSelection()

Posts a UI update to make sure an element is selected.

fillContextMenu

protected void fillContextMenu(org.eclipse.jface.action.IMenuManager mgr)

Fills the context menu for this page. Subclasses may override this method.

Parameters:

mgr - the menu manager representing the context menu

canRemoveMatchesWith

protected boolean canRemoveMatchesWith(org.eclipse.jface.viewers.ISelection selection)

Determines whether the provided selection can be used to remove matches from the result.

Parameters:

selection - the selection to test

Returns:

returns true if the elements in the current selection can be removed.

getLayout

public int getLayout()

Return the layout this page is currently using.

Returns:

the layout this page is currently using

See Also:

FLAG_LAYOUT_FLAT, FLAG_LAYOUT_TREE

getCurrentMatch

public ModelSearchMatch getCurrentMatch()

Returns the currently selected match.

Returns:

the selected match or null if none are selected

getDisplayedMatches

public ModelSearchMatch[] getDisplayedMatches(java.lang.Object element)

Returns the matches that are currently displayed for the given element. If ModelSearchResult#getActiveMatchFilters() is not null, only matches are returned that are not filtered by the match filters. If ModelSearchResult#getActiveMatchFilters() is null all matches of the given element are returned. Any action operating on the visible matches in the search result page should use this method to get the matches for a search result (instead of asking the search result directly).

Parameters:

element - The element to get the matches for

Returns:

The matches displayed for the given element. If the current input of this page is null, an empty array is returned

See Also:

ModelSearchResult.getMatches(Object)

getControl

public org.eclipse.swt.widgets.Control getControl()

Specified by:

getControl in interface org.eclipse.ui.part.IPage

Specified by:

getControl in class org.eclipse.ui.part.Page

setFocus

public void setFocus()

Specified by:

setFocus in interface org.eclipse.ui.part.IPage

Specified by:

setFocus in class org.eclipse.ui.part.Page

setElementLimit

public void setElementLimit(java.lang.Integer limit)

Sets the maximal number of top level elements to be shown in a viewer. If null is set, the view page does not support to limit the elements and will not provide UI to configure it. If a non-null value is set, configuration UI will be provided. The limit value must be a positive number or -1 to not limit top level element. If enabled, the element limit has to be enforced by the content provider that is implemented by the client. The view page just manages the value and configuration.

Parameters:

limit - the element limit. Valid values are:

null to not limit and not provide configuration UI

-1 to not limit and provide configuration UI

positive integer to limit by the given value and provide configuration UI

getElementLimit

public java.lang.Integer getElementLimit()

Gets the maximal number of top level elements to be shown in a viewer. null means the view page does not limit the elements and will not provide UI to configure it. If a non-null value is set, configuration UI will be provided. The limit value must be a positive number or -1 to not limit top level element.

Returns:

returns the element limit. Valid values are:

null to not limit and not provide configuration UI (default value)

-1 to not limit and provide configuration UI

positive integer to limit by the given value and provide configuration UI

handleSearchResultChanged

protected void handleSearchResultChanged(org.eclipse.search.ui.SearchResultEvent e)

Handles a search result event for the current search result.

Parameters:

e - the event to handle

evaluateChangedElements

protected void evaluateChangedElements(ModelSearchMatch[] matches,
                                       java.util.Set<java.lang.Object> changedElements)

Evaluates the elements to that are later passed to elementsChanged(Object[]). By default the element to change are the elements received by (ModelSearchMatch.getElement()). Client implementations can modify this behavior.

Parameters:

matches - the matches that were added or removed

changedElements - the set that collects the elements to change. Clients should only add elements to the set.

Since:

3.4

elementsChanged

protected void elementsChanged(java.lang.Object[] updatedElements)

clear

protected void clear()

getAdapter

public java.lang.Object getAdapter(java.lang.Class adapter)

Specified by:

getAdapter in interface org.eclipse.core.runtime.IAdaptable

getPropertySheetPage

public org.eclipse.ui.views.properties.IPropertySheetPage getPropertySheetPage()

This creates a new property sheet page instance and manages it in the cache.

getContributorId

public java.lang.String getContributorId()

Specified by:

getContributorId in interface org.eclipse.ui.views.properties.tabbed.ITabbedPropertySheetPageContributor