|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISearchPageContainer
Offers client access to the search dialog. A search page can enable or disable the dialog's action button and get an operation context to perform the action. The dialog itself cannot be accessed directly.
This interface is not intended to be implemented by clients.
Field Summary | |
---|---|
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 ). |
Method Summary | |
---|---|
IRunnableContext |
getRunnableContext()
Returns the context for the search operation. |
java.lang.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 |
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. |
Field Detail |
---|
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
).
Method Detail |
---|
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 containerIWorkingSet[] getSelectedWorkingSets()
null
if the scope is not WORKING_SET_SCOPE
void setSelectedWorkingSets(IWorkingSet[] workingSets)
workingSets
- an array of IWorkingSetjava.lang.String[] getSelectedProjectNames()
null
if the scope is not SELECTED_PROJECTS_SCOPE
null
if the scope is not SELECTED_PROJECTS_SCOPE
.
|
Eclipse Platform Release 3.2 |
|||||||||
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, 2006. All rights reserved.