org.eclipse.jface.text
Interface IEditingSupport
-
public interface IEditingSupport
Implemented by tools supporting the editing process.
Clients may ask an IEditingSupport whether it is currently
displaying a shell that has focus, and whether it is the origin of a document
event. Depending on the answers to these queries, clients may decide to react
differently to incoming notifications about events. For example, a special
editing mode, that usually deactivates when the main shell looses focus, may
decide to not deactivate if the focus event was triggered by an
IEditingSupport.
Clients may implement this interface.
-
Since:
- 3.1
-
See Also:
-
IEditingSupportRegistry
|
Method Summary
|
boolean
|
isOriginator
(
DocumentEvent event,
IRegion subjectRegion)
Returns true if the receiver is the originator of a
DocumentEvent and if that event is related
to subjectRegion. |
boolean
|
ownsFocusShell
()
Returns true if the receiver is showing a shell which has
focus, false if it does not have focus or the helper has
no shell. |
isOriginator
boolean isOriginator(
DocumentEvent event,
IRegion subjectRegion)
- Returns
true if the receiver is the originator of a
DocumentEvent and if that event is related
to subjectRegion.
The relationship between event and
subjectRegion is not always obvious. Often, the main
editing area being monitored by the caller will be at
subjectRegion, when the receiver modifies the underlying
document at a different location without wanting to interrupt the normal
typing flow of the user.
An example would be an editor that automatically increments the section
number of the next section when the user typed in a new section title. In
this example, the subject region is the current typing location, while
the increment results in a document change further down in the text.
-
-
Parameters:
-
event - the DocumentEvent in question -
subjectRegion - the region that the caller is interested in
-
Returns:
-
true if event was triggered by the
receiver and relates to subjectRegion
ownsFocusShell
boolean ownsFocusShell()
- Returns
true if the receiver is showing a shell which has
focus, false if it does not have focus or the helper has
no shell.
-
-
Returns:
-
true if the support's shell has focus,
false otherwise
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
