|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.text.reconciler.AbstractReconciler
org.eclipse.jface.text.reconciler.Reconciler
Standard implementation of IReconciler
.
The reconciler is configured with a set of reconciling strategies
each of which is responsible for a particular content type.
Usually, clients instantiate this class and configure it before using it.
IDocumentListener
,
ITextInputListener
,
DirtyRegion
Constructor Summary | |
Reconciler()
Creates a new reconciler with the following configuration: it is an incremental reconciler with a standard delay of 500 milli-seconds. |
Method Summary | |
String |
getDocumentPartitioning()
Returns the partitioning this reconciler is using. |
IReconcilingStrategy |
getReconcilingStrategy(String contentType)
Returns the reconciling strategy registered with the reconciler for the specified content type. |
protected void |
initialProcess()
This method is called on startup of the background activity. |
protected void |
process(DirtyRegion dirtyRegion)
Processes a dirty region. |
protected void |
reconcilerDocumentChanged(IDocument document)
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 |
setDocumentPartitioning(String partitioning)
Sets the document partitioning for this reconciler. |
void |
setProgressMonitor(IProgressMonitor monitor)
Sets the progress monitor of this reconciler. |
void |
setReconcilingStrategy(IReconcilingStrategy strategy,
String contentType)
Registers a given reconciling strategy for a particular content type. |
Methods inherited from class org.eclipse.jface.text.reconciler.AbstractReconciler |
aboutToBeReconciled, forceReconciling, getDocument, getProgressMonitor, getTextViewer, install, isIncrementalReconciler, reconcilerReset, setDelay, setIsIncrementalReconciler, startReconciling, uninstall |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Reconciler()
IDocumentExtension3.DEFAULT_PARTITIONING
.
Method Detail |
public void setDocumentPartitioning(String partitioning)
partitioning
- the document partitioning for this reconcilerpublic String getDocumentPartitioning()
IReconcilerExtension
getDocumentPartitioning
in interface IReconcilerExtension
public void setReconcilingStrategy(IReconcilingStrategy strategy, String contentType)
strategy
- the reconciling strategy to register, or null
to remove an existing onecontentType
- the content type under which to registerpublic IReconcilingStrategy getReconcilingStrategy(String contentType)
IReconciler
getReconcilingStrategy
in interface IReconciler
contentType
- the content type for which to determine the reconciling strategy
null
if there is no such strategyprotected void process(DirtyRegion dirtyRegion)
null
the whole
document is consider being dirty. The dirty region is partitioned by the
document and each partition is handed over to a reconciling strategy registered
for the partition's content type.
process
in class AbstractReconciler
dirtyRegion
- the dirty region to be processedAbstractReconciler.process(DirtyRegion)
protected void reconcilerDocumentChanged(IDocument document)
AbstractReconciler
reconcilerDocumentChanged
in class AbstractReconciler
document
- the new reconciler documentpublic void setProgressMonitor(IProgressMonitor monitor)
AbstractReconciler
setProgressMonitor
in class AbstractReconciler
monitor
- the monitor to be usedprotected void initialProcess()
AbstractReconciler
initialProcess
in class AbstractReconciler
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.