public interface ISearchPageContainer
This interface is not intended to be implemented by clients.
Modifier and Type | Field and Description |
---|---|
static int |
SELECTED_PROJECTS_SCOPE
Current Project scope (value
3 ). |
static int |
SELECTION_SCOPE
Selection scope (value
1 ). |
static int |
WORKING_SET_SCOPE
Working set scope (value
2 ). |
static int |
WORKSPACE_SCOPE
Workspace scope (value
0 ). |
Modifier and Type | Method and Description |
---|---|
IEditorInput |
getActiveEditorInput()
Returns the editor input of the active editor.
|
IRunnableContext |
getRunnableContext()
Returns the context for the search operation.
|
String[] |
getSelectedProjectNames()
Returns the names of the enclosing projects if selected by the container or
null
if the scope is not SELECTED_PROJECTS_SCOPE |
int |
getSelectedScope()
Returns search container's selected scope.
|
IWorkingSet[] |
getSelectedWorkingSets()
Returns the selected working sets of this container.
|
ISelection |
getSelection()
Returns the selection with which this container was opened.
|
boolean |
hasValidScope()
Tells whether a valid scope is selected.
|
void |
setActiveEditorCanProvideScopeSelection(boolean state)
Tells this container whether the active editor can provide the selection for the scope and
hence the
SELECTION_SCOPE can be enabled if the active part is an editor. |
void |
setPerformActionEnabled(boolean state)
Sets the enable state of the perform action button
of this container.
|
void |
setSelectedScope(int scope)
Sets the selected scope of this search page container.
|
void |
setSelectedWorkingSets(IWorkingSet[] workingSets)
Sets the selected working sets of this container.
|
static final int WORKSPACE_SCOPE
0
).static final int SELECTION_SCOPE
1
).static final int WORKING_SET_SCOPE
2
).static final int SELECTED_PROJECTS_SCOPE
3
).ISelection getSelection()
IRunnableContext getRunnableContext()
IRunnableContext
for the search operationvoid setPerformActionEnabled(boolean state)
state
- true
to enable the button which performs the actionint getSelectedScope()
void setSelectedScope(int scope)
scope
- the newly selected scopeboolean hasValidScope()
true
if a valid scope is selected in this search page containervoid setActiveEditorCanProvideScopeSelection(boolean state)
SELECTION_SCOPE
can be enabled if the active part is an editor.state
- true
if the active editor can provide the selection,
false
otherwiseIEditorInput getActiveEditorInput()
null
if the active part is not an editorIWorkingSet[] getSelectedWorkingSets()
null
if the scope is not WORKING_SET_SCOPE
void setSelectedWorkingSets(IWorkingSet[] workingSets)
workingSets
- an array of IWorkingSetString[] getSelectedProjectNames()
null
if the scope is not SELECTED_PROJECTS_SCOPE
null
if the scope is not SELECTED_PROJECTS_SCOPE
.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.