|
Eclipse Platform Release 3.0 |
||||||||||
| PREV LETTER NEXT LETTER | FRAMES NO FRAMES | ||||||||||
FileDialog style constant for save file dialog behavior
(value is 1<<13).
ActionFactory.SAVE.getId() instead.
ActionFactory.SAVE_ALL.getId() instead.
ActionFactory.SAVE_AS.getId() instead.
"save.ext").
"save.ext").
"project") used for the
scope name for this preference scope.
"configuration") used for the
scope name for the configuration preference scope.
"default") used for the
scope name for the default preference scope.
"instance") used for the
scope name for the instance preference scope.
SpecialKey which represents
the 'Scroll Lock' key.
"org.eclipse.search.searchmarker").
NewSearchUI.SEARCH_MARKER instead.
"org.eclipse.search.SearchResultView").
"org.eclipse.search.ui.views.SearchView").
NewSearchUI.SEARCH_VIEW_ID instead.
leave specifying that a UI of a parent mode should
select the current position.
3).
scope field value indicating that
the current selection should be printed
1).
ActionFactory.SELECT_ALL.getId() instead.
1) indicating a layout
where the field editor's label appears on the left
with a check box on the right.
header and
footer.
"sessionProperty").
"severity").
ModifierKey which
represents the 'Shift' key.
setMinimumItemsToShow and getMinimumItemsToShow
to indicate that all tool items should be shown in the cool item.
"show.ext").
"show.ext").
"SHOW_PSEUDO_CONFLICTS").
"size").
CharacterKey which
represents the space (U+0020) key.
StyledText."stepGroup").
"stepIntoGroup").
"stepOverGroup").
"stepReturnGroup").
"").
"").
"superType").
subTask
should not have any effect.
SyncInfoSet.
systemTest)
ISaveableWorkbenchPart and
IWorkbenchPart.
ISaveableWorkbenchPart and
ensures that changes made to the input are saved when the dialog is closed.ISearchResults.
NewSearchUI instead.SelectFilesOperation.
SelectMarkerRulerAction.SelectMarkerRulerAction(ResourceBundle, String, ITextEditor, IVerticalRulerInfo)
SelectMarkerRulerActionSelectMarkerRulerAction.SelectMarkerRulerAction(ResourceBundle, String, ITextEditor, IVerticalRulerInfo)
SelectionListener interface.
SelectionStatusDialog.
ResourceVariantByteStore that caches the variant bytes in memory
and does not persist them over workbench invocations.
ShellListener interface.
Shells.
ShowInContext with the given input and
selection.
ShowInContext with the given input and
selection.
ISourceViewerand its extension
interfaces. SpecialKey represent the keys on keyboard
recognized as neither modifier keys nor character keys. Control within the status line.
StatusTextEvent is sent by a Browser to
StatusTextListener's when the status text is changed.
StatusTextEvent notification when the status text
for a Browser needs to be updated.IStorages.IStorage as underlying document resources.IStructureCreator
to retrieve a hierarchical structure from the input object (an ICompareInput)
and perform a two-way or three-way compare on it.
IStructuredSelection interface,
suitable for instantiating.
List.
IActionBars interface.IActionBars2 interface. SubContributionItem is a wrapper for an IContributionItem.
SubContributionItem.
SubContributionManager is used to define a set of contribution
items within a parent manager. SubContributionManager
SubCoolBarManager monitors the additional and removal of
items from a parent manager so that visibility of the entire set can be changed as a
unit.SubMenuManager is used to define a set of contribution
items within a parent manager. SubStatusLineManager is used to define a set of contribution
items within a parent manager. SubToolBarManager monitors the additional and removal of
items from a parent manager so that visibility of the entire set can be changed as a
unit.ISubjectControlContentAssistant interface.
SubjectControlContextInformationValidator interface.
ISubscriberChangeEvent that can
be used by clients.Subscriber. SyncInfo editor input used as input to a two-way or three-way
compare viewer. SyncInfo.
SyncInfoFilter tests a SyncInfo for inclusion,
typically in a SyncInfoSet.SyncInfo whose local and remote contents match.
SyncInfo objects that provides
change notification to registered listeners. SyncInfoSet containing the given SyncInfo
instances.
SyncInfo in the set through
their resource's hierarchical relationships.
ISynchronizeModelElement
instances. ISynchronizeModelElementelements. ISynchronizePage. IResource's provided.
ContentMergeViewer.
Plugin.savePluginPreferences.
This method now calls savePluginPreferences, and exists only for
backwards compatibility.
ContentMergeViewer.
memento
IIntroPart method does nothing.
IIntroPart method does nothing.
IContributionItem
method does nothing.
null if none.
ALL_PAGES
Print all pages in the current document
PAGE_RANGE
Print the range of pages specified by startPage and endPage
SELECTION
Print the current selection
FindReplaceDocumentAdapter
ISearchResult.
null if the path does not have such a segment.
SyncInfo matches the filter.
true if the provided SyncInfo matches the filter.
selectChange selects and reveals the next (previous) change.
ActionDelegate implementation of this
IActionDelegate method does nothing.
BaseSelectionListenerAction implementation of this
ISelectionChangedListener method calls
selectionChanged(IStructuredSelection) assuming the selection is
a structured one.
SelectionProviderAction implementation of this
ISelectionChangedListener method calls
selectionChanged(IStructuredSelection) if the selection is
a structured selection but selectionChanged(ISelection) if it is
not.
PropertyDialogAction implementation of this
SelectionProviderAction method enables the action only if
the given selection contains exactly one element.
text and removes the gap
since there are no sensible predictions about
where the next change will occur.
PropertySheetPage implementation of this IPage method
calls makeContributions for backwards compatibility with
previous versions of IPage.
BasicTextEditorActionContributor implementation of this
IEditorActionBarContributor method installs the global
action handler for the given text editor by calling a private helper
method.
EditionSelectionDialog is in 'add' mode
or 'replace' mode (the default).
x in
scanline y in the receiver's alpha data.
x in
scanline y in the receiver's alpha data to the
values from the array alphas starting at
startIndex.
null if there are no arguments.
java.util.List-valued attribute with the given name.
java.util.Map-valued attribute with the given name.
open method should block
until the window closes.
IProgressMonitorWithBlocking
method forwards to the wrapped progress monitor.
GridData on the specified button to be one that
is spaced for the current dialog page units.
IProgressMonitor
method forwards to the wrapped progress monitor.
IProgressMonitor.setCanceled.
true, causes the receiver to have
all mouse events delivered to it until the method is called with
false as the argument.
null to show all categories.
IFile.setCharset(String, IProgressMonitor) which
is a workspace operation and reports changes in resource deltas.
CompareEditorInput on which this action operates.
EditionSelectionDialog is in 'compare' mode
or 'add/replace' (the default) mode.
null
to use the default equals and hashCode
methods on the elements themselves.
SyncInfo
modes.
doSave(Object, Object) asks for confirmation before saving
the old input with saveContent(Object).
ContentMergeViewer implementation of this
ContentViewer method
checks to ensure that the content provider is an IMergeViewerContentProvider.
AbstractTreeViewer implementation of this method
checks to ensure that the content provider is an ITreeContentProvider.
fetchContents
method in order to cache the contents for this resource variant.
SEPARATOR.
IAction handler for the Copy
action.
IAction handler for the Copy
action.
IAction handler for the Copy
action.
Cursor of the Tracker.
IAction handler for the Cut
action.
IAction handler for the Cut
action.
IAction handler for the Cut
action.
CYCLING_ALWAYS,
CYCLING_NEVER, or CYCLING_WHEN_NO_PARENT,
which is the default.
null if the property is to be
removed.
IContainer.setDefaultCharset(String, IProgressMonitor) which
is a workspace operation and reports changes in resource deltas.
null.
IAction handler for the Delete
action.
IAction handler for the Delete
action.
IAction handler for the Delete
action.
WizardPage implementation of this IDialogPage
method extends the DialogPage implementation to update
the wizard container title bar.
PropertyChangeEvent if the new value differs from the old value.
true,
and disables it otherwise.
true,
and disables it otherwise.
true,
and disables it otherwise.
true,
and disables it otherwise.
true,
and disables it otherwise.
null.
PreferencePage implementation of this method
declared on DialogPage updates the container.
WizardPage implementation of this method
declared on DialogPage updates the container
if this is the current page.
IExitPolicy to customize the exit behavior of
this linked mode UI.
null if none.
patterns
in the preference store.
IAction handler for the Find
action.
IAction handler for the Find
action.
Page implementation of this IPage method
does nothing. Subclasses must implement.
MultiPageEditor implementation of this
IWorkbenchPart method sets focus on the active nested editor,
if there is one.
MultiPageEditor implementation of this
IWorkbenchPart method sets focus on the active nested editor,
if there is one.
Page implementation of this IPage method
does nothing.
Page implementation of this IPage method
does nothing.
true,
and marks it invisible otherwise.
RetargetAction implementation of this method declared on
IAction stores the help listener in a local field.
RetargetTextEditorAction implementation of this method declared on
IAction stores the help listener in a local field.
null or the proxy port is
null the connection will not use HTTP proxy server.
null if
this extension does not have an identifier.
null
if this extension point does not have an identifier.
IAnnotationPresentation
WizardPage implementation of this method
declared on DialogPage updates the container
if this page is the current page.
SWT:
NONE, ROMAN, DBCS,
PHONETIC, NATIVE, ALPHA.
IConfigurationElement.createExecutableExtension
on a newly constructed extension, passing it its relevant configuration
information.
IntroPart implementation of this
IExecutableExtension records the configuration element in
and internal state variable (accessible via getConfigElement).
IntroPart implementation of this
IExecutableExtension records the configuration element in
and internal state variable (accessible via getConfigElement).
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 suppliedStringHashtable containing the actual
parameter names and values (both Strings)WorkbenchPart implementation of this
IExecutableExtension records the configuration element in
and internal state variable (accessible via getConfigElement).
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 suppliedStringHashtable containing the actual
parameter names and values (both Strings)WorkbenchPart implementation of this
IExecutableExtension records the configuration element in
and internal state variable (accessible via getConfigElement).
IExecutableExtension
documentation.
ContentViewer implementation of this Viewer
method invokes inputChanged on the content provider and then the
inputChanged hook method.
uiState object.
null to indicate no input.
null to indicate no input.
Viewer framework
method ensures that the given label provider is an instance
of ILabelProvider.
Viewer framework
method ensures that the given label provider is an instance
of either ITableLabelProvider or ILabelProvider.
Viewer framework
method ensures that the given label provider is an instance
of either ITableLabelProvider or ILabelProvider.
Viewer framework
method ensures that the given label provider is an instance
of ILabelProvider.
IAnnotationPresentation
SWT.LINE_SOLID, SWT.LINE_DASH,
SWT.LINE_DOT, SWT.LINE_DASHDOT or
SWT.LINE_DASHDOTDOT.
drawLine, drawRectangle,
drawPolyline, and so forth.
true,
and marks it invisible otherwise.
plugin.xml)
which corresponds to this plug-in descriptor.
-1.
true,
and marks it invisible otherwise.
null.
PreferencePage implementation of this method
declared on DialogPage updates the container.
WizardPage implementation of this method
declared on DialogPage updates the container
if this is the current page.
true,
and marks it invisible otherwise.
MODE_* constants.
INCOMING_MODE,
OUTGOING_MODE, BOTH_MODE
or CONFLICTING_MODE).
SWT.LEFT_TO_RIGHT or SWT.LEFT_TO_RIGHT.
SWT.LEFT_TO_RIGHT or SWT.RIGHT_TO_LEFT.
SWT.LEFT_TO_RIGHT or SWT.RIGHT_TO_LEFT.
SWT.LEFT_TO_RIGHT or SWT.RIGHT_TO_LEFT.
null.
null
to clear the image for the page.
null
to clear the image for the page.
IAction handler for the Paste
action.
IAction handler for the Paste
action.
IAction handler for the Paste
action.
x in
scanline y in the receiver's data.
x in
scanline y in the receiver's data to the
values from the array pixels starting at
startIndex.
x in
scanline y in the receiver's data to the
values from the array pixels starting at
startIndex.
key in the formatting context.
ResourcePropertySource implementation of this
IPropertySource method does nothing since all
properties are read-only.
IAction handler for the Redo
action.
IAction handler for the Redo
action.
ITextViewerExtension.setRedraw(boolean).
false, causes subsequent drawing
operations in the receiver to be ignored.
null if the
selection was canceled.
IAction handler for the Select All
action.
IAction handler for the Select All
action.
IAction handler for the Select All
action.
ContentMergeViewer implementation of this
Viewer method does nothing.
ISelectionProvider
method make the new selection for this viewer without making it visible.
CHECK,
RADIO, or TOGGLE.
null to indicate no selection.
null to indicate no selection.
MultiPageEditorSite implementation of this
IWorkbenchPartSite method remembers the selection provider,
and also hooks a listener on it, which calls handleSelectionChanged
when a selection changed event occurs.
MultiPageEditorSite implementation of this
IWorkbenchPartSite method remembers the selection provider,
and also hooks a listener on it, which calls handleSelectionChanged
when a selection changed event occurs.
null if the
selection was canceled.
List and calls
setSelectionToWidget(List, boolean).
null
if source lookup is not supported.
StructureDiffViewer with a structure creator.
SWT
constants NORMAL, BOLD and ITALIC.
INCOMING_MODE,
OUTGOING_MODE, BOTH_MODE
and CONFLICTING_MODE).
IProgressMonitor
method forwards to the wrapped progress monitor.
null
if this job is not running or the thread is unknown.
DialogPage implementation of this
IDialogPage method remembers the title in an internal
state variable.
PreferencePage implementation of this IDialogPage
method extends the DialogPage implementation to update
the preference page container title.
WizardPage implementation of this IDialogPage
method extends the DialogPage implementation to update
the wizard container title bar.
IAction handler for the Undo
action.
IAction handler for the Undo
action.
IAntPropertyValueProvider to be used to dynamically provide a
value for this property.
PropertySheetEntry implmentation of this
method declared onIPropertySheetEntry will
obtain an editable value for the given objects and update
the child entries.
IContributionItem
method stores the value in an internal state variable,
which is true by default.
DialogPage implementation of this
IDialogPage method sets the control to the given
visibility state.
true,
and marks it invisible otherwise.
true,
and marks it invisible otherwise.
true,
and marks it invisible otherwise.
true,
and marks it invisible otherwise.
true,
and makes it invisible otherwise.
true prevents these
messages from being printed.
null to clear it.
true, puts the receiver
in a drawing mode where the resulting color in the destination
is the exclusive or of the color values in the source
and the destination, and if the argument is false,
puts the receiver in a drawing mode where the destination color
is replaced with the source color value.
t so that its length doesn't
exceed the given width.
textValue so that its width in
pixels does not exceed the width of the given control.
t so that its length doesn't exceed
the given width.
run() method before
the operation is run in the operation's context.
Browser
is requested to be displayed.
setErrorMessage.
ContentOutline implementation of this PageBookView method
extends the behavior of its parent to use the current page as a selection provider.
Runnable while providing
busy feedback using this busy indicator.
Plugin method
closes the workspace (without saving).
Plugin.stop(BundleContext context).
Implementations of shutdown() should be changed to override
stop(BundleContext context) and call super.stop(context)
instead of super.shutdown().
The shutdown() method is called only for plug-ins which explicitly require the
org.eclipse.core.runtime.compatibility plug-in.
shutdown has been replaced by Plugin.stop(BundleContext context).
Implementations of shutdown should be changed to extend
stop(BundleContext context) and call super.stop(context)
instead of super.shutdown(). Unlike super.shutdown(),
super.stop(context) must be called as the very last thing rather
than as the very first thing. The shutdown method is called
only for plug-ins which explicitly require the
org.eclipse.core.runtime.compatibility plug-in;
in contrast, the stop method is always called.
Shell hosting the Browser.
AbstractUIPlugin implementation of this Plugin
method refreshes the plug-in actions.
-1
if none matches.
Plugin method
opens the workspace.
Plugin.start(BundleContext context).
Implementations of startup() should be changed to extend
start(BundleContext context) and call super.start(context)
instead of super.startup().
The startup() method is called only for plug-ins which explicitly require the
org.eclipse.core.runtime.compatibility plug-in.
startup has been replaced by Plugin.start(BundleContext context).
Implementations of startup should be changed to extend
start(BundleContext context) and call super.start(context)
instead of super.startup(). Like super.startup(),
super.stop(context) must be called as the very first thing.
The startup method is called only for plug-ins which explicitly require the
org.eclipse.core.runtime.compatibility plug-in; in contrast,
the start method is always called.
RESUME
and SUSPEND events for the associated thread.
RESUME
and SUSPEND events for the associated thread.
RESUME and SUSPEND events for
the associated thread.
RESUME
and SUSPEND events for the associated thread, applying step
filters, as applicable for the associated thread.
delayRestart is set
allows restart only after a certain delay.
AbstractUIPlugin implementation of this Plugin
method saves this plug-in's preference and dialog stores and shuts down
its image registry (if they are in use).
replace operation.
resumePostNotificationProcessing is called.
Properties.store(OutputStream,String).
IProgressMonitor
method forwards to the wrapped progress monitor.
prependVerifyKeyListener
or IContentAssistSubjectControl.appendVerifyKeyListener(VerifyKeyListener).
SUSPEND event.
model.
run() method of the runnable to
be invoked by the user-interface thread at the next
reasonable opportunity.
run() method of the runnable to
be invoked by the user-interface thread at the next
reasonable opportunity.
SyncInfoSet changes.
SyncInfo
for a resource.
SyncInfoSet have been reset or the
listener has been connected to the set for the first time using
SyncInfoSet#connect(ISyncInfoSetChangeListener, IProgressMonitor).
|
Eclipse Platform Release 3.0 |
||||||||||
| PREV LETTER NEXT LETTER | FRAMES NO FRAMES | ||||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.