Eclipse Platform
Release 3.0

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

Packages that use IRegion
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 and manipulating text documents. 
org.eclipse.jface.text.formatter Provides a content formatter add-on for an ITextViewer.  
org.eclipse.jface.text.information Provides an information provider add-on for an ITextViewer.  
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.text.edits   
org.eclipse.ui.texteditor Provides a framework for text editors obeying to the desktop rules.  
 

Uses of IRegion in org.eclipse.debug.ui.console
 

Methods in org.eclipse.debug.ui.console that return IRegion
 IRegion IConsole.getRegion(IConsoleHyperlink link)
          Returns the region of text associated with the given hyperlink, or null if the given hyperlink is not contained in this console.
 

Methods in org.eclipse.debug.ui.console with parameters of type IRegion
 void IConsoleLineTracker.lineAppended(IRegion line)
          Notification that a line of text has been appended to the console.
 

Uses of IRegion in org.eclipse.jface.text
 

Subinterfaces of IRegion in org.eclipse.jface.text
 interface ITypedRegion
          Describes a region of an indexed text store such as a document or a string.
 

Classes in org.eclipse.jface.text that implement IRegion
 class Region
          The default implementation of the IRegion interface.
 class TypedRegion
          Default implementation of ITypedRegion.
 

Methods in org.eclipse.jface.text that return IRegion
 IRegion IDocumentInformationMappingExtension.toExactImageRegion(IRegion originRegion)
          Adheres to originRegion=toOriginRegion(toExactImageRegion(originRegion)), if toExactImageRegion(originRegion) !
 IRegion[] IDocumentInformationMappingExtension.toExactImageRegions(IRegion originRegion)
          Returns the segments of the image document that exactly correspond to the given region of the original document.
 IRegion[] IDocumentInformationMappingExtension.toExactOriginRegions(IRegion imageRegion)
          Returns the fragments of the original document that exactly correspond to the given region of the image document.
 IRegion[] IDocumentInformationMappingExtension.getExactCoverage(IRegion originRegion)
          Returns the maximal sub-regions of the given origin region which are completely covered.
 IRegion IDocument.getLineInformation(int line)
          Returns a description of the specified line.
 IRegion IDocument.getLineInformationOfOffset(int offset)
          Returns a description of the line at the given offset.
 IRegion ILineTracker.getLineInformationOfOffset(int offset)
          Returns a line description of the line at the given offset.
 IRegion ILineTracker.getLineInformation(int line)
          Returns a line description of the given line.
 IRegion FindReplaceDocumentAdapter.find(int startOffset, String findString, boolean forwardSearch, boolean caseSensitive, boolean wholeWord, boolean regExSearch)
          Returns the location of a given string in this adapter's document based on a set of search criteria.
 IRegion FindReplaceDocumentAdapter.replace(String text, boolean regExReplace)
          Substitutes the previous match with the given text.
 IRegion IDocumentPartitionerExtension.documentChanged2(DocumentEvent event)
          The document has been changed.
 IRegion IDocumentInformationMapping.getCoverage()
          Returns the minimal region of the original document that completely comprises all of the image document or null if there is no such region.
 IRegion IDocumentInformationMapping.toOriginRegion(IRegion imageRegion)
          Returns the minimal region of the original document that completely comprises the given region of the image document or null if there is no such region.
 IRegion IDocumentInformationMapping.toOriginLines(int imageLine)
          Returns the range of lines of the original document that corresponds to the given line of the image document or null if there are no such lines.
 IRegion IDocumentInformationMapping.toImageRegion(IRegion originRegion)
          Returns the minimal region of the image document that completely comprises the given region of the original document or null if there is no such region.
 IRegion AbstractLineTracker.getLineInformationOfOffset(int position)
           
 IRegion AbstractLineTracker.getLineInformation(int line)
           
 IRegion AbstractDocument.getLineInformation(int line)
           
 IRegion AbstractDocument.getLineInformationOfOffset(int offset)
           
 IRegion DocumentPartitioningChangedEvent.getChangedRegion(String partitioning)
          Returns the changed region of the given partitioning or null if the given partitioning did not change.
 IRegion DocumentPartitioningChangedEvent.getCoverage()
          Returns the coverage of this event.
 IRegion ITextViewer.getVisibleRegion()
          Returns the current visible region of this viewer's document.
 IRegion TextPresentation.getCoverage()
          Returns the coverage of this presentation as clipped by the presentation's result window.
 IRegion TextPresentation.getExtent()
          Returns the extent of this presentation clipped by the presentation's result window.
 IRegion IFindReplaceTargetExtension.getScope()
          Returns the find scope of the target, null for global scope.
 IRegion ITextHover.getHoverRegion(ITextViewer textViewer, int offset)
          Returns the text region which should serve as the source of information to compute the hover popup display information.
