Eclipse Platform
Release 3.1

Uses of Interface
org.eclipse.jface.text.IDocument

Packages that use IDocument
org.eclipse.compare Provides support for performing structural and textual compare operations on arbitrary data and displaying the results.  
org.eclipse.compare.contentmergeviewer Support for compare and merge viewers which show the content side-by-side.  
org.eclipse.compare.structuremergeviewer Provides support for finding and displaying the differences between hierarchically structured data.  
org.eclipse.core.filebuffers Provides the API for accessing file buffers. 
org.eclipse.core.filebuffers.manipulation Provides the API for manipulating file buffers. 
org.eclipse.debug.ui.actions

Provides a set of actions related to running and debugging applications. 

org.eclipse.debug.ui.console

Provides a set of interfaces and classes for rendering and annotating text in the debug console. 

org.eclipse.jface.contentassist Provides a content assist add-on for implementors of IContentAssistSubjectControl.  
org.eclipse.jface.text Provides a framework for creating and manipulating text documents. 
org.eclipse.jface.text.contentassist Provides a content assist add-on for an ITextViewer.  
org.eclipse.jface.text.formatter Provides a content formatter add-on for an ITextViewer.  
org.eclipse.jface.text.hyperlink   
org.eclipse.jface.text.link Application programming interfaces for interaction with the Eclipse Java User Interface text support.  
org.eclipse.jface.text.presentation Provides a presentation reconciler add-on for an ITextViewer.  
org.eclipse.jface.text.projection This package provides an implementation of projection documents.  
org.eclipse.jface.text.reconciler Provides a reconciler add-on for an ITextViewer.  
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 support for managing annotations attached to a document. 
org.eclipse.jface.text.source.projection   
org.eclipse.jface.text.templates Application programming interfaces for interaction with the Eclipse Java User Interface text support.  
org.eclipse.ltk.core.refactoring Application programmer interface to implement semantic preserving workspace transformations. 
org.eclipse.ltk.ui.refactoring Application programmer interface to implement a wizard based user interface for refactorings. 
org.eclipse.search.ui.text Provides the base classes to implement a search result view part for searches with textual matches.  
org.eclipse.text.edits   
org.eclipse.ui.console Application programming interfaces for interaction with the Eclipse console. 
org.eclipse.ui.editors.text Provides a standard text editor and concrete document providers based IFileBuffer and others directly handling IFile and IStorage as editor input. 
org.eclipse.ui.texteditor Provides a framework for text editors obeying to the desktop rules.  
org.eclipse.ui.texteditor.quickdiff Provides interfaces to for the org.eclipse.ui.editors.quickDiffReferenceProvider extension point and adds an action to enable quick diff display for an editor. 
org.eclipse.ui.texteditor.spelling   
 

Uses of IDocument in org.eclipse.compare
 

Methods in org.eclipse.compare that return IDocument
static IDocument CompareUI.getDocument(Object input)
          Retrieve a document for the given input or return null if no document has been registered for the input.
 

Methods in org.eclipse.compare with parameters of type IDocument
static void CompareUI.registerDocument(Object input, IDocument document)
          Register a document for the given input.
static void CompareUI.unregisterDocument(IDocument document)
          Unregister the given document.
 

Uses of IDocument in org.eclipse.compare.contentmergeviewer
 

Methods in org.eclipse.compare.contentmergeviewer that return IDocument
 IDocument IDocumentRange.getDocument()
          Returns the underlying document.
 

Uses of IDocument in org.eclipse.compare.structuremergeviewer
 

Methods in org.eclipse.compare.structuremergeviewer that return IDocument
 IDocument DocumentRangeNode.getDocument()
           
 

Constructors in org.eclipse.compare.structuremergeviewer with parameters of type IDocument
DocumentRangeNode(int typeCode, String id, IDocument document, int start, int length)
          Creates a new DocumentRangeNode for the given range within the specified document.
 

Uses of IDocument in org.eclipse.core.filebuffers
 

Methods in org.eclipse.core.filebuffers that return IDocument
 IDocument ITextFileBufferManager.createEmptyDocument(IPath location)
          Creates a new empty document.
 IDocument ITextFileBuffer.getDocument()
          Returns the document of this text file buffer.
 IDocument IDocumentFactory.createDocument()
          Creates and returns a new, empty document.
 

