public final class ActivityCategoryPreferencePage extends PreferencePage implements IWorkbenchPreferencePage, IExecutableExtension
IExecutableExtension
.ACTIVITY_NAME
,
ALLOW_ADVANCED
,
CAPTION_MESSAGE
,
CATEGORY_NAME
,
ACTIVITY_PROMPT_BUTTON
,
ACTIVITY_PROMPT_BUTTON_TOOLTIP
Modifier and Type | Field and Description |
---|---|
static String |
ACTIVITY_NAME
The name to use for the activities.
|
static String |
ACTIVITY_PROMPT_BUTTON
The label to be used for the prompt button.
|
static String |
ACTIVITY_PROMPT_BUTTON_TOOLTIP
The tooltip to be used for the prompt button.
|
static String |
ALLOW_ADVANCED
The parameter to use if you want the page to show the allow button.
|
static String |
CAPTION_MESSAGE
The string to use for the message at the top of the preference page.
|
static String |
CATEGORY_NAME
The name to use for the activity categories.
|
protected IWorkbench |
workbench |
ERROR, INFORMATION, NONE, WARNING
Constructor and Description |
---|
ActivityCategoryPreferencePage() |
Modifier and Type | Method and Description |
---|---|
protected void |
clearDetails()
Clear the details area.
|
protected Control |
createContents(Composite parent)
Creates and returns the SWT control for the customized body
of this preference page under the given parent composite.
|
void |
dispose()
The
DialogPage implementation of this
IDialogPage method disposes of the page
image if it has one. |
void |
init(IWorkbench workbench)
Initializes this preference page for the given workbench.
|
protected boolean |
isLocked(ICategory category)
Return whether the category is locked.
|
protected void |
performDefaults()
Performs special processing when this page's Defaults button has been pressed.
|
boolean |
performOk()
Notifies that the OK button of this page's container has been pressed.
|
protected void |
setDetails(ICategory category) |
void |
setInitializationData(IConfigurationElement config,
String propertyName,
Object data)
This method is called by the implementation of the method
IConfigurationElement.createExecutableExtension
on a newly constructed extension, passing it its relevant configuration
information. |
applyData, applyDialogFont, computeSize, contributeButtons, createControl, createDescriptionLabel, createNoteComposite, doComputeSize, doGetPreferenceStore, getApplyButton, getContainer, getDefaultsButton, getPreferenceStore, isValid, noDefaultAndApplyButton, noDefaultButton, okToLeave, performApply, performCancel, performHelp, setContainer, setErrorMessage, setMessage, setPreferenceStore, setSize, setTitle, setValid, toString, updateApplyButton
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getImage, getMessage, getMessageType, getShell, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, setButtonLayoutData, setControl, setDescription, setImageDescriptor, setMessage, setVisible
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
computeSize, isValid, okToLeave, performCancel, setContainer, setSize
createControl, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible
public static final String ACTIVITY_NAME
public static final String ALLOW_ADVANCED
public static final String CAPTION_MESSAGE
public static final String CATEGORY_NAME
public static final String ACTIVITY_PROMPT_BUTTON
public static final String ACTIVITY_PROMPT_BUTTON_TOOLTIP
protected IWorkbench workbench
protected Control createContents(Composite parent)
PreferencePage
This framework method must be implemented by concrete subclasses. Any
subclass returning a Composite
object whose Layout
has default margins (for example, a GridLayout
) are expected to
set the margins of this Layout
to 0 pixels.
createContents
in class PreferencePage
parent
- the parent compositeprotected void setDetails(ICategory category)
protected void clearDetails()
public void init(IWorkbench workbench)
IWorkbenchPreferencePage
This method is called automatically as the preference page is being created and initialized. Clients must not call this method.
init
in interface IWorkbenchPreferencePage
workbench
- the workbenchprotected boolean isLocked(ICategory category)
category
- the category to testpublic boolean performOk()
IPreferencePage
performOk
in interface IPreferencePage
performOk
in class PreferencePage
false
to abort the container's OK
processing and true
to allow the OK to happenprotected void performDefaults()
PreferencePage
This is a framework hook method for subclasses to do special things when
the Defaults button has been pressed.
Subclasses may override, but should call super.performDefaults
.
performDefaults
in class PreferencePage
public void setInitializationData(IConfigurationElement config, String propertyName, Object data)
IExecutableExtension
IConfigurationElement.createExecutableExtension
on a newly constructed extension, passing it its relevant configuration
information. Most executable extensions only make use of the first
two call arguments.
Regular executable extensions specify their Java implementation class name as an attribute of the configuration element for the extension. For example
<action run="com.example.BaseAction"/>In the above example, this method would be called with a reference to the
<action>
element (first argument), and
"run"
as the name of the attribute that defined
this executable extension (second argument).
The last parameter is for the specific use of extension adapters and is typically not used by regular executable extensions.
There are two supported ways of associating additional adapter-specific data with the configuration in a way that is transparent to the extension point implementor:
(1) by specifying adapter data as part of the implementation
class attribute value. The Java class name can be followed
by a ":" separator, followed by any adapter data in string
form. For example, if the extension point specifies an attribute
"run"
to contain the name of the extension implementation,
an adapter can be configured as
<action run="com.example.ExternalAdapter:./cmds/util.exe -opt 3"/>
(2) by converting the attribute used to specify the executable extension to a child element of the original configuration element, and specifying the adapter data in the form of xml markup. Using this form, the example above would become
<action> <run class="com.xyz.ExternalAdapter"> <parameter name="exec" value="./cmds/util.exe"/> <parameter name="opt" value="3"/> </run > </action>
Form (2) will typically only be used for extension points that anticipate the majority of extensions configured into it will in fact be in the form of adapters.
In either case, the specified adapter class is instantiated using its 0-argument public constructor. The adapter data is passed as the last argument of this method. The data argument is defined as Object. It can have the following values:
null
, if no adapter data was suppliedString
Hashtable
containing the actual
parameter names and values (both String
s)setInitializationData
in interface IExecutableExtension
config
- the configuration element used to trigger this execution.
It can be queried by the executable extension for specific
configuration propertiespropertyName
- the name of an attribute of the configuration element
used on the createExecutableExtension(String)
call. This
argument can be used in the cases where a single configuration element
is used to define multiple executable extensions.data
- adapter data in the form of a String
,
a Hashtable
, or null
.IConfigurationElement.createExecutableExtension(String)
public void dispose()
DialogPage
DialogPage
implementation of this
IDialogPage
method disposes of the page
image if it has one.
Subclasses may extend.dispose
in interface IDialogPage
dispose
in class DialogPage
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.