protected  IRegion TextViewer.getExtent(int start, int end)
          Returns the region covered by the given start and end offset.
 IRegion TextViewer.getVisibleRegion()
           
protected  IRegion TextViewer._internalGetVisibleRegion()
          Returns the visible region if it is not equal to the whole document.
 IRegion TextViewer.modelRange2WidgetRange(IRegion modelRange)
          Implements the contract of ITextViewerExtension5.modelRange2WidgetRange(IRegion).
 IRegion TextViewer.widgetRange2ModelRange(IRegion widgetRange)
          Implements the contract of ITextViewerExtension5.widgetRange2ModelRange(IRegion).
 IRegion TextViewer.getModelCoverage()
          Implements the contract of ITextViewerExtension5.getModelCoverage().
protected  IRegion TextViewer.modelRange2WidgetRange(Position modelPosition)
          Same as TextViewer.modelRange2WidgetRange(IRegion) just for a Position.
protected  IRegion TextViewer.event2ModelRange(VerifyEvent event)
          Translates the widget region of the given verify event into the corresponding region of the viewer's document.
 IRegion ITextViewerExtension5.getModelCoverage()
          Returns the minimal region of the viewer's input document that completely comprises everything that is visible in the viewer's widget or null if there is no such region.
 IRegion ITextViewerExtension5.modelRange2WidgetRange(IRegion modelRange)
          Returns the minimal region of the viewer's widget that completely comprises the given region of the viewer's input document or null if there is no such region.
 IRegion ITextViewerExtension5.widgetRange2ModelRange(IRegion widgetRange)
          Returns the minimal region of the viewer's input document that completely comprises the given widget region or null if there is no such region.
 IRegion[] ITextViewerExtension5.getCoveredModelRanges(IRegion modelRange)
          Returns the maximal subranges of the given model range thus that there is no offset inside a subrange for which there is no image offset.
 IRegion ITextViewerExtension3.getModelCoverage()
          Deprecated. Returns the minimal region of the viewer's document that completely comprises everything that is visible in the viewer's widget or null if there is no such region.
 IRegion ITextViewerExtension3.modelRange2WidgetRange(IRegion modelRange)
          Deprecated. Returns the minimal region of the viewer's widget that completely comprises the given region of the viewer's document or null if there is no such region.
 IRegion ITextViewerExtension3.widgetRange2ModelRange(IRegion widgetRange)
          Deprecated. Returns the minimal region of the viewer's document that completely comprises the given widget region or null if there is no such region.
 

Methods in org.eclipse.jface.text with parameters of type IRegion
 IRegion IDocumentInformationMappingExtension.toExactImageRegion(IRegion originRegion)
          Adheres to originRegion=toOriginRegion(toExactImageRegion(originRegion)), if toExactImageRegion(originRegion) !
 IRegion[] IDocumentInformationMappingExtension.toExactImageRegions(IRegion originRegion)
          Returns the segments of the image document that exactly correspond to the given region of the original document.
 IRegion[] IDocumentInformationMappingExtension.toExactOriginRegions(IRegion imageRegion)
          Returns the fragments of the original document that exactly correspond to the given region of the image document.
 IRegion[] IDocumentInformationMappingExtension.getExactCoverage(IRegion originRegion)
          Returns the maximal sub-regions of the given origin region which are completely covered.
static boolean TextUtilities.overlaps(IRegion left, IRegion right)
          Returns true if the two regions overlap.
 void IDocumentPartitioningListenerExtension.documentPartitioningChanged(IDocument document, IRegion region)
          The partitioning of the given document changed in the given region.
 IRegion IDocumentInformationMapping.toOriginRegion(IRegion imageRegion)
          Returns the minimal region of the original document that completely comprises the given region of the image document or null if there is no such region.
 IRegion IDocumentInformationMapping.toImageRegion(IRegion originRegion)
          Returns the minimal region of the image document that completely comprises the given region of the original document or null if there is no such region.
protected  void AbstractDocument.fireDocumentPartitioningChanged(IRegion region)
          Deprecated. as of 3.0. Use fireDocumentPartitioningChanged(DocumentPartitioningChangedEvent) instead.