Methods in org.eclipse.core.filebuffers with parameters of type IDocument
 void IPersistableAnnotationModel.commit(IDocument document)
          Transforms the current transient state of the annotation model into a persistent state.
 void IPersistableAnnotationModel.revert(IDocument document)
          Changes the current transient state of the annotation model to match the last persisted state.
 void IPersistableAnnotationModel.reinitialize(IDocument document)
          Forces this annotation model to re-initialize from the persistent state.
 void IDocumentSetupParticipant.setup(IDocument document)
          Sets up the document to be ready for use by a text file buffer.
 

Uses of IDocument in org.eclipse.core.filebuffers.manipulation
 

Methods in org.eclipse.core.filebuffers.manipulation with parameters of type IDocument
 UndoEdit MultiTextEditWithProgress.apply(IDocument document, IProgressMonitor progressMonitor)
           
 UndoEdit MultiTextEditWithProgress.apply(IDocument document, int style, IProgressMonitor progressMonitor)
           
 

Uses of IDocument in org.eclipse.debug.ui.actions
 

Constructors in org.eclipse.debug.ui.actions with parameters of type IDocument
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
 

Methods in org.eclipse.debug.ui.console that return IDocument
 IDocument IConsole.getDocument()
          Returns the document associated with this console.
 

Uses of IDocument in org.eclipse.jface.contentassist
 

Methods in org.eclipse.jface.contentassist that return IDocument
 IDocument TextContentAssistSubjectAdapter.getDocument()
           
 IDocument IContentAssistSubjectControl.getDocument()
          Returns this content assist subject control's document.
 IDocument ComboContentAssistSubjectAdapter.getDocument()
           
 

Uses of IDocument in org.eclipse.jface.text
 

Classes in org.eclipse.jface.text that implement IDocument
 class AbstractDocument
          Abstract default implementation of IDocument and its extension interfaces IDocumentExtension, IDocumentExtension2, IDocumentExtension3, IDocumentExtension4, as well as IRepairableDocument.
 class Document
          Default document implementation.
 

Fields in org.eclipse.jface.text declared as IDocument
 IDocument DocumentRewriteSessionEvent.fDocument
          The changed document
 IDocument DocumentEvent.fDocument
          The changed document
protected  IDocument DefaultPositionUpdater.fDocument
          Catches the document
 

Methods in org.eclipse.jface.text that return IDocument
 IDocument[] ISlaveDocumentManagerExtension.getSlaveDocuments(IDocument master)
          Returns the list of slave documents for the given master document or null if there are no such slave document.
 IDocument ISlaveDocumentManager.createSlaveDocument(IDocument master)
          Creates a new slave document for the given master document.
 IDocument ISlaveDocumentManager.getMasterDocument(IDocument slave)
          Returns the master document of the given slave document or null if the given document is unknown to this slave document manager.
 IDocument DocumentRewriteSessionEvent.getDocument()
          Returns the changed document.
 IDocument DocumentPartitioningChangedEvent.getDocument()
          Returns the changed document.
 IDocument DocumentEvent.getDocument()
          Returns the changed document.
 IDocument TextViewer.getDocument()
           
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.
protected  IDocument TextViewer.getVisibleDocument()
          Returns the viewer's visible document.
 IDocument MarkSelection.getDocument()
           
 IDocument ITextViewer.getDocument()
          Returns the text viewer's input document.
 IDocument IRewriteTarget.getDocument()
          Returns the document of this target.
 IDocument IMarkSelection.getDocument()
          Returns the marked document.
 

Methods in org.eclipse.jface.text with parameters of type IDocument
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.
static Map TextUtilities.removeDocumentPartitioners(IDocument document)
          Removes all connected document partitioners from the given document and stores them under their partitioning name in a map.
