|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A ISearchResultPage
is used to render the search results for a
particular class of ISearchResult
(as specified in the
searchResultClass
attribute of the extension point) in the search
view.
Extensions of extension point org.eclipse.search.ui.searchResultViewPages
must implement this interface.
Clients may implement this interface.
Method Summary | |
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. |
Methods inherited from interface org.eclipse.ui.part.IPageBookViewPage |
getSite, init |
Methods inherited from interface org.eclipse.ui.part.IPage |
createControl, dispose, getControl, setActionBars, setFocus |
Method Detail |
public Object getUIState()
setInput()
method when the
currently shown ISearchResult
is shown again.
public void setInput(ISearchResult search, Object uiState)
uiState
object.
search
- the search result to be shownuiState
- the previously saved UI stategetUIState()
public void setViewPart(ISearchResultViewPart part)
part
- the parent search viewpublic void restoreState(IMemento memento)
memento
- a memento to restore the page state from or null
if no previous state was savedsetInput(ISearchResult, Object)
public void saveState(IMemento memento)
memento
- a memento to receive the object stategetUIState()
public void setID(String id)
id
- the id for this pagepublic String getID()
setID
.
public String getLabel()
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.