Java Doc for AbstractReconciler.java in » IDE-Eclipse » jface » org » eclipse » jface » text » reconciler » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » IDE Eclipse » jface » org.eclipse.jface.text.reconciler

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.eclipse.jface.text.reconciler .AbstractReconciler

All known Subclasses:   org.eclipse.jface.text.reconciler .Reconciler,  org.eclipse.jface.text.reconciler .MonoReconciler,
AbstractReconciler
abstract public class AbstractReconciler implements IReconciler(Code)
Abstract implementation of IReconciler . The reconciler listens to input document changes as well as changes of the input document of the text viewer it is installed on. Depending on its configuration it manages the received change notifications in a queue folding neighboring or overlapping changes together. The reconciler processes the dirty regions as a background activity after having waited for further changes for the configured duration of time. A reconciler is started using the AbstractReconciler.install(ITextViewer) method. As a first step AbstractReconciler.initialProcess() is executed in the background. Then, the reconciling thread waits for changes that need to be reconciled. A reconciler can be resumed by calling AbstractReconciler.forceReconciling() independent from the existence of actual changes. This mechanism is for subclasses only. It is the clients responsibility to stop a reconciler using its AbstractReconciler.uninstall() method. Unstopped reconcilers do not free their resources.
It is subclass responsibility to specify how dirty regions are processed.

See Also:   org.eclipse.jface.text.IDocumentListener
See Also:   org.eclipse.jface.text.ITextInputListener
See Also:   org.eclipse.jface.text.reconciler.DirtyRegion
since:
   2.0

Inner Class :class BackgroundThread extends Thread
Inner Class :class Listener implements IDocumentListener,ITextInputListener

Constructor Summary
protected AbstractReconciler()
     Creates a new reconciler without configuring it.

Method Summary
protected void aboutToBeReconciled()
     Hook for subclasses which want to perform some action as soon as reconciliation is needed.
protected void forceReconciling()
     Forces the reconciler to reconcile the structure of the whole document.
protected IDocument getDocument()
     Returns the input document of the text viewer this reconciler is installed on.
protected IProgressMonitor getProgressMonitor()
     Returns the progress monitor of this reconciler.
protected ITextViewer getTextViewer()
     Returns the text viewer this reconciler is installed on.
protected void initialProcess()
     This method is called on startup of the background activity.
public void install(ITextViewer textViewer)

protected boolean isIncrementalReconciler()
     Returns whether any of the reconciling strategies is interested in detailed dirty region information.
abstract protected void process(DirtyRegion dirtyRegion)
     Processes a dirty region.
abstract protected void 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 reconcilerReset()
     Hook that is called after the reconciler thread has been reset.
public void setDelay(int delay)
     Tells the reconciler how long it should wait for further text changes before activating the appropriate reconciling strategies.
public void setIsAllowedToModifyDocument(boolean isAllowedToModify)
     Tells the reconciler whether it is allowed to change the document inside its reconciler thread.
public void setIsIncrementalReconciler(boolean isIncremental)
     Tells the reconciler whether any of the available reconciling strategies is interested in getting detailed dirty region information or just in the fact that the document has been changed.
public void setProgressMonitor(IProgressMonitor monitor)
     Sets the progress monitor of this reconciler.
protected synchronized void startReconciling()
     Starts the reconciler to reconcile the queued dirty-regions.
public void uninstall()


Constructor Detail
AbstractReconciler
protected AbstractReconciler()(Code)
Creates a new reconciler without configuring it.

Method Detail
aboutToBeReconciled
protected void aboutToBeReconciled()(Code)
Hook for subclasses which want to perform some action as soon as reconciliation is needed.
Default implementation is to do nothing.

since:
   3.0

forceReconciling
protected void forceReconciling()(Code)
Forces the reconciler to reconcile the structure of the whole document. Clients may extend this method.

getDocument
protected IDocument getDocument()(Code)
Returns the input document of the text viewer this reconciler is installed on. the reconciler document

getProgressMonitor
protected IProgressMonitor getProgressMonitor()(Code)
Returns the progress monitor of this reconciler. the progress monitor of this reconciler

getTextViewer
protected ITextViewer getTextViewer()(Code)
Returns the text viewer this reconciler is installed on. the text viewer this reconciler is installed on

initialProcess
protected void initialProcess()(Code)
This method is called on startup of the background activity. It is called only once during the life time of the reconciler. Clients may reimplement this method.

install
public void install(ITextViewer textViewer)(Code)

isIncrementalReconciler
protected boolean isIncrementalReconciler()(Code)
Returns whether any of the reconciling strategies is interested in detailed dirty region information. whether this reconciler is incremental
See Also:   IReconcilingStrategy

process
abstract protected void process(DirtyRegion dirtyRegion)(Code)
Processes a dirty region. If the dirty region is 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.
Parameters:
  dirtyRegion - the dirty region to be processed

reconcilerDocumentChanged
abstract protected void reconcilerDocumentChanged(IDocument newDocument)(Code)
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. Usually, subclasses use this hook to inform all their reconciling strategies about the change.
Parameters:
  newDocument - the new reconciler document

reconcilerReset
protected void reconcilerReset()(Code)
Hook that is called after the reconciler thread has been reset.

setDelay
public void setDelay(int delay)(Code)
Tells the reconciler how long it should wait for further text changes before activating the appropriate reconciling strategies.
Parameters:
  delay - the duration in milliseconds of a change collection period.

setIsAllowedToModifyDocument
public void setIsAllowedToModifyDocument(boolean isAllowedToModify)(Code)
Tells the reconciler whether it is allowed to change the document inside its reconciler thread.
If this is set to false an UnsupportedOperationException will be thrown when this restriction will be violated.

Parameters:
  isAllowedToModify - indicates whether this reconciler is allowed to modify the document
since:
   3.2

setIsIncrementalReconciler
public void setIsIncrementalReconciler(boolean isIncremental)(Code)
Tells the reconciler whether any of the available reconciling strategies is interested in getting detailed dirty region information or just in the fact that the document has been changed. In the second case, the reconciling can not incrementally be pursued.
Parameters:
  isIncremental - indicates whether this reconciler will be configured withincremental reconciling strategies
See Also:   DirtyRegion
See Also:   IReconcilingStrategy

setProgressMonitor
public void setProgressMonitor(IProgressMonitor monitor)(Code)
Sets the progress monitor of this reconciler.
Parameters:
  monitor - the monitor to be used

startReconciling
protected synchronized void startReconciling()(Code)
Starts the reconciler to reconcile the queued dirty-regions. Clients may extend this method.

uninstall
public void uninstall()(Code)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.