static void TextUtilities.addDocumentPartitioners(IDocument document, Map partitioners)
          Connects the given document with all document partitioners stored in the given map under their partitioning name.
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 ITypedRegion TextUtilities.getPartition(IDocument document, String partitioning, int offset, boolean preferOpenPartitions)
          Returns the partition of the given offset of the given document.
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 or null if this was impossible.
static String TextUtilities.getDefaultLineDelimiter(IDocument document)
          Returns the default line delimiter for the given document.
 IDocument[] ISlaveDocumentManagerExtension.getSlaveDocuments(IDocument master)
          Returns the list of slave documents for the given master document or null if there are no such slave document.
 IDocument ISlaveDocumentManager.createSlaveDocument(IDocument master)
          Creates a new slave document for the given master document.
 void ISlaveDocumentManager.freeSlaveDocument(IDocument slave)
          Frees the given slave document.
 IDocumentInformationMapping ISlaveDocumentManager.createMasterSlaveMapping(IDocument slave)
          Creates a new document information mapping between the given slave document and its master document.
 IDocument ISlaveDocumentManager.getMasterDocument(IDocument slave)
          Returns the master document of the given slave document or null if the given document is unknown to this slave document manager.
 boolean ISlaveDocumentManager.isSlaveDocument(IDocument document)
          Returns whether the given document is a slave document known to this slave document manager.
 void ISlaveDocumentManager.setAutoExpandMode(IDocument slave, boolean autoExpand)
          Sets the given slave document's auto expand mode.
 void IDocumentPartitioningListenerExtension.documentPartitioningChanged(IDocument document, IRegion region)
          The partitioning of the given document changed in the given region.
 void IDocumentPartitioningListener.documentPartitioningChanged(IDocument document)
          The partitioning of the given document changed.
 void IDocumentPartitionerExtension3.connect(IDocument document, boolean delayInitialization)
          Connects this partitioner to a document.
 void IDocumentPartitioner.connect(IDocument document)
          Connects the partitioner to a document.
 void IDocumentExtension.IReplace.perform(IDocument document, IDocumentListener owner)
          Executes the replace operation on the given document.
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 TextViewer.setDocument(IDocument document)
           
 void TextViewer.setDocument(IDocument document, int modelRangeOffset, int modelRangeLength)
           
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.
protected  boolean TextViewer.updateVisibleDocument(IDocument visibleDocument, int visibleRegionOffset, int visibleRegionLength)
          Deprecated. use updateSlaveDocument instead
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  void TextViewer.freeSlaveDocument(IDocument slave)
          Frees the given document if it is a slave document.
protected  void TextViewer.setVisibleDocument(IDocument document)
          Sets this viewer's visible document.
protected  void TextViewer.initializeDocumentInformationMapping(IDocument visibleDocument)
          Initializes the document information mapping between the given slave document and its master document.
 void PaintManager.inputDocumentAboutToBeChanged(IDocument oldInput, IDocument newInput)
           
 void PaintManager.inputDocumentChanged(IDocument oldInput, IDocument newInput)
           
 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 ITextInputListener.inputDocumentAboutToBeChanged(IDocument oldInput, IDocument newInput)
          Called before the input document is replaced.
 void ITextInputListener.inputDocumentChanged(IDocument oldInput, IDocument newInput)
          Called after the input document has been replaced.
 void IDocumentAdapter.setDocument(IDocument document)
          Sets the adapters document.
 void IAutoEditStrategy.customizeDocumentCommand(IDocument document, DocumentCommand command)
          Allows the strategy to manipulate the document command.
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.
 void DefaultIndentLineAutoEditStrategy.customizeDocumentCommand(IDocument d, DocumentCommand c)
           
 

Constructors in org.eclipse.jface.text with parameters of type IDocument
SlaveDocumentEvent(IDocument doc, int offset, int length, String text, DocumentEvent masterEvent)
          Creates a new slave document event.
FindReplaceDocumentAdapter(IDocument document)
          Constructs a new find replace document adapter.
DocumentRewriteSessionEvent(IDocument doc, DocumentRewriteSession session, Object changeType)
          Creates a new document event.
DocumentPartitioningChangedEvent(IDocument document)
          Creates a new document partitioning changed event for the given document.
DocumentEvent(IDocument doc, int offset, int length, String text)
          Creates a new document event.
TextSelection(IDocument document, int offset, int length)
          Creates a text selection for the given range of the given document.
MarkSelection(IDocument document, int offset, int length)
          Creates a MarkSelection.
 

Uses of IDocument in org.eclipse.jface.text.contentassist
 

