Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

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 Provides support for detecting and displaying hyperlinks in ISourceViewers. 
org.eclipse.jface.text.link Application programming interfaces for interaction with the Eclipse text editor's linked position 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 framework for connecting document regions with annotations and for displaying those. 
org.eclipse.jface.text.source.projection This package provides the UI part for projection documents of which the most important part is the projection viewer. 
org.eclipse.jface.text.templates Application programming interfaces for interaction with the Eclipse text template support. 
org.eclipse.ltk.core.refactoring Application programmer interface to implement semantic preserving workspace transformations. 
org.eclipse.ltk.ui.refactoring Application programming 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 Provides support for describing and applying textual document editions. 
org.eclipse.text.undo Provides undo and redo support for a document. 
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 Partial infrastructure for spell checking in text editors. 
org.eclipse.ui.texteditor.templates Application programming interfaces for interaction with the Eclipse text editor template support. 
 

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
 void 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
 

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

Methods in org.eclipse.compare.contentmergeviewer with parameters of type IDocument
protected  void TextMergeViewer. setupDocument ( IDocument document)
          Setup the given document for use with this viewer.
 

Uses of IDocument in org.eclipse.compare.structuremergeviewer
 

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

Methods in org.eclipse.compare.structuremergeviewer with parameters of type IDocument
protected abstract   IStructureComparator StructureCreator. createStructureComparator ( Object element, IDocument document, ISharedDocumentAdapter sharedDocumentAdapter, IProgressMonitor monitor)
          Create an IStructureComparator 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)
          Setup the newly created document as appropriate.
 

Constructors in org.eclipse.compare.structuremergeviewer with parameters of type IDocument
DocumentRangeNode ( DocumentRangeNode parent, int typeCode, String id, IDocument document, int start, int length)
          Creates a new DocumentRangeNode for the given range within the specified document.
DocumentRangeNode (int typeCode, String id, IDocument document, int start, int length)
          Creates a new DocumentRangeNode 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
 

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

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.
  ITextFileBuffer ITextFileBufferManager. getTextFileBuffer ( IDocument document)
          Returns the text file buffer managed for the given document or null 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 IPersistableAnnotationModel. revert ( IDocument document)
          Changes the current transient state of the annotation model to match the last persisted state.
 void IDocumentSetupParticipant. setup ( IDocument document)
          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
 

