Uses of Interface
org.eclipse.jface.text.IDocument
Package
Description
Provides support for performing structural and textual
compare operations on arbitrary data and displaying the results.
Support for compare and merge viewers which show the
content side-by-side.
Provides support for finding and displaying the differences
between hierarchically structured data.
Provides the API for accessing file buffers.
Provides the API for manipulating file buffers.
Provides a set of actions related to running and debugging applications.
Provides a set of interfaces and classes for rendering and annotating text in the debug console.
Provides a content assist add-on for implementors of
IContentAssistSubjectControl
.Provides a framework for creating and manipulating text documents.
Provides a content assist add-on for an
ITextViewer
.Provides a content formatter add-on for an
ITextViewer
.Provides support for detecting and displaying hyperlinks in
ISourceViewer
s.Application programming interfaces for interaction
with the Eclipse text editor's linked position support.
Provides a presentation reconciler add-on for an
ITextViewer
.This package provides an implementation of projection documents.
Provides a reconciler add-on for an
ITextViewer
.Provides a framework for rule based text scanning
and uses the framework to provide rule-driven default implementations of
IPresentationDamager
, IPresentationRepairer
and IDocumentPartitioner
.Provides a framework for connecting document regions
with annotations and for displaying those.
This package provides the UI part for projection documents of which the most important part is the projection viewer.
Application programming interfaces for interaction
with the Eclipse text template support.
Application programmer interface to implement semantic preserving workspace transformations.
Application programming interface to implement a wizard based user interface for refactorings.
Provides the base classes to implement a search result view part for searches with textual matches.
Provides support for describing and applying textual document editions.
Provides undo and redo support for a document.
Application programming interfaces for interaction
with the Eclipse console.
Provides a standard text editor and concrete document providers based
IFileBuffer
and others directly handling IFile
and
IStorage
as editor input.Provides a framework for text editors obeying to the
desktop rules.
Provides interfaces to for the
org.eclipse.ui.editors.quickDiffReferenceProvider
extension point and adds an action to enable quick diff display for an editor.Partial infrastructure for spell checking in text editors.
Application programming interfaces for interaction
with the Eclipse text editor template support.
-
Uses of IDocument in org.eclipse.compare
Modifier and TypeMethodDescriptionstatic IDocument
CompareUI.getDocument
(Object input) Retrieve a document for the given input or returnnull
if no document has been registered for the input.Modifier and TypeMethodDescriptionvoid
ISharedDocumentAdapter.flushDocument
(IDocumentProvider provider, IEditorInput documentKey, IDocument document, boolean overwrite) Flush the contents of the given document into the typed element that provided the document.static void
CompareUI.registerDocument
(Object input, IDocument document) Register a document for the given input.protected void
SharedDocumentAdapter.saveDocument
(IDocumentProvider provider, IEditorInput documentKey, IDocument document, boolean overwrite, IProgressMonitor monitor) A helper method to save a document.static void
CompareUI.unregisterDocument
(IDocument document) Unregister the given document. -
Uses of IDocument in org.eclipse.compare.contentmergeviewer
Modifier and TypeMethodDescriptionprotected Optional<IIgnoreWhitespaceContributor>
TextMergeViewer.createIgnoreWhitespaceContributor
(IDocument document) Creates anIIgnoreWhitespaceContributor
which allows to hook into the ignore whitespace logic in the compare viewer.protected void
TextMergeViewer.setupDocument
(IDocument document) Setup the given document for use with this viewer. -
Uses of IDocument in org.eclipse.compare.internal
Modifier and TypeMethodDescriptionstatic IDocument
IMergeViewerTestAdapter.getDocument
(char leg) Return the document for the given legstatic IDocument
Utilities.getDocument
(char type, Object element, boolean isUsingDefaultContentProvider, boolean canHaveSharedDocument) MergeSourceViewer.getRememberedDocument()
Modifier and TypeMethodDescriptionstatic void
void
MergeSourceViewer.rememberDocument
(IDocument doc) static void
ModifierConstructorDescriptionDocLineComparator
(IDocument document, IRegion region, boolean ignoreWhiteSpace) Creates aDocLineComparator
for the given document range.DocLineComparator
(IDocument document, IRegion region, boolean ignoreWhiteSpace, ICompareFilter[] compareFilters, char contributor, Optional<IIgnoreWhitespaceContributor> ignoreWhitespaceContributor) Creates aDocLineComparator
for the given document range. -
Uses of IDocument in org.eclipse.compare.structuremergeviewer
Modifier and TypeMethodDescriptionprotected abstract IStructureComparator
StructureCreator.createStructureComparator
(Object element, IDocument document, ISharedDocumentAdapter sharedDocumentAdapter, IProgressMonitor monitor) Creates anIStructureComparator
for the given element using the contents available in the given document.void
SharedDocumentAdapterWrapper.flushDocument
(IDocumentProvider provider, IEditorInput documentKey, IDocument document, boolean overwrite) protected void
StructureCreator.setupDocument
(IDocument document) Sets up the newly created document as appropriate.ModifierConstructorDescriptionDocumentRangeNode
(int typeCode, String id, IDocument document, int start, int length) Creates a newDocumentRangeNode
for the given range within the specified document.DocumentRangeNode
(DocumentRangeNode parent, int typeCode, String id, IDocument document, int start, int length) Creates a newDocumentRangeNode
for the given range within the specified document.StructureRootNode
(IDocument document, Object input, StructureCreator creator, ISharedDocumentAdapter adapter) Create the structure root node. -
Uses of IDocument in org.eclipse.core.filebuffers
Modifier and TypeMethodDescriptionIDocumentFactory.createDocument()
Deprecated.Creates and returns a new, empty document.ITextFileBufferManager.createEmptyDocument
(IPath location) Deprecated.ITextFileBufferManager.createEmptyDocument
(IPath location, LocationKind locationKind) Creates a new empty document.ITextFileBuffer.getDocument()
Returns the document of this text file buffer.Modifier and TypeMethodDescriptionvoid
Transforms the current transient state of the annotation model into a persistent state.ITextFileBufferManager.getTextFileBuffer
(IDocument document) Returns the text file buffer managed for the given document ornull
if there is no such text file buffer.void
IPersistableAnnotationModel.reinitialize
(IDocument document) Forces this annotation model to re-initialize from the persistent state.void
Changes the current transient state of the annotation model to match the last persisted state.void
Sets up the document to be ready for use by a text file buffer.void
IDocumentSetupParticipantExtension.setup
(IDocument document, IPath location, LocationKind locationKind) Sets up the document to be ready for use by a text file buffer. -
Uses of IDocument in org.eclipse.core.filebuffers.manipulation
Modifier and TypeMethodDescriptionfinal UndoEdit
MultiTextEditWithProgress.apply
(IDocument document, int style, IProgressMonitor progressMonitor) final UndoEdit
MultiTextEditWithProgress.apply
(IDocument document, IProgressMonitor progressMonitor) -
Uses of IDocument in org.eclipse.debug.ui.actions
ModifierConstructorDescriptionRunToLineAction
(IWorkbenchPart part, IDocument document, IVerticalRulerInfo rulerInfo) Constructs a new action to toggle a breakpoint in the given part containing the given document and ruler.ToggleBreakpointAction
(IWorkbenchPart part, IDocument document, IVerticalRulerInfo rulerInfo) Constructs a new action to toggle a breakpoint in the given part containing the given document and ruler. -
Uses of IDocument in org.eclipse.debug.ui.console
Modifier and TypeMethodDescriptionIConsole.getDocument()
Returns the document associated with this console. -
Uses of IDocument in org.eclipse.jface.contentassist
Modifier and TypeMethodDescriptionComboContentAssistSubjectAdapter.getDocument()
Deprecated.IContentAssistSubjectControl.getDocument()
Returns this content assist subject control's document.TextContentAssistSubjectAdapter.getDocument()
Deprecated. -
Uses of IDocument in org.eclipse.jface.text
Modifier and TypeClassDescriptionclass
Abstract default implementation ofIDocument
and its extension interfacesIDocumentExtension
,IDocumentExtension2
,IDocumentExtension3
,IDocumentExtension4
, as well asIRepairableDocument
.class
Default document implementation.Modifier and TypeFieldDescriptionprotected IDocument
DefaultPositionUpdater.fDocument
Caches the documentDocumentEvent.fDocument
The changed documentDocumentRewriteSessionEvent.fDocument
The changed documentModifier and TypeMethodDescriptionISlaveDocumentManager.createSlaveDocument
(IDocument master) Creates a new slave document for the given master document.protected IDocument
TextViewer.createSlaveDocument
(IDocument document) Creates a slave document for the given document if there is a slave document manager associated with this viewer.DocumentEvent.getDocument()
Returns the changed document.DocumentPartitioningChangedEvent.getDocument()
Returns the changed document.DocumentRewriteSessionEvent.getDocument()
Returns the changed document.IMarkSelection.getDocument()
Returns the marked document.IRewriteTarget.getDocument()
Returns the document of this target.ITextViewer.getDocument()
Returns the text viewer's input document.MarkSelection.getDocument()
protected IDocument
TextSelection.getDocument()
Returns the document underlying the receiver, possiblynull
.TextViewer.getDocument()
ISlaveDocumentManager.getMasterDocument
(IDocument slave) Returns the master document of the given slave document ornull
if the given document is unknown to this slave document manager.ISlaveDocumentManagerExtension.getSlaveDocuments
(IDocument master) Returns the list of slave documents for the given master document ornull
if there are no such slave document.protected IDocument
TextViewer.getVisibleDocument()
Returns the viewer's visible document.Modifier and TypeMethodDescriptionstatic void
TextUtilities.addDocumentPartitioners
(IDocument document, Map<String, ? extends IDocumentPartitioner> partitioners) Connects the given document with all document partitioners stored in the given map under their partitioning name.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.static String[]
TextUtilities.computePartitionManagingCategories
(IDocument document) Computes and returns the partition managing position categories for the given document ornull
if this was impossible.void
Connects the partitioner to a document.void
Connects this partitioner to a document.ISlaveDocumentManager.createMasterSlaveMapping
(IDocument slave) Creates a new document information mapping between the given slave document and its master document.ISlaveDocumentManager.createSlaveDocument
(IDocument master) Creates a new slave document for the given master document.protected IDocument
TextViewer.createSlaveDocument
(IDocument document) Creates a slave document for the given document if there is a slave document manager associated with this viewer.void
DefaultIndentLineAutoEditStrategy.customizeDocumentCommand
(IDocument d, DocumentCommand c) void
IAutoEditStrategy.customizeDocumentCommand
(IDocument document, DocumentCommand command) Allows the strategy to manipulate the document command.void
TabsToSpacesConverter.customizeDocumentCommand
(IDocument document, DocumentCommand command) void
IDocumentPartitioningListener.documentPartitioningChanged
(IDocument document) The partitioning of the given document changed.void
IDocumentPartitioningListenerExtension.documentPartitioningChanged
(IDocument document, IRegion region) The partitioning of the given document changed in the given region.protected int
DefaultIndentLineAutoEditStrategy.findEndOfWhiteSpace
(IDocument document, int offset, int end) Returns the first offset greater thanoffset
and smaller thanend
whose character is not a space or tab character.protected IRegion
DefaultTextDoubleClickStrategy.findExtendedDoubleClickSelection
(IDocument document, int offset) Tries to find a suitable double click selection for the given offset.protected IRegion
Tries to find the word at the given offset.protected void
TextViewer.fireInputDocumentAboutToBeChanged
(IDocument oldInput, IDocument newInput) Informs all registered text input listeners about the forthcoming input change, This method does not use a robust iterator.protected void
TextViewer.fireInputDocumentChanged
(IDocument oldInput, IDocument newInput) Informs all registered text input listeners about the successful input change, This method does not use a robust iterator.void
ISlaveDocumentManager.freeSlaveDocument
(IDocument slave) Frees the given slave document.protected void
TextViewer.freeSlaveDocument
(IDocument slave) Frees the given document if it is a slave 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.static String
TextUtilities.getDefaultLineDelimiter
(IDocument document) Returns the default line delimiter for the given document.ISlaveDocumentManager.getMasterDocument
(IDocument slave) Returns the master document of the given slave document ornull
if the given document is unknown to this slave document manager.static ITypedRegion
TextUtilities.getPartition
(IDocument document, String partitioning, int offset, boolean preferOpenPartitions) Returns the partition of the given offset of the given document.ISlaveDocumentManagerExtension.getSlaveDocuments
(IDocument master) Returns the list of slave documents for the given master document ornull
if there are no such slave document.protected void
TextViewer.initializeDocumentInformationMapping
(IDocument visibleDocument) Initializes the document information mapping between the given slave document and its master document.void
ITextInputListener.inputDocumentAboutToBeChanged
(IDocument oldInput, IDocument newInput) Called before the input document is replaced.void
PaintManager.inputDocumentAboutToBeChanged
(IDocument oldInput, IDocument newInput) void
ITextInputListener.inputDocumentChanged
(IDocument oldInput, IDocument newInput) Called after the input document has been replaced.void
PaintManager.inputDocumentChanged
(IDocument oldInput, IDocument newInput) boolean
ISlaveDocumentManager.isSlaveDocument
(IDocument document) Returns whether the given document is a slave document known to this slave document manager.static DocumentEvent
TextUtilities.mergeUnprocessedDocumentEvents
(IDocument unprocessedDocument, List<? extends DocumentEvent> documentEvents) Returns a document event which is an accumulation of a list of document events,null
if the list of documentEvents is empty.void
IDocumentExtension.IReplace.perform
(IDocument document, IDocumentListener owner) Executes the replace operation on the given document.static Map<String,
IDocumentPartitioner> TextUtilities.removeDocumentPartitioners
(IDocument document) Removes all connected document partitioners from the given document and stores them under their partitioning name in a map.void
ISlaveDocumentManager.setAutoExpandMode
(IDocument slave, boolean autoExpand) Sets the given slave document's auto expand mode.void
IDocumentAdapter.setDocument
(IDocument document) Sets the adapters document.void
ITextViewer.setDocument
(IDocument document) Sets the given document as the text viewer's model and updates the presentation accordingly.void
ITextViewer.setDocument
(IDocument document, int modelRangeOffset, int modelRangeLength) Sets the given document as this viewer's model and exposes the specified region.void
TextViewer.setDocument
(IDocument document) void
TextViewer.setDocument
(IDocument document, int modelRangeOffset, int modelRangeLength) protected void
TextViewer.setVisibleDocument
(IDocument document) Sets this viewer's visible document.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.useupdateSlaveDocument
insteadModifierConstructorDescriptionBlockTextSelection
(IDocument document, int startLine, int startColumn, int endLine, int endColumn, int tabWidth) Creates a column selection for the given lines and columns.DocumentEvent
(IDocument doc, int offset, int length, String text) Creates a new document event.DocumentPartitioningChangedEvent
(IDocument document) Creates a new document partitioning changed event for the given document.DocumentRewriteSessionEvent
(IDocument doc, DocumentRewriteSession session, Object changeType) Creates a new document event.FindReplaceDocumentAdapter
(IDocument document) Constructs a new find replace document adapter.MarkSelection
(IDocument document, int offset, int length) Creates a MarkSelection.MultiTextSelection
(IDocument document, IRegion[] regions) RewriteSessionEditProcessor
(IDocument document, TextEdit root, int style) Constructs a new edit processor for the given document.SlaveDocumentEvent
(IDocument doc, int offset, int length, String text, DocumentEvent masterEvent) Creates a new slave document event.TextSelection
(IDocument document, int offset, int length) Creates a text selection for the given range of the given document. -
Uses of IDocument in org.eclipse.jface.text.codemining
ModifierConstructorDescriptionprotected
LineEndCodeMining
(IDocument document, int line, ICodeMiningProvider provider) LineHeaderCodeMining
(int beforeLineNumber, IDocument document, ICodeMiningProvider provider) CodeMining constructor to locate the code mining before the given line number.LineHeaderCodeMining
(int beforeLineNumber, IDocument document, ICodeMiningProvider provider, Consumer<MouseEvent> action) CodeMining constructor to locate the code mining before the given line number. -
Uses of IDocument in org.eclipse.jface.text.contentassist
Modifier and TypeMethodDescriptionvoid
void
Inserts the proposed completion into the given document.void
Applies the proposed completion to the given document.int
ICompletionProposalExtension3.getPrefixCompletionStart
(IDocument document, int completionOffset) Returns the document offset at which the receiver would insert its proposal.ICompletionProposalExtension3.getPrefixCompletionText
(IDocument document, int completionOffset) Returns the string that would be inserted at the position returned fromICompletionProposalExtension3.getPrefixCompletionStart(IDocument, int)
if this proposal was applied.CompletionProposal.getSelection
(IDocument document) ICompletionProposal.getSelection
(IDocument document) Returns the new selection after the proposal has been applied to the given document in absolute document coordinates.ICompletionProposalExtension7.getStyledDisplayString
(IDocument document, int offset, BoldStylerProvider boldStylerProvider) Returns the styled display string for this proposal with emphasized ranges that match the token at the current caret offset.boolean
ICompletionProposalExtension.isValidFor
(IDocument document, int offset) Returns whether this completion proposal is valid for the given position in the given document.boolean
ICompletionProposalExtension2.validate
(IDocument document, int offset, DocumentEvent event) Requests the proposal to be validated with respect to the document event. -
Uses of IDocument in org.eclipse.jface.text.formatter
Modifier and TypeMethodDescriptionvoid
void
Formats the given region of the specified document.The formatter may safely assume that it is the only subject that modifies the document at this point in time.void
IContentFormatterExtension.format
(IDocument document, IFormattingContext context) Formats the given region of the specified document.final void
MultiPassContentFormatter.format
(IDocument medium, IFormattingContext context) final void
protected void
MultiPassContentFormatter.formatMaster
(IFormattingContext context, IDocument document, int offset, int length) Formats the document specified in the formatting context with the master formatting strategy.protected void
MultiPassContentFormatter.formatSlave
(IFormattingContext context, IDocument document, int offset, int length, String type) Formats the document specified in the formatting context with the formatting strategy registered for the content type.protected void
MultiPassContentFormatter.formatSlaves
(IFormattingContext context, IDocument document, int offset, int length) Formats the document specified in the formatting context with the slave formatting strategies.protected boolean
ContentFormatter.positionAboutToBeAdded
(IDocument document, String category, Position position) The given position is about to be added to the given position category of the given document.protected void
ContentFormatter.updateAffectedPositions
(IDocument document, int[] positions, int offset) Updates all the overlapping positions. -
Uses of IDocument in org.eclipse.jface.text.hyperlink
Modifier and TypeMethodDescriptionvoid
DefaultHyperlinkPresenter.inputDocumentAboutToBeChanged
(IDocument oldInput, IDocument newInput) void
DefaultHyperlinkPresenter.inputDocumentChanged
(IDocument oldInput, IDocument newInput) -
Uses of IDocument in org.eclipse.jface.text.link
Modifier and TypeMethodDescriptionstatic void
LinkedModeModel.closeAllModels
(IDocument document) Cancels any linked mode model on the specified document.static LinkedModeModel
Returns the model currently active ondocument
atoffset
, ornull
if there is none.static boolean
LinkedModeModel.hasInstalledModel
(IDocument document) Checks whether there is already a model installed ondocument
.static boolean
LinkedModeModel.hasInstalledModel
(IDocument[] documents) Checks whether there is already a linked mode model installed on any of thedocuments
.protected boolean
Returns whether this position includes the range given byoffset
andlength
.ModifierConstructorDescriptionLinkedPosition
(IDocument document, int offset, int length) Creates a new instance.LinkedPosition
(IDocument document, int offset, int length, int sequence) Creates a new instance.ProposalPosition
(IDocument document, int offset, int length, int sequence, ICompletionProposal[] proposals) Creates a new instance.ProposalPosition
(IDocument document, int offset, int length, ICompletionProposal[] proposals) Creates a new instance, with no sequence number. -
Uses of IDocument in org.eclipse.jface.text.presentation
Modifier and TypeMethodDescriptionprotected TextPresentation
PresentationReconciler.createPresentation
(IRegion damage, IDocument document) Constructs a "repair description" for the given damage and returns this description as a text presentation.void
IPresentationDamager.setDocument
(IDocument document) Tells the presentation damager on which document it will work.void
IPresentationRepairer.setDocument
(IDocument document) Tells the presentation repairer on which document it will work.protected void
PresentationReconciler.setDocumentToDamagers
(IDocument document) Informs all registered damagers about the document on which they will work.protected void
PresentationReconciler.setDocumentToRepairers
(IDocument document) Informs all registered repairers about the document on which they will work. -
Uses of IDocument in org.eclipse.jface.text.projection
Modifier and TypeClassDescriptionclass
Implementation of a child document based onProjectionDocument
.class
AProjectionDocument
represents a projection of its master document.Modifier and TypeMethodDescriptionProjectionDocumentManager.createSlaveDocument
(IDocument master) ProjectionDocument.getMasterDocument()
Returns the master document of this projection document.ProjectionDocumentManager.getMasterDocument
(IDocument slave) ChildDocument.getParentDocument()
Returns the parent document of this child document.ProjectionDocumentManager.getSlaveDocuments
(IDocument master) Modifier and TypeMethodDescriptionProjectionDocumentManager.createMasterSlaveMapping
(IDocument slave) protected ProjectionDocument
ChildDocumentManager.createProjectionDocument
(IDocument master) protected ProjectionDocument
ProjectionDocumentManager.createProjectionDocument
(IDocument master) Factory method for projection documents.ProjectionDocumentManager.createSlaveDocument
(IDocument master) void
ProjectionDocumentManager.freeSlaveDocument
(IDocument slave) ProjectionDocumentManager.getMasterDocument
(IDocument slave) ProjectionDocumentManager.getSlaveDocuments
(IDocument master) boolean
ProjectionDocumentManager.isSlaveDocument
(IDocument document) void
ProjectionDocumentManager.setAutoExpandMode
(IDocument slave, boolean autoExpanding) ModifierConstructorDescriptionChildDocument
(IDocument masterDocument) Creates a new child document.ProjectionDocument
(IDocument masterDocument) Creates a projection document for the given master document.ProjectionDocumentEvent
(IDocument doc, int offset, int length, String text, int masterOffset, int masterLength) Creates a new projection change event for the given properties.ProjectionDocumentEvent
(IDocument doc, int offset, int length, String text, int masterOffset, int masterLength, DocumentEvent masterEvent) Creates a new projection document event for the given properties.ProjectionDocumentEvent
(IDocument doc, int offset, int length, String text, DocumentEvent masterEvent) Creates a new content change event caused by the given master document change.ProjectionMapping
(IDocument masterDocument, String fragmentsCategory, IDocument slaveDocument, String segmentsCategory) Creates a new mapping between the given parent document and the given projection document. -
Uses of IDocument in org.eclipse.jface.text.reconciler
Modifier and TypeMethodDescriptionprotected IDocument
AbstractReconciler.getDocument()
Returns the input document of the text viewer this reconciler is installed on.Modifier and TypeMethodDescriptionprotected abstract void
AbstractReconciler.reconcilerDocumentChanged
(IDocument newDocument) Hook called when the document whose contents should be reconciled has been changed, i.e., the input document of the text viewer this reconciler is installed on.protected void
MonoReconciler.reconcilerDocumentChanged
(IDocument document) protected void
Reconciler.reconcilerDocumentChanged
(IDocument document) void
IReconcilingStrategy.setDocument
(IDocument document) Tells this reconciling strategy on which document it will work. -
Uses of IDocument in org.eclipse.jface.text.rules
Modifier and TypeFieldDescriptionprotected IDocument
DefaultDamagerRepairer.fDocument
The document this object works onprotected IDocument
DefaultPartitioner.fDocument
Deprecated.The partitioner's documentprotected IDocument
FastPartitioner.fDocument
The partitioner's documentprotected IDocument
RuleBasedPartitioner.fDocument
Deprecated.The partitioner's documentprotected IDocument
RuleBasedScanner.fDocument
The document to be scannedModifier and TypeMethodDescriptionvoid
Deprecated.void
Deprecated.final void
void
Connects this partitioner to a document.void
Deprecated.void
DefaultDamagerRepairer.setDocument
(IDocument document) void
IPartitionTokenScanner.setPartialRange
(IDocument document, int offset, int length, String contentType, int partitionOffset) Configures the scanner by providing access to the document range that should be scanned.void
RuleBasedPartitionScanner.setPartialRange
(IDocument document, int offset, int length, String contentType, int partitionOffset) Configures the scanner by providing access to the document range that should be scanned.void
void
Configures the scanner by providing access to the document range that should be scanned.void
void
-
Uses of IDocument in org.eclipse.jface.text.source
Modifier and TypeFieldDescriptionprotected IDocument
AnnotationModel.fDocument
The document connected with this modelModifier and TypeMethodDescriptionprotected void
AnnotationModel.addPosition
(IDocument document, Position position) Adds the given position to the default position category of the given document.void
void
Connects the annotation model to a document.void
AnnotationModel.disconnect
(IDocument document) void
IAnnotationModel.disconnect
(IDocument document) Disconnects this model from a document.DefaultCharacterPairMatcher.findEnclosingPeerCharacters
(IDocument document, int offset, int length) ICharacterPairMatcherExtension.findEnclosingPeerCharacters
(IDocument document, int offset, int length) Starting at the given selection, the matcher searches for a pair of enclosing peer characters and if it finds one, returns the minimal region of the document that contains the pair.boolean
DefaultCharacterPairMatcher.isMatchedChar
(char ch, IDocument document, int offset) boolean
ICharacterPairMatcherExtension.isMatchedChar
(char ch, IDocument document, int offset) Checks whether the character is one of the characters matched by the pair matcher.boolean
DefaultCharacterPairMatcher.isRecomputationOfEnclosingPairRequired
(IDocument document, IRegion currentSelection, IRegion previousSelection) boolean
ICharacterPairMatcherExtension.isRecomputationOfEnclosingPairRequired
(IDocument document, IRegion currentSelection, IRegion previousSelection) Computes whether a client needs to recompute the enclosing pair after a selection change in the document.Starting at the given offset, the matcher chooses a character close to this offset.Starting at the given offset (i.e. length 0) or the selected character, the matcher searches for the matching peer character and if it finds one, returns the minimal region of the document that contains both characters.protected void
AnnotationModel.removePosition
(IDocument document, Position position) Removes the given position from the default position category of the given document.void
ISourceViewer.setDocument
(IDocument document, IAnnotationModel annotationModel) Sets the given document as this viewer's text model and the given annotation model as the model for this viewer's visual annotations.void
ISourceViewer.setDocument
(IDocument document, IAnnotationModel annotationModel, int modelRangeOffset, int modelRangeLength) Sets the given document as this viewer's text model and the given annotation model as the model for this viewer's visual annotations.void
SourceViewer.setDocument
(IDocument document) void
SourceViewer.setDocument
(IDocument document, int visibleRegionOffset, int visibleRegionLength) void
SourceViewer.setDocument
(IDocument document, IAnnotationModel annotationModel) void
SourceViewer.setDocument
(IDocument document, IAnnotationModel annotationModel, int modelRangeOffset, int modelRangeLength) protected void
SourceViewer.updateSlaveDocuments
(IDocument masterDocument) Updates all slave documents of the given document. -
Uses of IDocument in org.eclipse.jface.text.source.inlined
-
Uses of IDocument in org.eclipse.jface.text.source.projection
Modifier and TypeMethodDescriptionint
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.setDocument
(IDocument document, IAnnotationModel annotationModel, int modelRangeOffset, int modelRangeLength) protected void
ProjectionViewer.setVisibleDocument
(IDocument document) protected boolean
ProjectionViewer.updateSlaveDocument
(IDocument slaveDocument, int modelRangeOffset, int modelRangeLength) -
Uses of IDocument in org.eclipse.jface.text.templates
Modifier and TypeMethodDescriptionfinal void
Deprecated.This method is no longer called by the framework and clients should overwriteTemplateProposal.apply(ITextViewer, char, int, int)
insteadvoid
Deprecated.This method is no longer called by the framework and clients should overwriteTemplateProposal.apply(ITextViewer, char, int, int)
insteadint
TemplateProposal.getPrefixCompletionStart
(IDocument document, int completionOffset) TemplateProposal.getPrefixCompletionText
(IDocument document, int completionOffset) TemplateProposal.getSelection
(IDocument document) boolean
TemplateProposal.isValidFor
(IDocument document, int offset) boolean
TemplateProposal.validate
(IDocument document, int offset, DocumentEvent event) ModifierConstructorDescriptionDocumentTemplateContext
(TemplateContextType type, IDocument document, int offset, int length) Creates a document template context.DocumentTemplateContext
(TemplateContextType type, IDocument document, Position position) Creates a document template context. -
Uses of IDocument in org.eclipse.ltk.core.refactoring
Modifier and TypeMethodDescriptionprotected IDocument
DocumentChange.acquireDocument
(IProgressMonitor pm) protected abstract IDocument
TextChange.acquireDocument
(IProgressMonitor pm) Acquires a reference to the document to be changed by this text change.protected IDocument
TextFileChange.acquireDocument
(IProgressMonitor pm) final IDocument
MultiStateTextFileChange.getCurrentDocument
(IProgressMonitor monitor) Returns a document representing the current state of the buffer, prior to the application of the change.TextChange.getCurrentDocument
(IProgressMonitor pm) Returns the document this text change is associated to.final IDocument
MultiStateTextFileChange.getPreviewDocument
(IProgressMonitor monitor) Returns a document representing the preview of the refactored buffer, after the application of the change object.TextChange.getPreviewDocument
(IProgressMonitor pm) Returns a document containing a preview of the text change.Modifier and TypeMethodDescriptionprotected void
DocumentChange.commit
(IDocument document, IProgressMonitor pm) protected abstract void
TextChange.commit
(IDocument document, IProgressMonitor pm) Commits the document acquired via a call toaquireDocument
.protected void
TextFileChange.commit
(IDocument document, IProgressMonitor pm) Commits the document acquired via a call toaquireDocument
.protected UndoEdit
DocumentChange.performEdits
(IDocument document) protected UndoEdit
TextChange.performEdits
(IDocument document) Executes the text edits on the given document.protected UndoEdit
TextFileChange.performEdits
(IDocument document) protected void
DocumentChange.releaseDocument
(IDocument document, IProgressMonitor pm) protected abstract void
TextChange.releaseDocument
(IDocument document, IProgressMonitor pm) Releases the document acquired via a call toaquireDocument
.protected void
TextFileChange.releaseDocument
(IDocument document, IProgressMonitor pm) ModifierConstructorDescriptionDocumentChange
(String name, IDocument document) Creates a newDocumentChange
for the givenIDocument
. -
Uses of IDocument in org.eclipse.ltk.ui.refactoring
-
Uses of IDocument in org.eclipse.search.ui.text
Modifier and TypeMethodDescriptionISearchEditorAccess.getDocument
(Match match) Finds the document displaying the match. -
Uses of IDocument in org.eclipse.text.edits
Modifier and TypeMethodDescriptionTextEditProcessor.getDocument()
Returns the document to be manipulated.Modifier and TypeMethodDescriptionfinal UndoEdit
Applies the edit tree rooted by this edit to the given document.final UndoEdit
Applies the edit tree rooted by this edit to the given document.ModifierConstructorDescriptionTextEditProcessor
(IDocument document, TextEdit root, int style) Constructs a new edit processor for the given document. -
Uses of IDocument in org.eclipse.text.undo
Modifier and TypeMethodDescriptionstatic void
Connects the file at the given location to this manager.static void
DocumentUndoManagerRegistry.disconnect
(IDocument document) Disconnects the given document from this registry.static IDocumentUndoManager
DocumentUndoManagerRegistry.getDocumentUndoManager
(IDocument document) Returns the file buffer managed for the given location ornull
if there is no such file buffer.ModifierConstructorDescriptionDocumentUndoManager
(IDocument document) Create a DocumentUndoManager for the given document. -
Uses of IDocument in org.eclipse.ui.console
-
Uses of IDocument in org.eclipse.ui.editors.text
Modifier and TypeMethodDescriptionprotected IDocument
StorageDocumentProvider.createDocument
(Object element) protected IDocument
StorageDocumentProvider.createEmptyDocument()
Factory method for creating empty documents.ForwardingDocumentProvider.getDocument
(Object element) TextFileDocumentProvider.getDocument
(Object element) TextFileDocumentProvider.NullProvider.getDocument
(Object element) Deprecated.Modifier and TypeMethodDescriptionprotected void
TextFileDocumentProvider.createFileFromDocument
(IProgressMonitor monitor, IFile file, IDocument document) Creates the given file with the given document content.TextFileDocumentProvider.createSaveOperation
(Object element, IDocument document, boolean overwrite) protected void
FileDocumentProvider.doSaveDocument
(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite) protected void
StorageDocumentProvider.doSaveDocument
(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite) void
ForwardingDocumentProvider.saveDocument
(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite) void
TextFileDocumentProvider.NullProvider.saveDocument
(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite) Deprecated.final void
TextFileDocumentProvider.saveDocument
(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite) protected boolean
FileDocumentProvider.setDocumentContent
(IDocument document, IEditorInput editorInput) Deprecated.use file encoding based versionprotected boolean
FileDocumentProvider.setDocumentContent
(IDocument document, IEditorInput editorInput, String encoding) protected void
StorageDocumentProvider.setDocumentContent
(IDocument document, InputStream contentStream) Deprecated.use encoding based version insteadprotected void
StorageDocumentProvider.setDocumentContent
(IDocument document, InputStream contentStream, String encoding) Initializes the given document with the given stream using the given encoding.protected boolean
StorageDocumentProvider.setDocumentContent
(IDocument document, IEditorInput editorInput) Deprecated.use the encoding based version insteadprotected boolean
StorageDocumentProvider.setDocumentContent
(IDocument document, IEditorInput editorInput, String encoding) Initializes the given document from the given editor input using the given character encoding.protected void
StorageDocumentProvider.setupDocument
(Object element, IDocument document) Sets up the given document as it would be provided for the given element.ModifierConstructorDescriptionFileInfo
(IDocument document, IAnnotationModel model, FileDocumentProvider.FileSynchronizer fileSynchronizer) Creates and returns a new file info.StorageInfo
(IDocument document, IAnnotationModel model) Creates a new storage info. -
Uses of IDocument in org.eclipse.ui.texteditor
Modifier and TypeFieldDescriptionAbstractDocumentProvider.ElementInfo.fDocument
The element's documentModifier and TypeMethodDescriptionprotected abstract IDocument
AbstractDocumentProvider.createDocument
(Object element) Creates the document for the given element.AbstractDocumentProvider.getDocument
(Object element) IDocumentProvider.getDocument
(Object element) Returns the document for the given element.protected IDocument
MarkerRulerAction.getDocument()
Returns theIDocument
of the editor's input.protected final IDocument
SelectMarkerRulerAction.getDocument()
Returns theIDocument
of the editor's input.Modifier and TypeMethodDescriptionvoid
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 givenselection
.protected abstract void
AbstractDocumentProvider.doSaveDocument
(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite) Performs the actual work of saving the given document provided for the given element.protected String
AddMarkerAction.getLabelProposal
(IDocument document, int offset, int length) Returns the initial label for the marker.protected String
MarkerRulerAction.getLabelProposal
(IDocument document, int offset, int length) Returns the initial label for the marker.protected int
AbstractTextEditor.LineEndAction.getLineEndPosition
(IDocument document, String line, int length, int offset) Computes the offset of the line end position.protected int
AbstractTextEditor.LineStartAction.getLineStartPosition
(IDocument document, String line, int length, int offset) Computes the offset of the line start position.protected boolean
MarkerRulerAction.includesRulerLine
(Position position, IDocument document) Checks whether a position includes the ruler's line of activity.protected final boolean
SelectMarkerRulerAction.includesRulerLine
(Position position, IDocument document) Checks whether a position includes the ruler's line of activity.void
AbstractMarkerAnnotationModel.reinitialize
(IDocument document) void
final void
AbstractDocumentProvider.saveDocument
(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite) void
IDocumentProvider.saveDocument
(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite) Saves the given document provided for the given element.boolean
AbstractMarkerAnnotationModel.updateMarker
(IMarker marker, IDocument document, Position position) Deprecated.useupdateMarker(IDocument, IMarker, Position)
instead.boolean
AbstractMarkerAnnotationModel.updateMarker
(IDocument document, IMarker marker, Position position) Updates the given marker according to the given position in the given document.boolean
BasicMarkerUpdater.updateMarker
(IMarker marker, IDocument document, Position position) boolean
IMarkerUpdater.updateMarker
(IMarker marker, IDocument document, Position position) Updates the given marker according to the position of the given document.void
AbstractMarkerAnnotationModel.updateMarkers
(IDocument document) Updates the markers managed by this annotation model by calling all registered marker updaters (IMarkerUpdater
).ModifierConstructorDescriptionElementInfo
(IDocument document, IAnnotationModel model) Creates a new element info, initialized with the given document and annotation model. -
Uses of IDocument in org.eclipse.ui.texteditor.quickdiff
Modifier and TypeMethodDescriptionIQuickDiffReferenceProvider.getReference
(IProgressMonitor monitor) Returns the reference document for the quick diff display. -
Uses of IDocument in org.eclipse.ui.texteditor.spelling
Modifier and TypeMethodDescriptionprotected final IDocument
SpellingReconcileStrategy.getDocument()
Returns the document which is spell checked.Modifier and TypeMethodDescriptionvoid
ISpellingEngine.check
(IDocument document, IRegion[] regions, SpellingContext context, ISpellingProblemCollector collector, IProgressMonitor monitor) Checks the given regions in the given document.void
SpellingService.check
(IDocument document, IRegion[] regions, SpellingContext context, ISpellingProblemCollector collector, IProgressMonitor monitor) Checks the given regions in the given document.void
SpellingService.check
(IDocument document, SpellingContext context, ISpellingProblemCollector collector, IProgressMonitor monitor) Checks the given document.void
SpellingReconcileStrategy.setDocument
(IDocument document) -
Uses of IDocument in org.eclipse.ui.texteditor.templates
Modifier and TypeMethodDescriptionprotected abstract String[]
AbstractTemplatesPage.getContextTypeIds
(IDocument document, int offset) Returns the context type ids supported at the given document offset.protected abstract void
AbstractTemplatesPage.insertTemplate
(Template template, IDocument document) Inserts the given template into the editor.protected abstract boolean
AbstractTemplatesPage.isValidTemplate
(IDocument document, Template template, int offset, int length) Checks whether the given template is valid for the document at the given offset and length.
ITextFileBufferManager.createEmptyDocument(IPath, LocationKind)