Methods in org.eclipse.jface.text.contentassist with parameters of type IDocument
 CharSequence ICompletionProposalExtension3.getPrefixCompletionText(IDocument document, int completionOffset)
          Returns the string that would be inserted at the position returned from ICompletionProposalExtension3.getPrefixCompletionStart(IDocument, int) if this proposal was applied.
 int ICompletionProposalExtension3.getPrefixCompletionStart(IDocument document, int completionOffset)
          Returns the document offset at which the receiver would insert its proposal.
 boolean ICompletionProposalExtension2.validate(IDocument document, int offset, DocumentEvent event)
          Requests the proposal to be validated with respect to the document event.
 void ICompletionProposalExtension.apply(IDocument document, char trigger, int offset)
          Applies the proposed completion to the given document.
 boolean ICompletionProposalExtension.isValidFor(IDocument document, int offset)
          Returns whether this completion proposal is valid for the given position in the given document.
 void ICompletionProposal.apply(IDocument document)
          Inserts the proposed completion into the given document.
 Point ICompletionProposal.getSelection(IDocument document)
          Returns the new selection after the proposal has been applied to the given document in absolute document coordinates.
 void CompletionProposal.apply(IDocument document)
           
 Point CompletionProposal.getSelection(IDocument document)
           
 

Uses of IDocument in org.eclipse.jface.text.formatter
 

Methods in org.eclipse.jface.text.formatter with parameters of type IDocument
 void MultiPassContentFormatter.format(IDocument medium, IFormattingContext context)
           
 void MultiPassContentFormatter.format(IDocument medium, IRegion region)
           
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.
 void IContentFormatterExtension.format(IDocument document, IFormattingContext context)
          Formats the given region of the specified document.
 void IContentFormatter.format(IDocument document, IRegion region)
          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 ContentFormatter.format(IDocument document, IRegion region)
           
protected  void ContentFormatter.updateAffectedPositions(IDocument document, int[] positions, int offset)
          Updates all the overlapping positions.
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.
 

Uses of IDocument in org.eclipse.jface.text.hyperlink
 

Methods in org.eclipse.jface.text.hyperlink with parameters of type IDocument
 void DefaultHyperlinkPresenter.inputDocumentAboutToBeChanged(IDocument oldInput, IDocument newInput)
           
 void DefaultHyperlinkPresenter.inputDocumentChanged(IDocument oldInput, IDocument newInput)
           
 

Uses of IDocument in org.eclipse.jface.text.link
 

Methods in org.eclipse.jface.text.link that return IDocument
 IDocument LinkedPosition.getDocument()
           
 

Methods in org.eclipse.jface.text.link with parameters of type IDocument
protected  boolean LinkedPosition.includes(IDocument doc, int off, int len)
          Returns whether this position includes the range given by offset and length.
static boolean LinkedModeModel.hasInstalledModel(IDocument document)
          Checks whether there is already a model installed on document.
static boolean LinkedModeModel.hasInstalledModel(IDocument[] documents)
          Checks whether there is already a linked mode model installed on any of the documents.
static void LinkedModeModel.closeAllModels(IDocument document)
          Cancels any linked mode model on the specified document.
static LinkedModeModel LinkedModeModel.getModel(IDocument document, int offset)
          Returns the model currently active on document at offset, or null if there is none.
 

Constructors in org.eclipse.jface.text.link with parameters of type IDocument
LinkedPosition(IDocument document, int offset, int length, int sequence)
          Creates a new instance.
LinkedPosition(IDocument document, int offset, int length)
          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
 

Methods in org.eclipse.jface.text.presentation with parameters of type IDocument
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.
protected  TextPresentation PresentationReconciler.createPresentation(IRegion damage, IDocument document)
          Constructs a "repair description" for the given damage and returns this description as a text presentation.
 void IPresentationRepairer.setDocument(IDocument document)
          Tells the presentation repairer on which document it will work.
 void IPresentationDamager.setDocument(IDocument document)
          Tells the presentation damager on which document it will work.
 

Uses of IDocument in org.eclipse.jface.text.projection
 

Classes in org.eclipse.jface.text.projection that implement IDocument
 class ChildDocument
          Implementation of a child document based on ProjectionDocument.
 class ProjectionDocument
          A ProjectionDocument represents a projection of its master document.
 

