|
Eclipse Platform 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.search.ui.SearchUI
The central class for access to the Search Plug-in's User Interface. This class cannot be instantiated; all functionality is provided by static methods. Features provided:
ISearchResultView
Field Summary | |
static String |
ACTION_SET_ID
Id of the Search action set (value "org.eclipse.search.searchActionSet" ). |
static String |
LINE
Line marker attribute (value "line" )
The value of the marker attribute is the line which contains the text search match. |
static String |
PLUGIN_ID
Search Plug-in Id (value "org.eclipse.search" ). |
static String |
POTENTIAL_MATCH
Potential match marker attribute (value "potentialMatch" ). |
static String |
SEARCH_MARKER
Search marker type (value "org.eclipse.search.searchmarker" ). |
static String |
SEARCH_RESULT_VIEW_ID
Id of the Search result view (value "org.eclipse.search.SearchResultView" ). |
Method Summary | |
static boolean |
activateSearchResultView()
Activates the search result view in the active page of the active workbench window. |
static boolean |
arePotentialMatchesIgnored()
Returns the preference whether a search engine is allowed to report potential matches or not. |
static String |
getDefaultPerspectiveId()
Returns the ID of the default perspective. |
static Image |
getSearchMarkerImage()
Returns the shared search marker image. |
static ISearchResultView |
getSearchResultView()
Returns the search result view of the active page of the active workbench window. |
static void |
openSearchDialog(IWorkbenchWindow window,
String pageId)
Opens the search dialog. |
static boolean |
reuseEditor()
Returns the preference whether editors should be reused when showing search results. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String PLUGIN_ID
"org.eclipse.search"
).public static final String SEARCH_MARKER
"org.eclipse.search.searchmarker"
).IMarker
public static final String LINE
"line"
)
The value of the marker attribute is the line which contains the text search match.IMarker.getAttribute(java.lang.String)
public static final String POTENTIAL_MATCH
"potentialMatch"
).
This optional marker attribute tells whether a marker is a potential or an exact match. The marker is considered an exact match if the attribute is missing.
Potential matches are shown with a different background color in the Search view. The color can be changed in the Search preferences.
IMarker.getAttribute(java.lang.String)
public static final String SEARCH_RESULT_VIEW_ID
"org.eclipse.search.SearchResultView"
).public static final String ACTION_SET_ID
"org.eclipse.search.searchActionSet"
).Method Detail |
public static boolean activateSearchResultView()
true
if the search result view is already activated.true
if the search result view could be activatedpublic static void openSearchDialog(IWorkbenchWindow window, String pageId)
pageId
is specified and a corresponding page
is found then it is brought to top.pageId
- the page to select or null
if the best fitting page should be selectedpublic static ISearchResultView getSearchResultView()
null
if there is no active search result viewpublic static Image getSearchMarkerImage()
public static boolean reuseEditor()
true
if editors should be reused for showing search resultspublic static boolean arePotentialMatchesIgnored()
Search engines which can report inexact matches must
respect this preference i.e. they should not report
inexact matches if this method returns true
true
if search engine must not report inexact matchespublic static String getDefaultPerspectiveId()
The perspective with this ID will be used to show the Search view. If no default perspective is set then the Search view will appear in the current perspective.
null
if no default perspective is set
|
Eclipse Platform 2.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |