Package org.eclipse.jface.text
Class DocumentCommand
java.lang.Object
org.eclipse.jface.text.DocumentCommand
Represents a text modification as a document replace command. The text
modification is given as a
VerifyEvent
and
translated into a document replace command relative to a given offset. A
document command can also be used to initialize a given
VerifyEvent
.
A document command can also represent a list of related changes.
-
Field Summary
Modifier and TypeFieldDescriptionint
The caret offset with respect to the document before the document command is executed.boolean
Must the command be updatedint
The length of the commandint
The offset of the command.The owner of the document command which will not be notified.boolean
Indicates whether the caret should be shifted by this command.The text to be inserted -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addCommand
(int commandOffset, int commandLength, String commandText, IDocumentListener commandOwner) Adds an additional replace command.int
Returns the number of commands including the original document command.Iterator<org.eclipse.jface.text.DocumentCommand.Command>
Returns an iterator over the commands in ascending position order.
-
Field Details
-
doit
public boolean doitMust the command be updated -
offset
public int offsetThe offset of the command. -
length
public int lengthThe length of the command -
text
The text to be inserted -
owner
The owner of the document command which will not be notified.- Since:
- 2.1
-
caretOffset
public int caretOffsetThe caret offset with respect to the document before the document command is executed.- Since:
- 2.1
-
shiftsCaret
public boolean shiftsCaretIndicates whether the caret should be shifted by this command.- Since:
- 3.0
-
-
Constructor Details
-
DocumentCommand
protected DocumentCommand()Creates a new document command.
-
-
Method Details
-
addCommand
public void addCommand(int commandOffset, int commandLength, String commandText, IDocumentListener commandOwner) throws BadLocationException Adds an additional replace command. The added replace command must not overlap with existing ones. If the document command owner is notnull
, it will not get document change notifications for the particular command.- Parameters:
commandOffset
- the offset of the region to replacecommandLength
- the length of the region to replacecommandText
- the text to replace with, may benull
commandOwner
- the command owner, may benull
- Throws:
BadLocationException
- if the added command intersects with an existing one- Since:
- 2.1
-
getCommandIterator
Returns an iterator over the commands in ascending position order. The iterator includes the original document command. Commands cannot be removed.- Returns:
- returns the command iterator
-
getCommandCount
public int getCommandCount()Returns the number of commands including the original document command.- Returns:
- returns the number of commands
- Since:
- 2.1
-