Package | Description |
---|---|
org.eclipse.core.filebuffers.manipulation |
Provides the API for manipulating file buffers.
|
org.eclipse.jface.text |
Provides a framework for creating and manipulating text documents.
|
org.eclipse.jface.text.link |
Application programming interfaces for interaction
with the Eclipse text editor's linked position support.
|
org.eclipse.jface.text.projection |
This package provides an implementation of projection documents.
|
org.eclipse.jface.text.rules |
Provides a framework for rule based text scanning
and uses the framework to provide rule-driven default implementations of
IPresentationDamager, IPresentationRepairer and IDocumentPartitioner.
|
org.eclipse.jface.text.source |
Provides a framework for connecting document regions
with annotations and for displaying those.
|
org.eclipse.jface.text.source.projection |
This package provides the UI part for projection documents of which the most important part is the projection viewer.
|
org.eclipse.jface.text.templates |
Application programming interfaces for interaction
with the Eclipse text template support.
|
org.eclipse.ltk.core.refactoring |
Application programmer interface to implement semantic preserving workspace transformations.
|
org.eclipse.text.edits |
Provides support for describing and applying textual document editions.
|
org.eclipse.ui.console |
Application programming interfaces for interaction
with the Eclipse console.
|
org.eclipse.ui.texteditor |
Provides a framework for text editors obeying to the
desktop rules.
|
Modifier and Type | Method and Description |
---|---|
UndoEdit |
MultiTextEditWithProgress.apply(IDocument document,
int style,
IProgressMonitor progressMonitor) |
UndoEdit |
MultiTextEditWithProgress.apply(IDocument document,
IProgressMonitor progressMonitor) |
Modifier and Type | Method and Description |
---|---|
void |
DocumentCommand.addCommand(int commandOffset,
int commandLength,
String commandText,
IDocumentListener commandOwner)
Adds an additional replace command.
|
void |
AbstractDocument.addPosition(Position position) |
void |
IDocument.addPosition(Position position)
Adds the position to the document's default position category.
|
void |
AbstractDocument.addPosition(String category,
Position position) |
void |
IDocument.addPosition(String category,
Position position)
Adds the position to the specified position category of the document.
|
protected void |
AbstractLineTracker.checkRewriteSession()
Checks the presence of a rewrite session and flushes it.
|
int |
AbstractDocument.computeIndexInCategory(String category,
int offset) |
int |
IDocument.computeIndexInCategory(String category,
int offset)
Computes the index at which a
Position with the
specified offset would be inserted into the given category. |
static ITypedRegion[] |
TextUtilities.computePartitioning(IDocument document,
String partitioning,
int offset,
int length,
boolean includeZeroLengthPartitions)
Computes and returns the partitioning for the given region of the given
document for the given partitioning name.
|
ITypedRegion[] |
AbstractDocument.computePartitioning(int offset,
int length) |
ITypedRegion[] |
IDocument.computePartitioning(int offset,
int length)
Computes the partitioning of the given document range using the
document's partitioner.
|
ITypedRegion[] |
AbstractDocument.computePartitioning(String partitioning,
int offset,
int length,
boolean includeZeroLengthPartitions) |
ITypedRegion[] |
IDocumentExtension3.computePartitioning(String partitioning,
int offset,
int length,
boolean includeZeroLengthPartitions)
Computes the partitioning of the given document range based on the given
partitioning type.
|
IRegion |
FindReplaceDocumentAdapter.find(int startOffset,
String findString,
boolean forwardSearch,
boolean caseSensitive,
boolean wholeWord,
boolean regExSearch)
Returns the location of a given string in this adapter's document based on a set of search criteria.
|
protected int |
DefaultIndentLineAutoEditStrategy.findEndOfWhiteSpace(IDocument document,
int offset,
int end)
Returns the first offset greater than
offset and smaller than
end whose character is not a space or tab character. |
protected void |
AbstractLineTracker.flushRewriteSession()
Flushes the active rewrite session.
|
String |
AbstractDocument.get(int pos,
int length) |
String |
IDocument.get(int offset,
int length)
Returns this document's text for the specified range.
|
char |
AbstractDocument.getChar(int pos) |
char |
IDocument.getChar(int offset)
Returns the character at the given document offset in this document.
|
static String |
TextUtilities.getContentType(IDocument document,
String partitioning,
int offset,
boolean preferOpenPartitions)
Returns the content type at the given offset of the given document.
|
String |
AbstractDocument.getContentType(int offset) |
String |
IDocument.getContentType(int offset)
Returns the type of the document partition containing the given offset.
|
String |
AbstractDocument.getContentType(String partitioning,
int offset,
boolean preferOpenPartitions) |
String |
IDocumentExtension3.getContentType(String partitioning,
int offset,
boolean preferOpenPartitions)
Returns the type of the document partition containing the given offset
for the given partitioning.
|
static IRegion[] |
JFaceTextUtil.getCoveredRanges(ITextViewer viewer,
ITextSelection selection)
Returns the text regions covered by the given selection in the given viewer.
|
IRegion[] |
IDocumentInformationMappingExtension.getExactCoverage(IRegion originRegion)
Returns the maximal sub-regions of the given origin region which are
completely covered.
|
String |
AbstractDocument.getLineDelimiter(int line) |
String |
AbstractLineTracker.getLineDelimiter(int line) |
String |
ILineTracker.getLineDelimiter(int line)
Returns the line delimiter of the specified line.
|
String |
IDocument.getLineDelimiter(int line)
Returns the line delimiter of that line or
null if the
line is not closed with a line delimiter. |
IRegion |
AbstractDocument.getLineInformation(int line) |
IRegion |
AbstractLineTracker.getLineInformation(int line) |
IRegion |
ILineTracker.getLineInformation(int line)
Returns a line description of the given line.
|
IRegion |
IDocument.getLineInformation(int line)
Returns a description of the specified line.
|
IRegion |
AbstractDocument.getLineInformationOfOffset(int offset) |
IRegion |
AbstractLineTracker.getLineInformationOfOffset(int offset) |
IRegion |
ILineTracker.getLineInformationOfOffset(int offset)
Returns a line description of the line at the given offset.
|
IRegion |
IDocument.getLineInformationOfOffset(int offset)
Returns a description of the line at the given offset.
|
int |
AbstractDocument.getLineLength(int line) |
int |
AbstractLineTracker.getLineLength(int line) |
int |
ILineTracker.getLineLength(int line)
Returns length of the specified line including the line's delimiter.
|
int |
IDocument.getLineLength(int line)
Returns the length of the given line including the line's delimiter.
|
int |
AbstractLineTracker.getLineNumberOfOffset(int offset) |
int |
ILineTracker.getLineNumberOfOffset(int offset)
Returns the line number the character at the given offset belongs to.
|
int |
AbstractDocument.getLineOffset(int line) |
int |
AbstractLineTracker.getLineOffset(int line) |
int |
ILineTracker.getLineOffset(int line)
Returns the position of the first character of the specified line.
|
int |
IDocument.getLineOffset(int line)
Determines the offset of the first character of the given line.
|
int |
AbstractDocument.getLineOfOffset(int pos) |
int |
IDocument.getLineOfOffset(int offset)
Returns the number of the line at which the character of the specified position is located.
|
int |
AbstractDocument.getNumberOfLines(int offset,
int length) |
int |
AbstractLineTracker.getNumberOfLines(int offset,
int length) |
int |
ILineTracker.getNumberOfLines(int offset,
int length)
Returns the number of lines which are occupied by a given text range.
|
int |
IDocument.getNumberOfLines(int offset,
int length)
Returns the number of lines which are occupied by a given text range.
|
static ITypedRegion |
TextUtilities.getPartition(IDocument document,
String partitioning,
int offset,
boolean preferOpenPartitions)
Returns the partition of the given offset of the given document.
|
ITypedRegion |
AbstractDocument.getPartition(int offset) |
ITypedRegion |
IDocument.getPartition(int offset)
Returns the document partition in which the position is located.
|
ITypedRegion |
AbstractDocument.getPartition(String partitioning,
int offset,
boolean preferOpenPartitions) |
ITypedRegion |
IDocumentExtension3.getPartition(String partitioning,
int offset,
boolean preferOpenPartitions)
Returns the document partition of the given partitioning in which the
given offset is located.
|
static boolean |
JFaceTextUtil.isEmpty(ITextViewer viewer,
ITextSelection selection)
Returns
true if the text covered by selection does not contain any
characters in the given viewer. |
boolean |
Document.isLineInformationRepairNeeded(int offset,
int length,
String text) |
boolean |
AbstractDocument.isLineInformationRepairNeeded(int offset,
int length,
String text)
Tells whether the line information of the document implementing this interface needs to be
repaired after replacing the given text.
|
boolean |
IRepairableDocumentExtension.isLineInformationRepairNeeded(int offset,
int length,
String text)
Tells whether the line information of the document implementing this interface needs to be
repaired after replacing the given text.
|
static DocumentEvent |
TextUtilities.mergeProcessedDocumentEvents(List documentEvents)
Returns a document event which is an accumulation of a list of document events,
null if the list of document events is empty. |
static DocumentEvent |
TextUtilities.mergeUnprocessedDocumentEvents(IDocument unprocessedDocument,
List documentEvents)
Returns a document event which is an accumulation of a list of document events,
null if the list of documentEvents is empty. |
UndoEdit |
RewriteSessionEditProcessor.performEdits() |
void |
AbstractDocument.replace(int pos,
int length,
String text) |
void |
AbstractLineTracker.replace(int offset,
int length,
String text) |
void |
ILineTracker.replace(int offset,
int length,
String text)
Informs the line tracker about the specified change in the tracked text.
|
void |
IDocument.replace(int offset,
int length,
String text)
Substitutes the given text for the specified document range.
|
void |
AbstractDocument.replace(int pos,
int length,
String text,
long modificationStamp) |
void |
IDocumentExtension4.replace(int offset,
int length,
String text,
long modificationStamp)
Substitutes the given text for the specified document range.
|
IRegion |
FindReplaceDocumentAdapter.replace(String text,
boolean regExReplace)
Substitutes the previous match with the given text.
|
int |
AbstractDocument.search(int startPosition,
String findString,
boolean forwardSearch,
boolean caseSensitive,
boolean wholeWord)
Deprecated.
as of 3.0 search is provided by
FindReplaceDocumentAdapter |
int |
IDocument.search(int startOffset,
String findString,
boolean forwardSearch,
boolean caseSensitive,
boolean wholeWord)
Deprecated.
as of 3.0 search is provided by
FindReplaceDocumentAdapter |
int |
IDocumentInformationMapping.toClosestImageLine(int originLine)
Returns the line of the image document whose corresponding line in the original document
is closest to the given line in the original document.
|
IRegion |
IDocumentInformationMappingExtension2.toClosestImageRegion(IRegion originRegion)
Returns the minimal region of the image document that completely
comprises the given region of the original document.
|
IRegion |
IDocumentInformationMappingExtension.toExactImageRegion(IRegion originRegion)
Adheres to
originRegion=toOriginRegion(toExactImageRegion(originRegion)) ,
if toExactImageRegion(originRegion) ! |
IRegion[] |
IDocumentInformationMappingExtension.toExactImageRegions(IRegion originRegion)
Returns the segments of the image document that exactly correspond to the
given region of the original document.
|
IRegion[] |
IDocumentInformationMappingExtension.toExactOriginRegions(IRegion imageRegion)
Returns the fragments of the original document that exactly correspond to
the given region of the image document.
|
int |
IDocumentInformationMapping.toImageLine(int originLine)
Returns the line of the image document that corresponds to the given line of the original document or
-1 if there is no such line. |
int |
IDocumentInformationMapping.toImageOffset(int originOffset)
Returns the offset in the image document that corresponds to the given offset in the original document
or
-1 if there is no such offset |
IRegion |
IDocumentInformationMapping.toImageRegion(IRegion originRegion)
Returns the minimal region of the image document that completely comprises the given region of the
original document or
null if there is no such region. |
int |
IDocumentInformationMapping.toOriginLine(int imageLine)
Returns the line of the original document that corresponds to the given line of the image document or
-1 if there is no such line. |
IRegion |
IDocumentInformationMapping.toOriginLines(int imageLine)
Returns the range of lines of the original document that corresponds to the given line of the image document or
null if there are no such lines. |
int |
IDocumentInformationMapping.toOriginOffset(int imageOffset)
Returns the offset in the original document that corresponds to the given offset in the image document
or
-1 if there is no such offset |
IRegion |
IDocumentInformationMapping.toOriginRegion(IRegion imageRegion)
Returns the minimal region of the original document that completely comprises the given region of the
image document or
null if there is no such region. |
protected boolean |
TextViewer.updateSlaveDocument(IDocument slaveDocument,
int modelRangeOffset,
int modelRangeLength)
Updates the given slave document to show the specified range of its master document.
|
protected boolean |
TextViewer.updateVisibleDocument(IDocument visibleDocument,
int visibleRegionOffset,
int visibleRegionLength)
Deprecated.
use
updateSlaveDocument instead |
Modifier and Type | Method and Description |
---|---|
void |
LinkedModeModel.addGroup(LinkedPositionGroup group)
Adds a position group to this
LinkedModeModel . |
void |
LinkedPositionGroup.addPosition(LinkedPosition position)
Adds a position to this group.
|
void |
LinkedModeModel.forceInstall()
Installs this model, which includes registering as document
listener on all involved documents and storing global information about
this model.
|
String |
LinkedPosition.getContent()
Returns the content of this position on the referenced document.
|
void |
LinkedModeUI.setExitPosition(ITextViewer viewer,
int offset,
int length,
int sequence)
Sets the exit position to move the caret to when linked mode is exited.
|
void |
LinkedModeUI.setExitPosition(LinkedModeUI.LinkedModeUITarget target,
int offset,
int length,
int sequence)
Sets the exit position to move the caret to when linked mode mode is
exited.
|
boolean |
LinkedModeModel.tryInstall()
Installs this model, which includes registering as document
listener on all involved documents and storing global information about
this model.
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
ProjectionDocument.adaptProjectionToMasterChange(DocumentEvent masterEvent)
Ensures that when the master event affects this projection document, that the whole region described by the
event is part of this projection document.
|
void |
ProjectionDocument.addMasterDocumentRange(int offsetInMaster,
int lengthInMaster)
Ensures that the given range of the master document is part of this
projection document.
|
IRegion[] |
ProjectionDocument.computeProjectedMasterRegions(int offsetInMaster,
int lengthInMaster)
Returns the sequence of all master document regions with are contained in the given master document
range and which are part of this projection document.
|
IRegion[] |
ProjectionDocument.computeUnprojectedMasterRegions(int offsetInMaster,
int lengthInMaster)
Returns the sequence of all master document regions which are contained
in the given master document range and which are not yet part of this
projection document.
|
IRegion[] |
ProjectionMapping.getExactCoverage(IRegion originRegion) |
void |
ProjectionDocument.removeMasterDocumentRange(int offsetInMaster,
int lengthInMaster)
Ensures that the given range of the master document is not part of this
projection document.
|
void |
ProjectionDocument.replace(int offset,
int length,
String text) |
void |
ProjectionDocument.replaceMasterDocumentRanges(int offsetInMaster,
int lengthInMaster)
Replaces all master document ranges with the given master document range.
|
void |
ChildDocument.setParentDocumentRange(int offset,
int length)
Sets the parent document range covered by this child document to the
given range.
|
int |
ProjectionMapping.toClosestImageLine(int originLine) |
IRegion |
ProjectionMapping.toClosestImageRegion(IRegion originRegion) |
IRegion |
ProjectionMapping.toExactImageRegion(IRegion originRegion) |
IRegion[] |
ProjectionMapping.toExactImageRegions(IRegion originRegion) |
IRegion[] |
ProjectionMapping.toExactOriginRegions(IRegion imageRegion) |
int |
ProjectionMapping.toImageLine(int originLine) |
int |
ProjectionMapping.toImageOffset(int originOffset) |
IRegion |
ProjectionMapping.toImageRegion(IRegion originRegion) |
int |
ProjectionMapping.toOriginLine(int imageLine) |
IRegion |
ProjectionMapping.toOriginLines(int imageLine) |
int |
ProjectionMapping.toOriginOffset(int imageOffset) |
IRegion |
ProjectionMapping.toOriginRegion(IRegion imageRegion) |
Modifier and Type | Method and Description |
---|---|
protected int |
DefaultDamagerRepairer.endOfLineOf(int offset)
Returns the end offset of the line that contains the specified offset or
if the offset is inside a line delimiter, the end offset of the next line.
|
Modifier and Type | Method and Description |
---|---|
protected void |
AnnotationModel.addAnnotation(Annotation annotation,
Position position,
boolean fireModelChanged)
Adds the given annotation to this model.
|
protected void |
AnnotationModel.addPosition(IDocument document,
Position position)
Adds the given position to the default position category of the
given document.
|
protected void |
AnnotationModel.replaceAnnotations(Annotation[] annotationsToRemove,
Map annotationsToAdd,
boolean fireModelChanged)
Replaces the given annotations in this model and if advised fires a
model change event.
|
int |
ILineDiffer.restoreAfterLine(int line)
Restores the deleted lines after
line . |
void |
ILineDiffer.revertBlock(int line)
Reverts a block of modified / added lines to their original state, including any deleted
lines inside the block or at its borders.
|
void |
ILineDiffer.revertLine(int line)
Reverts a single changed line to its original state, not touching any lines that
are deleted at its borders.
|
void |
ILineDiffer.revertSelection(int line,
int nLines)
Reverts a range of lines to their original state, including any deleted
lines inside the block or at its borders.
|
Modifier and Type | Method and Description |
---|---|
int |
IProjectionPosition.computeCaptionOffset(IDocument document)
Returns the offset of the caption (the anchor region) of this projection
position.
|
IRegion[] |
IProjectionPosition.computeProjectionRegions(IDocument document)
Returns an array of regions that should be collapsed when the annotation
belonging to this position is collapsed.
|
void |
ProjectionViewer.reinitializeProjection()
Forces this viewer to throw away any old state and to initialize its content
from its projection annotation model.
|
protected boolean |
ProjectionViewer.updateSlaveDocument(IDocument slaveDocument,
int modelRangeOffset,
int modelRangeLength) |
Modifier and Type | Method and Description |
---|---|
TemplateBuffer |
DocumentTemplateContext.evaluate(Template template) |
abstract TemplateBuffer |
TemplateContext.evaluate(Template template)
Evaluates the template in this context and returns a template buffer.
|
void |
TemplateContextType.resolve(TemplateBuffer buffer,
TemplateContext context)
Resolves the variables in
buffer within context
and edits the template buffer to reflect the resolved variables. |
Modifier and Type | Method and Description |
---|---|
protected UndoEdit |
DocumentChange.performEdits(IDocument document) |
protected UndoEdit |
TextFileChange.performEdits(IDocument document) |
protected UndoEdit |
TextChange.performEdits(IDocument document)
Executes the text edits on the given document.
|
Modifier and Type | Method and Description |
---|---|
UndoEdit |
TextEdit.apply(IDocument document)
Applies the edit tree rooted by this edit to the given document.
|
UndoEdit |
TextEdit.apply(IDocument document,
int style)
Applies the edit tree rooted by this edit to the given document.
|
UndoEdit |
TextEditProcessor.performEdits()
Executes the text edits.
|
Modifier and Type | Method and Description |
---|---|
void |
TextConsole.addHyperlink(IHyperlink hyperlink,
int offset,
int length)
Adds a hyperlink to this console.
|
Modifier and Type | Method and Description |
---|---|
void |
TextViewerDeleteLineTarget.deleteLine(IDocument document,
int offset,
int length,
int type,
boolean copyToClipboard) |
void |
TextViewerDeleteLineTarget.deleteLine(IDocument document,
ITextSelection selection,
int type,
boolean copyToClipboard)
Deletes the lines that intersect with the given
selection . |
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.