|
Eclipse Platform Release 3.2 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.dialogs.DialogPage
org.eclipse.jface.preference.PreferencePage
org.eclipse.help.ui.RootScopePage
Clients that contribute search scope root page to the search engine
definition must extend this class and implement
createScopeContents
method. The page will come preset with the
engine name, image and description, as well as the master switch that turns
the engine on or off. When the engine master switch is set to false, all the
children in the client composite will be disabled.
Field Summary |
---|
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider |
---|
ERROR, INFORMATION, NONE, WARNING |
Constructor Summary | |
---|---|
RootScopePage()
The default constructor. |
Method Summary | |
---|---|
protected Control |
createContents(Composite parent)
Creates the initial contents of the page and allocates the area for the clients. |
protected abstract int |
createScopeContents(Composite parent)
Abstract method that subclasses must implement in order to provide root page content. |
protected IEngineDescriptor |
getEngineDescriptor()
Returns the descriptor of the engine associated with this page. |
protected String |
getScopeSetName()
Returns the scope set name passed to the page during initialization. |
void |
init(IEngineDescriptor ed,
String scopeSetName)
Initializes the search scope page. |
protected void |
initializeDefaults(IPreferenceStore store)
Initializes default values of the store to be used when the user presses 'Defaults' button. |
protected boolean |
isEngineEnabled()
Tests whether the search engine has been selected to participate in the search. |
protected void |
masterValueChanged(boolean value)
Called when the value of the master switch has changed. |
protected void |
performDefaults()
Sets the value of the master switch to the initial value from the extension. |
boolean |
performOk()
Stores the value of the master switch in the preference store. |
Methods inherited from class org.eclipse.jface.preference.PreferencePage |
---|
applyData, applyDialogFont, computeSize, contributeButtons, createControl, createDescriptionLabel, createNoteComposite, doComputeSize, doGetPreferenceStore, getApplyButton, getContainer, getDefaultsButton, getPreferenceStore, isValid, noDefaultAndApplyButton, okToLeave, performApply, performCancel, performHelp, setContainer, setErrorMessage, setMessage, setPreferenceStore, setSize, setTitle, setValid, toString, updateApplyButton |
Methods inherited from class org.eclipse.jface.dialogs.DialogPage |
---|
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getImage, getMessage, getMessageType, getShell, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, setButtonLayoutData, setControl, setDescription, setImageDescriptor, setMessage, setVisible |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.eclipse.jface.preference.IPreferencePage |
---|
computeSize, isValid, okToLeave, performCancel, setContainer, setSize |
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage |
---|
createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible |
Constructor Detail |
public RootScopePage()
Method Detail |
public void init(IEngineDescriptor ed, String scopeSetName)
ISearchScopePage
init
in interface ISearchScopePage
ed
- the descriptor of the engine associated with this pagescopeSetName
- the name of the current scope set that is used to group data
shown in this pageprotected final Control createContents(Composite parent)
createScopeContents(Composite)
instead.
createContents
in class PreferencePage
parent
- the page parent
protected void masterValueChanged(boolean value)
value
- true
if the master switch is on,
false
otherwise.protected String getScopeSetName()
protected IEngineDescriptor getEngineDescriptor()
protected boolean isEngineEnabled()
true
if the search engine is enabled, false
otherwise.public boolean performOk()
performOk
in interface IPreferencePage
performOk
in class PreferencePage
true
if the wizard can be closed,
false
otherwise.protected void performDefaults()
performDefaults
in class PreferencePage
protected void initializeDefaults(IPreferenceStore store)
store
- the preference storeprotected abstract int createScopeContents(Composite parent)
GridLayout
to position and
size the widgets. Widgets created in this method should use
GridData
to configure the way they fit in the overall
page.
The common widgets created by this page will set number of columns they need for themselves only. Clients that implement this method should return the required number of columns so that the root page widgets can be adjusted if more columns are needed than initially set.
parent
- the page parent
|
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.