Methods in org.eclipse.jface.text.projection that return IDocument
 IDocument ProjectionDocumentManager.createSlaveDocument(IDocument master)
           
 IDocument ProjectionDocumentManager.getMasterDocument(IDocument slave)
           
 IDocument[] ProjectionDocumentManager.getSlaveDocuments(IDocument master)
           
 IDocument ProjectionDocument.getMasterDocument()
          Returns the master document of this projection document.
 IDocument ChildDocument.getParentDocument()
          Returns the parent document of this child document.
 

Methods in org.eclipse.jface.text.projection with parameters of type IDocument
 IDocumentInformationMapping ProjectionDocumentManager.createMasterSlaveMapping(IDocument slave)
           
 IDocument ProjectionDocumentManager.createSlaveDocument(IDocument master)
           
protected  ProjectionDocument ProjectionDocumentManager.createProjectionDocument(IDocument master)
          Factory method for projection documents.
 void ProjectionDocumentManager.freeSlaveDocument(IDocument slave)
           
 IDocument ProjectionDocumentManager.getMasterDocument(IDocument slave)
           
 boolean ProjectionDocumentManager.isSlaveDocument(IDocument document)
           
 void ProjectionDocumentManager.setAutoExpandMode(IDocument slave, boolean autoExpanding)
           
 IDocument[] ProjectionDocumentManager.getSlaveDocuments(IDocument master)
           
protected  ProjectionDocument ChildDocumentManager.createProjectionDocument(IDocument master)
           
 

Constructors in org.eclipse.jface.text.projection with parameters of type IDocument
ProjectionMapping(IDocument masterDocument, String fragmentsCategory, IDocument slaveDocument, String segmentsCategory)
          Creates a new mapping between the given parent document and the given projection document.
ProjectionDocumentEvent(IDocument doc, int offset, int length, String text, DocumentEvent masterEvent)
          Creates a new content change event caused by the given master document change.
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.
ProjectionDocument(IDocument masterDocument)
          Creates a projection document for the given master document.
ChildDocument(IDocument masterDocument)
          Creates a new child document.
 

Uses of IDocument in org.eclipse.jface.text.reconciler
 

Methods in org.eclipse.jface.text.reconciler that return IDocument
protected  IDocument AbstractReconciler.getDocument()
          Returns the input document of the text viewer this reconciler is installed on.
 

Methods in org.eclipse.jface.text.reconciler with parameters of type IDocument
protected  void Reconciler.reconcilerDocumentChanged(IDocument document)
           
protected  void MonoReconciler.reconcilerDocumentChanged(IDocument document)
           
 void IReconcilingStrategy.setDocument(IDocument document)
          Tells this reconciling strategy on which document it will work.
protected 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.
 

Uses of IDocument in org.eclipse.jface.text.rules
 

Fields in org.eclipse.jface.text.rules declared as IDocument
protected  IDocument RuleBasedScanner.fDocument
          The document to be scanned
protected  IDocument RuleBasedPartitioner.fDocument
          Deprecated. The partitioner's document
protected  IDocument FastPartitioner.fDocument
          The partitioner's document
protected  IDocument DefaultPartitioner.fDocument
          Deprecated. The partitioner's document
protected  IDocument DefaultDamagerRepairer.fDocument
          The document this object works on
 

Methods in org.eclipse.jface.text.rules with parameters of type IDocument
 void RuleBasedScanner.setRange(IDocument document, int offset, int length)
           
 void RuleBasedPartitioner.connect(IDocument document)
          Deprecated.  
 void RuleBasedPartitionScanner.setRange(IDocument document, int offset, int length)
           
 void RuleBasedPartitionScanner.setPartialRange(IDocument document, int offset, int length, String contentType, int partitionOffset)
           
 void ITokenScanner.setRange(IDocument document, int offset, int length)
          Configures the scanner by providing access to the document range that should be scanned.
 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 FastPartitioner.connect(IDocument document)
           
 void FastPartitioner.connect(IDocument document, boolean delayInitialization)
          Connects this partitioner to a document. Connect indicates the begin of the usage of the receiver as partitioner of the given document. Thus, resources the partitioner needs to be operational for this document should be allocated.

The caller of this method must ensure that this partitioner is also set as the document's document partitioner.

