|
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.AbstractReconcileStep
Abstract implementation of a reconcile step.
Field Summary | |
protected IReconcilableModel |
fInputModel
|
Constructor Summary | |
AbstractReconcileStep()
Creates the last reconcile step of the pipe. |
|
AbstractReconcileStep(IReconcileStep step)
Creates an intermediate reconcile step which adds the given step to the pipe. |
Method Summary | |
protected IReconcileResult[] |
convertToInputModel(IReconcileResult[] inputResults)
Adapts the given an array with reconcile results to this step's input model and returns it. |
IReconcilableModel |
getInputModel()
Returns the reconcilable input model. |
abstract IReconcilableModel |
getModel()
Returns the reconcilable model. |
IProgressMonitor |
getProgressMonitor()
Returns the progress monitor used to report progress. |
protected boolean |
isCanceled()
|
boolean |
isFirstStep()
Returns whether this is the first reconcile step or not. |
boolean |
isLastStep()
Returns whether this is the last reconcile step or not. |
IReconcileResult[] |
reconcile(DirtyRegion dirtyRegion,
IRegion subRegion)
Activates incremental reconciling of the specified dirty region. |
IReconcileResult[] |
reconcile(IRegion partition)
Activates non-incremental reconciling. |
protected abstract IReconcileResult[] |
reconcileModel(DirtyRegion dirtyRegion,
IRegion subRegion)
Reconciles the model of this reconcile step. |
void |
setInputModel(IReconcilableModel inputModel)
Tells this reconcile step on which model it will work. |
void |
setPreviousStep(IReconcileStep step)
Sets the step which is in front of this step in the pipe. |
void |
setProgressMonitor(IProgressMonitor monitor)
Sets the progress monitor for this reconcile step. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected IReconcilableModel fInputModel
Constructor Detail |
public AbstractReconcileStep(IReconcileStep step)
step
- the reconcile steppublic AbstractReconcileStep()
Method Detail |
public boolean isLastStep()
IReconcileStep
isLastStep
in interface IReconcileStep
true
iff this is the last reconcile steppublic boolean isFirstStep()
IReconcileStep
isFirstStep
in interface IReconcileStep
true
iff this is the first reconcile steppublic void setProgressMonitor(IProgressMonitor monitor)
IReconcileStep
setProgressMonitor
in interface IReconcileStep
monitor
- the progress monitor to be usedpublic IProgressMonitor getProgressMonitor()
IReconcileStep
getProgressMonitor
in interface IReconcileStep
null
if no progress monitor is availablepublic final IReconcileResult[] reconcile(IRegion partition)
IReconcileStep
IReconcilingStrategy.setDocument(org.eclipse.jface.text.IDocument)
.
reconcile
in interface IReconcileStep
partition
- the document partition to be reconciled
public final IReconcileResult[] reconcile(DirtyRegion dirtyRegion, IRegion subRegion)
IReconcileStep
IReconcilingStrategy.setDocument(org.eclipse.jface.text.IDocument)
.
reconcile
in interface IReconcileStep
dirtyRegion
- the document region which has been changedsubRegion
- the sub region in the dirty region which should be reconciled
protected abstract IReconcileResult[] reconcileModel(DirtyRegion dirtyRegion, IRegion subRegion)
dirtyRegion
- the document region which has been changedsubRegion
- the sub region in the dirty region which should be reconciled
protected IReconcileResult[] convertToInputModel(IReconcileResult[] inputResults)
inputResults
- an array with reconcile results
protected final boolean isCanceled()
public void setPreviousStep(IReconcileStep step)
IReconcileStep
Note: This method must be called at most once per reconcile step.
setPreviousStep
in interface IReconcileStep
step
- the previous steppublic void setInputModel(IReconcilableModel inputModel)
IReconcileStep
setInputModel
in interface IReconcileStep
inputModel
- the model on which this step will workpublic IReconcilableModel getInputModel()
public abstract IReconcilableModel getModel()
|
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.