Eclipse Platform
2.1

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

Packages that use IDocument
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.debug.ui.console

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

org.eclipse.jface.text Provides a framework for creating, manipulating, displaying and editing text documents. 
org.eclipse.jface.text.contentassist Provides a content assist add-on for an ITextViewer
org.eclipse.jface.text.formatter Provides a text formatter add-on for an ITextViewer
org.eclipse.jface.text.presentation Provides a presentation reconciler add-on for an ITextViewer
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 framework for connecting document regions with annotations and for displaying those annotations in combination with an ITextViewer
org.eclipse.ui.editors.text Provides a standard text editor and a file-based document provider. 
org.eclipse.ui.texteditor Provides a framework for text editors obeying to the desktop rules. 
 

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.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.text
 

Classes in org.eclipse.jface.text that implement IDocument
 class AbstractDocument
          Abstract implementation of IDocument.
 class ChildDocument
          A child document is one particular example of a slave document.
 class Document
          Default document implementation.
 class ProjectionDocument
          A ProjectionDocument represents a projection of its master document.
 

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

Methods in org.eclipse.jface.text that return IDocument
 IDocument ProjectionDocument.getParentDocument()
          Returns parent document.
 IDocument IMarkSelection.getDocument()
          Returns the marked document.
 IDocument DocumentEvent.getDocument()
          Returns the changed 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 ChildDocumentManager.createSlaveDocument(IDocument master)
           
 IDocument ChildDocumentManager.getMasterDocument(IDocument slave)
           
 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 ProjectionDocumentManager.createSlaveDocument(IDocument master)
           
 IDocument ProjectionDocumentManager.getMasterDocument(IDocument slave)
           
 IDocument MarkSelection.getDocument()
           
 IDocument IRewriteTarget.getDocument()
          Returns the document of this target.
 IDocument ITextViewer.getDocument()
          Returns the text viewer's input document.
 IDocument ChildDocument.getParentDocument()
          Returns parent document
 

Methods in org.eclipse.jface.text with parameters of type IDocument
 void IDocumentPartitioningListener.documentPartitioningChanged(IDocument document)
          The partitioning of the given document changed.
 void PaintManager.inputDocumentAboutToBeChanged(IDocument oldInput, IDocument newInput)
           
 void PaintManager.inputDocumentChanged(IDocument oldInput, IDocument newInput)
           
 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.
protected  int DefaultAutoIndentStrategy.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 DefaultAutoIndentStrategy.customizeDocumentCommand(IDocument d, DocumentCommand c)
           
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.
 void IAutoEditStrategy.customizeDocumentCommand(IDocument document, DocumentCommand command)
          Allows the strategy to manipulate the document command.
 IDocument ChildDocumentManager.createSlaveDocument(IDocument master)
           
 void ChildDocumentManager.freeSlaveDocument(IDocument slave)
           
 IDocumentInformationMapping ChildDocumentManager.createMasterSlaveMapping(IDocument slave)
           
 IDocument ChildDocumentManager.getMasterDocument(IDocument slave)
           
 boolean ChildDocumentManager.isSlaveDocument(IDocument document)
           
 void ChildDocumentManager.setAutoExpandMode(IDocument slaveDocument, boolean autoExpand)
           
 void IDocumentAdapter.setDocument(IDocument document)
          Sets the adapters document.
 void IDocumentExtension.IReplace.perform(IDocument document, IDocumentListener owner)
          Executes the replace operation on the given document.
 void IDocumentPartitioner.connect(IDocument document)
          Connects the partitioner to a 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 sucessful input change, This method does not use a robust iterator.
 void TextViewer.setDocument(IDocument document)
           
 void TextViewer.setDocument(IDocument document, int visibleRegionOffset, int visibleRegionLength)
           
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)
          Sets the given slave document to the specified range of its master 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 IDocumentPartitioningListenerExtension.documentPartitioningChanged(IDocument document, IRegion region)
          The partitioning of the given document changed in the given region.
 IDocumentInformationMapping ProjectionDocumentManager.createMasterSlaveMapping(IDocument slave)
           
 IDocument ProjectionDocumentManager.createSlaveDocument(IDocument master)
           
 void ProjectionDocumentManager.freeSlaveDocument(IDocument slave)
           
 IDocument ProjectionDocumentManager.getMasterDocument(IDocument slave)
           
 boolean ProjectionDocumentManager.isSlaveDocument(IDocument document)
           
 void ProjectionDocumentManager.setAutoExpandMode(IDocument slave, boolean autoExpand)
           
 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 visibleRegionOffset, int visibleRegionLength)
          Sets the given document as this viewer's model and makes the specified region visible in the presentation.
 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.
 