Methods in org.eclipse.core.filebuffers.manipulation with parameters of type IDocument
  UndoEdit MultiTextEditWithProgress. apply ( IDocument document, int style, IProgressMonitor progressMonitor)
           
  UndoEdit MultiTextEditWithProgress. apply ( IDocument document, 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 IContentAssistSubjectControl. getDocument ()
          Returns this content assist subject control's document.
  IDocument ComboContentAssistSubjectAdapter. getDocument ()
          Deprecated.  
  IDocument TextContentAssistSubjectAdapter. getDocument ()
          Deprecated.  
 

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 DocumentEvent. fDocument
          The changed document
  IDocument DocumentRewriteSessionEvent. fDocument
          The changed document
protected   IDocument DefaultPositionUpdater. fDocument
          Catches the document
 

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

Methods in org.eclipse.jface.text with parameters of type IDocument
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  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.
 void IDocumentPartitioner. connect ( IDocument document)
          Connects the partitioner to a document.
 void IDocumentPartitionerExtension3. connect ( IDocument document, boolean delayInitialization)
          Connects this partitioner to a document.
  IDocumentInformationMapping ISlaveDocumentManager. createMasterSlaveMapping ( IDocument slave)
          Creates a new document information mapping between the given slave document and its master document.
  IDocument 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 TabsToSpacesConverter. customizeDocumentCommand ( IDocument document, DocumentCommand command)
           
 void IAutoEditStrategy. customizeDocumentCommand ( IDocument document, DocumentCommand command)
          Allows the strategy to manipulate the document 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 than offset and smaller than end 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 DefaultTextDoubleClickStrategy. findWord ( IDocument document, int offset)
          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.
  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.
static  ITypedRegion TextUtilities. getPartition ( IDocument document, String partitioning, int offset, boolean preferOpenPartitions)
          Returns the partition of the given offset of 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.
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 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 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 TextViewer. setDocument ( IDocument document)
           
 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 TextViewer. setDocument ( IDocument document, int modelRangeOffset, int modelRangeLength)
           
 void ITextViewer. setDocument ( IDocument document, int modelRangeOffset, int modelRangeLength)
          Sets the given document as this viewer's model and exposes the specified region.
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. use updateSlaveDocument instead
 

Constructors in org.eclipse.jface.text with parameters of type IDocument
BlockTextSelection ( 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.
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.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.
 void CompletionProposal. apply ( IDocument document)
           
 void ICompletionProposalExtension. apply ( IDocument document, char trigger, int offset)
          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.
  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.
  Point ICompletionProposal. getSelection ( IDocument document)
          Returns the new selection after the proposal has been applied to the given document in absolute document coordinates.
  Point CompletionProposal. getSelection ( IDocument document)
           
 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
 

Methods in org.eclipse.jface.text.formatter with parameters of type IDocument
 void IContentFormatterExtension. format ( IDocument document, IFormattingContext context)
          Formats the given region of the specified document.
 void MultiPassContentFormatter. format ( IDocument medium, IFormattingContext context)
           
 void MultiPassContentFormatter. format ( IDocument medium, IRegion region)
           
 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 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
 

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
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.
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.
protected  boolean LinkedPosition. includes ( IDocument doc, int off, int len)
          Returns whether this position includes the range given by offset and length.
 

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

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

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

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 ProjectionDocument. getMasterDocument ()
          Returns the master document of this projection document.
  IDocument ProjectionDocumentManager. getMasterDocument ( IDocument slave)
           
  IDocument ChildDocument. getParentDocument ()
          Returns the parent document of this child document.
  IDocument[] ProjectionDocumentManager. getSlaveDocuments ( IDocument master)
           
 

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

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

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

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

Methods in org.eclipse.jface.text.rules with parameters of type IDocument
 void RuleBasedPartitioner. connect ( IDocument document)
          Deprecated.  
 void FastPartitioner. connect ( IDocument document)
           
 void DefaultPartitioner. connect ( IDocument document)
          Deprecated.  
 void FastPartitioner. connect ( IDocument document, boolean delayInitialization)
          Connects this partitioner to a document.
 void DefaultPartitioner. connect ( IDocument document, boolean delayInitialization)
          Deprecated.  
 void DefaultDamagerRepairer. setDocument ( IDocument document)
           
 void RuleBasedPartitionScanner. setPartialRange ( IDocument document, int offset, int length, String contentType, int partitionOffset)
           
 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 ITokenScanner. setRange ( IDocument document, int offset, int length)
          Configures the scanner by providing access to the document range that should be scanned.
 void RuleBasedPartitionScanner. setRange ( IDocument document, int offset, int length)
           
 void BufferedRuleBasedScanner. setRange ( IDocument document, int offset, int length)
           
 void RuleBasedScanner. 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
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 IAnnotationModel. connect ( IDocument document)
          Connects the annotation model to a document.
 void AnnotationModel. disconnect ( IDocument document)
           
 void IAnnotationModel. disconnect ( IDocument document)
          Disconnects this model from a document.
  IRegion DefaultCharacterPairMatcher. match ( IDocument doc, int offset)
           
  IRegion ICharacterPairMatcher. match ( IDocument iDocument, int i)
          Starting at the given offset, the matcher chooses a character close to this offset.
protected  void AnnotationModel. removePosition ( IDocument document, Position position)
          Removes the given position from the default position category of the given document.
 void SourceViewer. setDocument ( IDocument 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 SourceViewer. setDocument ( IDocument document, IAnnotationModel annotationModel)
           
 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, IAnnotationModel annotationModel, int modelRangeOffset, int modelRangeLength)
           
 void SourceViewer. setDocument ( IDocument document, int visibleRegionOffset, int visibleRegionLength)
           
protected  void SourceViewer. updateSlaveDocuments ( IDocument masterDocument)
          Updates all slave documents of the given document.
 

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

Methods in org.eclipse.jface.text.source.projection with parameters of type IDocument
 int IProjectionPosition. computeCaptionOffset ( IDocument document)
          Returns the offset of the caption (the anchor region) of this projection position.
  IRegion[] IProjectionPosition. computeProjectionRegions ( IDocument document)
          Returns an array of regions that should be collapsed when the annotation belonging to this position is collapsed.
 void ProjectionViewer. 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
 

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)
          Deprecated. This method is no longer called by the framework and clients should overwrite TemplateProposal.apply(ITextViewer, char, int, int) instead
 void TemplateProposal. apply ( IDocument document, char trigger, int offset)
          Deprecated. This method is no longer called by the framework and clients should overwrite TemplateProposal.apply(ITextViewer, char, int, int) instead
 int TemplateProposal. getPrefixCompletionStart ( IDocument document, int completionOffset)
           
  CharSequence TemplateProposal. getPrefixCompletionText ( IDocument document, int completionOffset)
           
  Point TemplateProposal. getSelection ( IDocument document)
           
 boolean TemplateProposal. isValidFor ( IDocument document, int offset)
           
 boolean TemplateProposal. validate ( IDocument document, int offset, DocumentEvent event)
           
 

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 abstract   IDocument TextChange. acquireDocument ( IProgressMonitor pm)
          Acquires a reference to the document to be changed by this text change.
protected   IDocument DocumentChange. acquireDocument ( IProgressMonitor pm)
          Acquires a reference to the document to be changed by this text change.
protected   IDocument TextFileChange. 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 MultiStateTextFileChange. getCurrentDocument ( IProgressMonitor monitor)
          Returns a document representing the current state of the buffer, prior to the application of the change.
  IDocument TextChange. getPreviewDocument ( IProgressMonitor pm)
          Returns a document containing a preview of the text change.
  IDocument MultiStateTextFileChange. getPreviewDocument ( IProgressMonitor monitor)
          Returns a document representing the preview of the refactored buffer, after the application of the change object.
 

Methods in org.eclipse.ltk.core.refactoring with parameters of type IDocument
protected abstract  void TextChange. commit ( IDocument document, IProgressMonitor pm)
          Commits 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.
protected  void TextFileChange. commit ( IDocument document, IProgressMonitor pm)
          Commits the document acquired via a call to aquireDocument.
protected   UndoEdit TextChange. performEdits ( IDocument document)
          Executes the text edits on the given document.
protected   UndoEdit TextFileChange. performEdits ( IDocument document)
           
protected abstract  void TextChange. releaseDocument ( IDocument document, IProgressMonitor pm)
          Releases the document acquired via a call to aquireDocument.
protected  void DocumentChange. releaseDocument ( IDocument document, IProgressMonitor pm)
          Releases the document acquired via a call to aquireDocument.
protected  void TextFileChange. 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)
          Applies the edit tree rooted by this edit to the given document.
  UndoEdit TextEdit. apply ( IDocument document, int style)
          Applies the edit tree rooted by this edit to the given document.
 

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