protected  void AbstractDocument.doFireDocumentChanged(DocumentEvent event, boolean firePartitionChange, IRegion partitionChange)
          Deprecated. as of 3.0. Use doFireDocumentChanged2(DocumentEvent) instead; this method will be removed.
 void TextPresentation.setResultWindow(IRegion resultWindow)
          Sets the result window for this presentation.
 void IFindReplaceTargetExtension.setScope(IRegion scope)
          Sets the find scope of the target to operate on.
 String ITextHover.getHoverInfo(ITextViewer textViewer, IRegion hoverRegion)
          Returns the information which should be presented when a hover popup is shown for the specified hover region.
 IRegion TextViewer.modelRange2WidgetRange(IRegion modelRange)
          Implements the contract of ITextViewerExtension5.modelRange2WidgetRange(IRegion).
 IRegion TextViewer.widgetRange2ModelRange(IRegion widgetRange)
          Implements the contract of ITextViewerExtension5.widgetRange2ModelRange(IRegion).
 IRegion ITextViewerExtension5.modelRange2WidgetRange(IRegion modelRange)
          Returns the minimal region of the viewer's widget that completely comprises the given region of the viewer's input document or null if there is no such region.
 IRegion ITextViewerExtension5.widgetRange2ModelRange(IRegion widgetRange)
          Returns the minimal region of the viewer's input document that completely comprises the given widget region or null if there is no such region.
 IRegion[] ITextViewerExtension5.getCoveredModelRanges(IRegion modelRange)
          Returns the maximal subranges of the given model range thus that there is no offset inside a subrange for which there is no image offset.
 boolean ITextViewerExtension5.exposeModelRange(IRegion modelRange)
          Exposes the given model range.
 IRegion ITextViewerExtension3.modelRange2WidgetRange(IRegion modelRange)
          Deprecated. Returns the minimal region of the viewer's widget that completely comprises the given region of the viewer's document or null if there is no such region.
 IRegion ITextViewerExtension3.widgetRange2ModelRange(IRegion widgetRange)
          Deprecated. Returns the minimal region of the viewer's document that completely comprises the given widget region or null if there is no such region.
 

Constructors in org.eclipse.jface.text with parameters of type IRegion
TextPresentation(IRegion extent, int sizeHint)
          Creates a new empty text presentation with the given extent.
 

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

Methods in org.eclipse.jface.text.formatter with parameters of type IRegion
 void ContentFormatter.format(IDocument document, IRegion region)
           
 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.
 

Uses of IRegion in org.eclipse.jface.text.information
 

Methods in org.eclipse.jface.text.information that return IRegion
 IRegion IInformationProvider.getSubject(ITextViewer textViewer, int offset)
          Returns the region of the text viewer's document close to the given offset that contains a subject about which information can be provided.
 

Methods in org.eclipse.jface.text.information with parameters of type IRegion
 String IInformationProvider.getInformation(ITextViewer textViewer, IRegion subject)
          Deprecated. As of 2.1, replaced by IInformationProviderExtension.getInformation2(ITextViewer, IRegion)
 Object IInformationProviderExtension.getInformation2(ITextViewer textViewer, IRegion subject)
          Returns the element for the given subject or null if no element is available.
 

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

Methods in org.eclipse.jface.text.link that return IRegion
 IRegion LinkedModeUI.getSelectedRegion()
          Returns the currently selected region or null.
 

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

Methods in org.eclipse.jface.text.presentation that return IRegion
 IRegion IPresentationDamager.getDamageRegion(ITypedRegion partition, DocumentEvent event, boolean documentPartitioningChanged)
          Returns the damage in the document's presentation caused by the given document change.
 

Methods in org.eclipse.jface.text.presentation with parameters of type IRegion
protected  TextPresentation PresentationReconciler.createPresentation(IRegion damage, IDocument document)
          Constructs a "repair description" for the given damage and returns this description as a text presentation.
 

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

Methods in org.eclipse.jface.text.projection that return IRegion
 IRegion[] ProjectionDocument.computeUnprojectedMasterRegions(int offsetInMaster, int lengthInMaster)
          Returns the sequence of all master document regions with are contained in the given master document range and which are not yet part of this projection document.
 IRegion[] ProjectionDocument.computeProjectedMasterRegions(int offsetInMaster, int lengthInMaster)
          Returns the sequence of all master document regions with are contained in the given master document range and which are part of this projection document.
 IRegion ProjectionMapping.getCoverage()
           
 IRegion ProjectionMapping.toOriginRegion(IRegion imageRegion)
           
 IRegion ProjectionMapping.toOriginLines(int imageLine)
           
 IRegion ProjectionMapping.toExactImageRegion(IRegion originRegion)
           
 IRegion ProjectionMapping.toImageRegion(IRegion originRegion)
           
 IRegion[] ProjectionMapping.toExactOriginRegions(IRegion imageRegion)
           
 IRegion[] ProjectionMapping.toExactImageRegions(IRegion originRegion)
           
 IRegion[] ProjectionMapping.getExactCoverage(IRegion originRegion)
           
 

Methods in org.eclipse.jface.text.projection with parameters of type IRegion
 IRegion ProjectionMapping.toOriginRegion(IRegion imageRegion)
           
 IRegion ProjectionMapping.toExactImageRegion(IRegion originRegion)
           
 IRegion ProjectionMapping.toImageRegion(IRegion originRegion)
           
 IRegion[] ProjectionMapping.toExactOriginRegions(IRegion imageRegion)
           
 IRegion[] ProjectionMapping.toExactImageRegions(IRegion originRegion)
           
 IRegion[] ProjectionMapping.getExactCoverage(IRegion originRegion)
           
 

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

Classes in org.eclipse.jface.text.reconciler that implement IRegion
 class DirtyRegion
          A dirty region describes a document range which has been changed.
 

Methods in org.eclipse.jface.text.reconciler with parameters of type IRegion
 IReconcileResult[] IReconcileStep.reconcile(DirtyRegion dirtyRegion, IRegion subRegion)
          Activates incremental reconciling of the specified dirty region.
 IReconcileResult[] IReconcileStep.reconcile(IRegion partition)
          Activates non-incremental reconciling.
 IReconcileResult[] AbstractReconcileStep.reconcile(IRegion partition)
           
 IReconcileResult[] AbstractReconcileStep.reconcile(DirtyRegion dirtyRegion, IRegion subRegion)
           
protected abstract  IReconcileResult[] AbstractReconcileStep.reconcileModel(DirtyRegion dirtyRegion, IRegion subRegion)
          Reconciles the model of this reconcile step.
 void IReconcilingStrategy.reconcile(DirtyRegion dirtyRegion, IRegion subRegion)
          Activates incremental reconciling of the specified dirty region.
 void IReconcilingStrategy.reconcile(IRegion partition)
          Activates non-incremental reconciling.
 

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

Methods in org.eclipse.jface.text.rules that return IRegion
 IRegion DefaultDamagerRepairer.getDamageRegion(ITypedRegion partition, DocumentEvent e, boolean documentPartitioningChanged)
           
 IRegion RuleBasedPartitioner.documentChanged2(DocumentEvent e)
          Deprecated.  
 IRegion DefaultPartitioner.documentChanged2(DocumentEvent e)
           
 

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

Methods in org.eclipse.jface.text.source that return IRegion
 IRegion ISourceViewer.getRangeIndication()
          Returns the viewer's range indication.
 IRegion ICharacterPairMatcher.match(IDocument iDocument, int i)
          Starting at the given offset, the matcher chooses a character close to this offset.
 IRegion SourceViewer.getRangeIndication()
           
 

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

Methods in org.eclipse.jface.text.source.projection that return IRegion
 IRegion ProjectionViewer.getVisibleRegion()
           
 IRegion ProjectionViewer.computeCollapsedRegion(Position position)
          Computes the region that must be collapsed when the given position is the position of an expanded projection annotation.
 IRegion[] ProjectionViewer.getCoveredModelRanges(IRegion modelRange)
           
 

Methods in org.eclipse.jface.text.source.projection with parameters of type IRegion
 boolean ProjectionViewer.exposeModelRange(IRegion modelRange)
           
 IRegion[] ProjectionViewer.getCoveredModelRanges(IRegion modelRange)
           
 

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

Methods in org.eclipse.jface.text.templates with parameters of type IRegion
protected  TemplateContext TemplateCompletionProcessor.createContext(ITextViewer viewer, IRegion region)
          Creates a concrete template context for the given region in the document.
protected abstract  TemplateContextType TemplateCompletionProcessor.getContextType(ITextViewer viewer, IRegion region)
          Returns the context type that can handle template insertion at the given region in the viewer's document.
 

Constructors in org.eclipse.jface.text.templates with parameters of type IRegion
TemplateProposal(Template template, TemplateContext context, IRegion region, Image image)
          Creates a template proposal with a template and its context.
TemplateProposal(Template template, TemplateContext context, IRegion region, Image image, int relevance)
          Creates a template proposal with a template and its context.
 

Uses of IRegion in org.eclipse.text.edits
 

Methods in org.eclipse.text.edits that return IRegion
static IRegion MoveSourceEdit.intersect(TextEdit op1, TextEdit op2)
           
 IRegion TextEdit.getRegion()
          Returns the range that this edit is manipulating.
static IRegion TextEdit.getCoverage(TextEdit[] edits)
          Returns the text range spawned by the given array of text edits.
 IRegion TextEditGroup.getRegion()
          Returns the text region covered by the edits managed via this edit group.
 

Uses of IRegion in org.eclipse.ui.texteditor
 

Methods in org.eclipse.ui.texteditor that return IRegion
 IRegion AbstractTextEditor.getHighlightRange()
           
protected static IRegion AbstractTextEditor.getCoverage(ISourceViewer viewer)
          Returns the minimal region of the given source viewer's document that completely comprises everything that is visible in the viewer's widget.
 IRegion ITextEditor.getHighlightRange()
          Returns the highlighted range of this text editor.
 


Eclipse Platform
Release 3.0

Guidelines for using Eclipse APIs.

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