Constructors in org.eclipse.jface.text with parameters of type IDocument
ProjectionPosition(IDocument projectionDocument, int offset, int length)
          Creates a new position representing the corresponding range of a fragment.
ProjectionDocument(IDocument parentDocument, String projectionCategory)
          Creates a projection document for the given parent document.
DocumentEvent(IDocument doc, int offset, int length, String text)
          Creates a new document event.
SlaveDocumentEvent(IDocument doc, int offset, int length, String text, DocumentEvent masterEvent)
          Creates a new slave document event.
CoordinatesTranslator(IDocument parent, String parentCategory, ProjectionDocument projection, String projectionCategory)
          Creates a new mapping between the given parent document and the given projection document.
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.
ChildDocument(IDocument parentDocument, Position range)
          Creates a child document for the given range of the given parent document.
 

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

Methods in org.eclipse.jface.text.contentassist with parameters of type IDocument
 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.
 boolean ICompletionProposalExtension2.validate(IDocument document, int offset, DocumentEvent event)
          Requests the proposal to be validated with respect to the document event.
 void CompletionProposal.apply(IDocument document)
           
 Point CompletionProposal.getSelection(IDocument document)
           
 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.
 

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

Methods in org.eclipse.jface.text.formatter with parameters of type IDocument
 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.
 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.
 

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

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

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 DefaultDamagerRepairer.fDocument
          The document this object works on
protected  IDocument RuleBasedPartitioner.fDocument
          Deprecated. The partitioner's document
protected  IDocument DefaultPartitioner.fDocument
          The partitioner's document
 

Methods in org.eclipse.jface.text.rules with parameters of type IDocument
 void RuleBasedScanner.setRange(IDocument document, int offset, int length)
           
 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 DefaultDamagerRepairer.setDocument(IDocument document)
           
 void RuleBasedPartitioner.connect(IDocument document)
          Deprecated.  
 void ITokenScanner.setRange(IDocument document, int offset, int length)
          Configures the scanner by providing access to the document range that should be scanned.
 void BufferedRuleBasedScanner.setRange(IDocument document, int offset, int length)
           
 void RuleBasedPartitionScanner.setRange(IDocument document, int offset, int length)
           
 void RuleBasedPartitionScanner.setPartialRange(IDocument document, int offset, int length, String contentType, int partitionOffset)
           
 void DefaultPartitioner.connect(IDocument document)
           
 

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 conntected with this model
 

Methods in org.eclipse.jface.text.source that return IDocument
 IDocument ProjectionSourceViewer.getVisibleDocument()
           
 

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.
 IRegion ICharacterPairMatcher.match(IDocument iDocument, int i)
          Starting at the given offset, the matcher chooses a character close to this offset.
protected  void AnnotationModel.addPosition(IDocument document, Position position)
          Adds the given position to 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 visibleRegionOffset, int visibleRegionLength)
           
 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 visibleRegionOffset, int visibleRegionLength)
          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 ProjectionSourceViewer.setDocument(IDocument document, IAnnotationModel annotationModel, int visibleRegionOffset, int visibleRegionLength)
           
protected  boolean ProjectionSourceViewer.updateVisibleDocument(IDocument visibleDocument, int visibleRegionOffset, int visibleRegionLength)
           
 

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

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

Methods in org.eclipse.ui.editors.text with parameters of type IDocument
protected  void StorageDocumentProvider.setDocumentContent(IDocument document, InputStream contentStream)
          Deprecated. use encoding based version instead
protected  void StorageDocumentProvider.setDocumentContent(IDocument document, InputStream contentStream, String encoding)
          Intitializes 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)
          Intitializes the given document from the given editor input using the given character encoding.
protected  void StorageDocumentProvider.doSaveDocument(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
protected abstract  IDocument AbstractDocumentProvider.createDocument(Object element)
          Creates the document for the given element.
 IDocument AbstractDocumentProvider.getDocument(Object element)
           
 IDocument IDocumentProvider.getDocument(Object element)
          Returns the document for the given 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
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)
           
 void IDocumentProvider.saveDocument(IProgressMonitor monitor, Object element, IDocument document, boolean overwrite)
          Saves the given document provided for the given element.
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 AddMarkerAction.getLabelProposal(IDocument document, int offset, int length)
          Returns the initial label for the marker.
 boolean AbstractMarkerAnnotationModel.updateMarker(IMarker marker, IDocument document, 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).
 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)
           
 

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.
 


Eclipse Platform
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.