delayInitialization indicates whether the partitioner is allowed to delay it initial computation of the document's partitioning until it has to answer the first query. Replaces IDocumentPartitioner.connect(IDocument). May be extended by subclasses.

 void DefaultPartitioner.connect(IDocument document)
          Deprecated.  
 void DefaultPartitioner.connect(IDocument document, boolean delayInitialization)
          Deprecated.  
 void DefaultDamagerRepairer.setDocument(IDocument document)
           
 void BufferedRuleBasedScanner.setRange(IDocument document, int offset, int length)
           
 

Uses of IDocument in org.eclipse.jface.text.source
 

Fields in org.eclipse.jface.text.source declared as IDocument
protected  IDocument AnnotationModel.fDocument
          The document connected with this model
 

Methods in org.eclipse.jface.text.source with parameters of type IDocument
 void IAnnotationModel.connect(IDocument document)
          Connects the annotation model to a document.
 void IAnnotationModel.disconnect(IDocument document)
          Disconnects this model from a document.
protected  void AnnotationModel.addPosition(IDocument document, Position position)
          Adds the given position to the default position category of the given document.
protected  void AnnotationModel.removePosition(IDocument document, Position position)
          Removes the given position from the default position category of the given document.
 void AnnotationModel.connect(IDocument document)
           
 void AnnotationModel.disconnect(IDocument document)
           
 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.
 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.
 IRegion ICharacterPairMatcher.match(IDocument iDocument, int i)
          Starting at the given offset, the matcher chooses a character close to this offset.
 

Uses of IDocument in org.eclipse.jface.text.source.projection
 

Methods in org.eclipse.jface.text.source.projection with parameters of type IDocument
 void ProjectionViewer.setDocument(IDocument document, IAnnotationModel annotationModel, int modelRangeOffset, int modelRangeLength)
           
protected  boolean ProjectionViewer.updateSlaveDocument(IDocument slaveDocument, int modelRangeOffset, int modelRangeLength)
           
protected  void ProjectionViewer.setVisibleDocument(IDocument document)
           
 IRegion[] IProjectionPosition.computeProjectionRegions(IDocument document)
          Returns an array of regions that should be collapsed when the annotation belonging to this position is collapsed.
 int IProjectionPosition.computeCaptionOffset(IDocument document)
          Returns the offset of the caption (the anchor region) of this projection position.
 

Uses of IDocument in org.eclipse.jface.text.templates
 

Methods in org.eclipse.jface.text.templates that return IDocument
 IDocument DocumentTemplateContext.getDocument()
          Returns the document.
 

Methods in org.eclipse.jface.text.templates with parameters of type IDocument
 void TemplateProposal.apply(IDocument document)
           
 Point TemplateProposal.getSelection(IDocument document)
           
 boolean TemplateProposal.validate(IDocument document, int offset, DocumentEvent event)
           
 CharSequence TemplateProposal.getPrefixCompletionText(IDocument document, int completionOffset)
           
 int TemplateProposal.getPrefixCompletionStart(IDocument document, int completionOffset)
           
 void TemplateProposal.apply(IDocument document, char trigger, int offset)
           
 boolean TemplateProposal.isValidFor(IDocument document, int offset)
           
 