Methods in org.eclipse.text.undo that return IDocument
  IDocument DocumentUndoEvent. getDocument ()
          Returns the changed document.
 

Methods in org.eclipse.text.undo with parameters of type IDocument
static void DocumentUndoManagerRegistry. connect ( IDocument document)
          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 or null if there is no such file buffer.
 

Constructors in org.eclipse.text.undo with parameters of type IDocument
DocumentUndoManager ( IDocument document)
          Create a DocumentUndoManager 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
protected   IDocument StorageDocumentProvider. createDocument ( Object element)
           
protected   IDocument StorageDocumentProvider. createEmptyDocument ()
          Factory method for creating empty documents.
  IDocument TextFileDocumentProvider. getDocument ( Object element)
           
  IDocument TextFileDocumentProvider.NullProvider. getDocument ( Object element)
          Deprecated.  
  IDocument ForwardingDocumentProvider. getDocument ( Object element)
           
 

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

Constructors in org.eclipse.ui.editors.text with parameters of type IDocument
FileDocumentProvider.FileInfo ( IDocument document, IAnnotationModel model, FileDocumentProvider.FileSynchronizer fileSynchronizer)
          Creates and returns a new file info.
StorageDocumentProvider.StorageInfo ( IDocument document, IAnnotationModel model)
          Creates a new storage 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.
protected   IDocument MarkerRulerAction. getDocument ()
          Returns the IDocument of the editor's input.
protected   IDocument SelectMarkerRulerAction. getDocument ()
          Returns the IDocument of the editor's input.
  IDocument IDocumentProvider. getDocument ( Object element)
          Returns the document for the given element.
  IDocument AbstractDocumentProvider. getDocument ( Object element)
           
 

Methods in org.eclipse.ui.texteditor with parameters of type IDocument
 void AbstractMarkerAnnotationModel. commit ( IDocument document)
           
 void TextViewerDeleteLineTarget. deleteLine ( IDocument document, int offset, int length, int type, boolean copyToClipboard)
           
 void TextViewerDeleteLineTarget. deleteLine ( IDocument document, ITextSelection selection, int type, boolean copyToClipboard)
          Deletes the lines that intersect with the given selection.
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 MarkerRulerAction. getLabelProposal ( IDocument document, int offset, int length)
          Returns the initial label for the marker.
protected   String AddMarkerAction. 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  boolean SelectMarkerRulerAction. includesRulerLine ( Position position, IDocument document)
          Checks whether a position includes the ruler's line of activity.
 void AbstractMarkerAnnotationModel. reinitialize ( IDocument document)
           
 void AbstractMarkerAnnotationModel. revert ( IDocument document)
           
 void IDocumentProvider. saveDocument ( IProgressMonitor monitor, Object element, IDocument document, boolean overwrite)
          Saves the given document provided for the given element.
 void AbstractDocumentProvider. saveDocument ( IProgressMonitor monitor, Object element, IDocument document, boolean overwrite)
           
 boolean AbstractMarkerAnnotationModel. updateMarker ( IDocument document, IMarker marker, Position position)
          Updates the given marker according to the given position in the given document.
 boolean AbstractMarkerAnnotationModel. updateMarker ( IMarker marker, IDocument document, Position position)
          Deprecated. use updateMarker(IDocument, IMarker, Position) instead. This method will be changed to protected.
 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).
 

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 that return IDocument
protected   IDocument SpellingReconcileStrategy. getDocument ()
          Returns the document which is spell checked.
 

Methods in org.eclipse.ui.texteditor.spelling with parameters of type IDocument
 void 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
 

Methods in org.eclipse.ui.texteditor.templates with parameters of type IDocument
protected 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.
 


Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire