public interface ISearchResultPage extends IPageBookViewPage
org.eclipse.search.searchResultViewPages
.
A ISearchResultPage
is used to show the search results for a
particular class of ISearchResult
(as specified in the
searchResultClass
attribute of the extension point) in the search
result view. Clients may implement this interface.
Modifier and Type | Method and Description |
---|---|
String |
getID()
Returns the id set via
setID . |
String |
getLabel()
Returns a user readable label for this search result page.
|
Object |
getUIState()
Returns an object representing the current user interface state of the
page.
|
void |
restoreState(IMemento memento)
Restores the page state.
|
void |
saveState(IMemento memento)
Saves the page state in a memento.
|
void |
setID(String id)
Sets the id for this page.
|
void |
setInput(ISearchResult search,
Object uiState)
Sets the search result to be shown in this search results page.
|
void |
setViewPart(ISearchResultViewPart part)
Sets the search view this search results page is shown in.
|
getSite, init
createControl, dispose, getControl, setActionBars, setFocus
Object getUIState()
setInput()
method when the
currently shown ISearchResult
is shown again.void setInput(ISearchResult search, Object uiState)
uiState
object.search
- the search result to be shown or null
to clear the page.uiState
- the previously saved UI stategetUIState()
void setViewPart(ISearchResultViewPart part)
part
- the parent search viewvoid restoreState(IMemento memento)
memento
- a memento to restore the page state from or null
if no previous state was savedsetInput(ISearchResult, Object)
void saveState(IMemento memento)
memento
- a memento to receive the object stategetUIState()
void setID(String id)
id
- the id for this pageString getID()
setID
.String getLabel()
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.