Constructors in org.eclipse.jface.text.templates with parameters of type IDocument
DocumentTemplateContext(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
 

Methods in org.eclipse.ltk.core.refactoring that return IDocument
protected  IDocument TextFileChange.acquireDocument(IProgressMonitor pm)
          Acquires a reference to the document to be changed by this text change. A document acquired by this call MUST be released via a call to TextChange.releaseDocument(IDocument, IProgressMonitor).

The method releaseDocument must be call as many times as aquireDocument has been called.

protected abstract  IDocument TextChange.acquireDocument(IProgressMonitor pm)
          Acquires a reference to the document to be changed by this text change.
 IDocument TextChange.getCurrentDocument(IProgressMonitor pm)
          Returns the document this text change is associated to.
 IDocument TextChange.getPreviewDocument(IProgressMonitor pm)
          Returns a document containing a preview of the text change.
protected  IDocument DocumentChange.acquireDocument(IProgressMonitor pm)
          Acquires a reference to the document to be changed by this text change. A document acquired by this call MUST be released via a call to TextChange.releaseDocument(IDocument, IProgressMonitor).

The method releaseDocument must be call as many times as aquireDocument has been called.

 

Methods in org.eclipse.ltk.core.refactoring with parameters of type IDocument
protected  void TextFileChange.commit(IDocument document, IProgressMonitor pm)
          Commits the document acquired via a call to aquireDocument. It is up to the implementors of this method to decide what committing a document means. Typically, the content of the document is written back to the file system.
protected  void TextFileChange.releaseDocument(IDocument document, IProgressMonitor pm)
          Releases the document acquired via a call to aquireDocument.
protected abstract  void TextChange.commit(IDocument document, IProgressMonitor pm)
          Commits the document acquired via a call to aquireDocument.
protected abstract  void TextChange.releaseDocument(IDocument document, IProgressMonitor pm)
          Releases the document acquired via a call to aquireDocument.
protected  void DocumentChange.commit(IDocument document, IProgressMonitor pm)
          Commits the document acquired via a call to aquireDocument. It is up to the implementors of this method to decide what committing a document means. Typically, the content of the document is written back to the file system.
protected  void DocumentChange.releaseDocument(IDocument document, IProgressMonitor pm)
          Releases the document acquired via a call to aquireDocument.
 

Constructors in org.eclipse.ltk.core.refactoring with parameters of type IDocument
DocumentChange(String name, IDocument document)
          Creates a new DocumentChange for the given IDocument.
 

Uses of IDocument in org.eclipse.ltk.ui.refactoring
 

Methods in org.eclipse.ltk.ui.refactoring with parameters of type IDocument
protected  void TextStatusContextViewer.setInput(IDocument document, IRegion region)
          Sets the input of the source viewer to the given document and reveals the region determined by the given parameter region.
 

Uses of IDocument in org.eclipse.search.ui.text
 

Methods in org.eclipse.search.ui.text that return IDocument
 IDocument ISearchEditorAccess.getDocument(Match match)
          Finds the document displaying the match.
 

Uses of IDocument in org.eclipse.text.edits
 

Methods in org.eclipse.text.edits that return IDocument
 IDocument TextEditProcessor.getDocument()
          Returns the document to be manipulated.
 

Methods in org.eclipse.text.edits with parameters of type IDocument
 UndoEdit TextEdit.apply(IDocument document, int style)
          Applies the edit tree rooted by this edit to the given document.
 UndoEdit TextEdit.apply(IDocument document)
          Applies the edit tree rooted by this edit to the given document.
 

Constructors in org.eclipse.text.edits with parameters of type IDocument
TextEditProcessor(IDocument document, TextEdit root, int style)
          Constructs a new edit processor for the given document.
 

Uses of IDocument in org.eclipse.ui.console
 

Methods in org.eclipse.ui.console that return IDocument
 IDocument TextConsole.getDocument()
          Returns this console's document.
 

Uses of IDocument in org.eclipse.ui.editors.text
 

Methods in org.eclipse.ui.editors.text that return IDocument
 IDocument TextFileDocumentProvider.getDocument(Object element)
           
 IDocument TextFileDocumentProvider.NullProvider.getDocument(Object element)
           
protected  IDocument StorageDocumentProvider.createEmptyDocument()
          Factory method for creating empty documents.
protected  IDocument StorageDocumentProvider.createDocument(Object element)
           
 IDocument ForwardingDocumentProvider.getDocument(Object element)
           
 

Methods in org.eclipse.ui.editors.text with parameters of type IDocument
 void TextFileDocumentProvider.saveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite)
           
protected  TextFileDocumentProvider.DocumentProviderOperation TextFileDocumentProvider.createSaveOperation(Object element, IDocument document, boolean overwrite)
           
protected  void TextFileDocumentProvider.createFileFromDocument(IProgressMonitor monitor, IFile file, IDocument document)
          Creates the given file with the given document content.
 void TextFileDocumentProvider.NullProvider.saveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite)
           
protected  void StorageDocumentProvider.setDocumentContent(IDocument document, InputStream contentStream)
          Deprecated. use encoding based version instead
protected  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 instead
protected  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.
protected  void StorageDocumentProvider.doSaveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite)
           
 void ForwardingDocumentProvider.saveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite)
           
protected  boolean FileDocumentProvider.setDocumentContent(IDocument document, IEditorInput editorInput)
          Deprecated. use file encoding based version
protected  boolean FileDocumentProvider.setDocumentContent(IDocument document, IEditorInput editorInput, String encoding)
           
protected  void FileDocumentProvider.doSaveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite)
           
 

Constructors in org.eclipse.ui.editors.text with parameters of type IDocument
StorageDocumentProvider.StorageInfo(IDocument document, IAnnotationModel model)
          Creates a new storage info.
FileDocumentProvider.FileInfo(IDocument document, IAnnotationModel model, FileDocumentProvider.FileSynchronizer fileSynchronizer)
          Creates and returns a new file info.
 

Uses of IDocument in org.eclipse.ui.texteditor
 

Fields in org.eclipse.ui.texteditor declared as IDocument
 IDocument AbstractDocumentProvider.ElementInfo.fDocument
          The element's document
 

Methods in org.eclipse.ui.texteditor that return IDocument
 IDocument IDocumentProvider.getDocument(Object element)
          Returns the document for the given element.
protected abstract  IDocument AbstractDocumentProvider.createDocument(Object element)
          Creates the document for the given element.
 IDocument AbstractDocumentProvider.getDocument(Object element)
           
protected  IDocument SelectMarkerRulerAction.getDocument()
          Returns the IDocument of the editor's input.
protected  IDocument MarkerRulerAction.getDocument()
          Returns the IDocument of the editor's input.
 

Methods in org.eclipse.ui.texteditor with parameters of type IDocument
 void IDocumentProvider.saveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite)
          Saves the given document provided for the given element.
protected  int AbstractTextEditor.LineStartAction.getLineStartPosition(IDocument document, String line, int length, int offset)
          Computes the offset of the line start position.
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.
 void AbstractDocumentProvider.saveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite)
           
protected  boolean SelectMarkerRulerAction.includesRulerLine(Position position, IDocument document)
          Checks whether a position includes the ruler's line of activity.
protected  boolean MarkerRulerAction.includesRulerLine(Position position, IDocument document)
          Checks whether a position includes the ruler's line of activity.
protected  String MarkerRulerAction.getLabelProposal(IDocument document, int offset, int length)
          Returns the initial label for the marker.
 boolean IMarkerUpdater.updateMarker(IMarker marker, IDocument document, Position position)
          Updates the given marker according to the position of the given document.
 boolean BasicMarkerUpdater.updateMarker(IMarker marker, IDocument document, Position position)
           
protected  String AddMarkerAction.getLabelProposal(IDocument document, int offset, int length)
          Returns the initial label for the marker.
 boolean AbstractMarkerAnnotationModel.updateMarker(IMarker marker, IDocument document, Position position)
          Deprecated. use updateMarker(IDocument, IMarker, Position) instead. This method will be changed to protected.
 boolean AbstractMarkerAnnotationModel.updateMarker(IDocument document, IMarker marker, Position position)
          Updates the given marker according to the given position in the given document.
 void AbstractMarkerAnnotationModel.updateMarkers(IDocument document)
          Updates the markers managed by this annotation model by calling all registered marker updaters (IMarkerUpdater).
 void AbstractMarkerAnnotationModel.commit(IDocument document)
           
 void AbstractMarkerAnnotationModel.revert(IDocument document)
           
 void AbstractMarkerAnnotationModel.reinitialize(IDocument document)
           
 

Constructors in org.eclipse.ui.texteditor with parameters of type IDocument
AbstractDocumentProvider.ElementInfo(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
 

Methods in org.eclipse.ui.texteditor.quickdiff that return IDocument
 IDocument IQuickDiffReferenceProvider.getReference(IProgressMonitor monitor)
          Returns the reference document for the quick diff display.
 

Uses of IDocument in org.eclipse.ui.texteditor.spelling
 

Methods in org.eclipse.ui.texteditor.spelling with parameters of type IDocument
 void SpellingService.check(IDocument document, SpellingContext context, ISpellingProblemCollector collector, IProgressMonitor monitor)
          Checks 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 ISpellingEngine.check(IDocument document, IRegion[] regions, SpellingContext context, ISpellingProblemCollector collector, IProgressMonitor monitor)
          Checks the given regions in the given document.
 


Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.