Package com.intellij.psi.impl

Class PsiToDocumentSynchronizer

java.lang.Object

com.intellij.psi.PsiTreeChangeAdapter

com.intellij.psi.impl.PsiToDocumentSynchronizer

All Implemented Interfaces:

PsiTreeChangeListener, java.util.EventListener

public class PsiToDocumentSynchronizer
extends PsiTreeChangeAdapter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PsiToDocumentSynchronizer.DocumentChangeTransaction

Method Summary

Modifier and Type	Method and Description
void	beforeChildAddition(PsiTreeChangeEvent event) Invoked just before adding a child to the tree. Parent element is returned by event.getParent(). Added child is returned by event.getChild.
void	beforeChildRemoval(PsiTreeChangeEvent event) Invoked just before removal of a child from the tree. Child to be removed is returned by event.getChild(). Parent element is returned by event.getParent().
void	beforeChildrenChange(PsiTreeChangeEvent event) Invoked before a mass change of children of the specified node. The parent the nodes of which are changing is returned by event.getParent().
void	beforeChildReplacement(PsiTreeChangeEvent event) Invoked just before replacement of a child in the tree by another element. Child to be replaced is returned by event.getOldChild(). Parent element is returned by event.getParent().
void	childAdded(PsiTreeChangeEvent event) Invoked just after adding of a new child to the tree. The added child is returned by event.getChild(). Parent element is returned by event.getParent().
void	childRemoved(PsiTreeChangeEvent event) Invoked just after removal of a child from the tree. The removed child is returned by event.getChild().
void	childrenChanged(PsiTreeChangeEvent event) Invoked after a mass change of children of the specified node. The parent the nodes of which have changed is returned by event.getParent().
void	childReplaced(PsiTreeChangeEvent event) Invoked just after replacement of a child in the tree by another element. The replaced child is returned by event.getOldChild().
boolean	commitTransaction(Document document)
PsiToDocumentSynchronizer.DocumentChangeTransaction	getTransaction(Document document)
void	insertString(Document document, int offset, java.lang.String s)
boolean	isDocumentAffectedByTransactions(Document document)
boolean	isIgnorePsiEvents()
boolean	isInSynchronization(Document document)
static void	performAtomically(PsiFile file, java.lang.Runnable runnable)
void	replaceString(Document document, int startOffset, int endOffset, java.lang.String s)
void	setIgnorePsiEvents(boolean ignorePsiEvents)
void	startTransaction(Project project, Document doc, PsiElement scope)
boolean	toProcessPsiEvent()

Methods inherited from class com.intellij.psi.PsiTreeChangeAdapter

beforeChildMovement, beforePropertyChange, childMoved, propertyChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTransaction

public PsiToDocumentSynchronizer.DocumentChangeTransaction getTransaction(Document document)

isInSynchronization

public boolean isInSynchronization(Document document)

performAtomically

public static void performAtomically(PsiFile file,
                                     java.lang.Runnable runnable)

beforeChildAddition

public void beforeChildAddition(PsiTreeChangeEvent event)

Description copied from interface: PsiTreeChangeListener

Invoked just before adding a child to the tree.
Parent element is returned by event.getParent().
Added child is returned by event.getChild.

Specified by:

beforeChildAddition in interface PsiTreeChangeListener

Overrides:

beforeChildAddition in class PsiTreeChangeAdapter

Parameters:

event - the event object describing the change.

beforeChildRemoval

public void beforeChildRemoval(PsiTreeChangeEvent event)

Description copied from interface: PsiTreeChangeListener

Invoked just before removal of a child from the tree.
Child to be removed is returned by event.getChild().
Parent element is returned by event.getParent().

Specified by:

beforeChildRemoval in interface PsiTreeChangeListener

Overrides:

beforeChildRemoval in class PsiTreeChangeAdapter

Parameters:

event - the event object describing the change.

beforeChildReplacement

public void beforeChildReplacement(PsiTreeChangeEvent event)

Description copied from interface: PsiTreeChangeListener

Invoked just before replacement of a child in the tree by another element.
Child to be replaced is returned by event.getOldChild().
Parent element is returned by event.getParent().

Specified by:

beforeChildReplacement in interface PsiTreeChangeListener

Overrides:

beforeChildReplacement in class PsiTreeChangeAdapter

Parameters:

event - the event object describing the change.

beforeChildrenChange

public void beforeChildrenChange(PsiTreeChangeEvent event)

Description copied from interface: PsiTreeChangeListener

Invoked before a mass change of children of the specified node.
The parent the nodes of which are changing is returned by event.getParent().

Specified by:

beforeChildrenChange in interface PsiTreeChangeListener

Overrides:

beforeChildrenChange in class PsiTreeChangeAdapter

Parameters:

event - the event object describing the change.

childAdded

public void childAdded(PsiTreeChangeEvent event)

Description copied from interface: PsiTreeChangeListener

Invoked just after adding of a new child to the tree.
The added child is returned by event.getChild().
Parent element is returned by event.getParent().

Specified by:

childAdded in interface PsiTreeChangeListener

Overrides:

childAdded in class PsiTreeChangeAdapter

Parameters:

event - the event object describing the change.

childRemoved

public void childRemoved(PsiTreeChangeEvent event)

Description copied from interface: PsiTreeChangeListener

Invoked just after removal of a child from the tree.
The removed child is returned by event.getChild(). Note that only equals(), hashCode(), isValid() methods can be safely invoked for this element, because it's not valid anymore.
Parent element is returned by event.getParent().

Specified by:

childRemoved in interface PsiTreeChangeListener

Overrides:

childRemoved in class PsiTreeChangeAdapter

Parameters:

event - the event object describing the change.

childReplaced

public void childReplaced(PsiTreeChangeEvent event)

Description copied from interface: PsiTreeChangeListener

Invoked just after replacement of a child in the tree by another element.
The replaced child is returned by event.getOldChild(). Note that only equals(), hashCode(), isValid() methods can be safely invoked for this element, because it's not valid anymore.
The new child is returned by event.getNewChild().
Parent element is returned by event.getParent().

Specified by:

childReplaced in interface PsiTreeChangeListener

Overrides:

childReplaced in class PsiTreeChangeAdapter

Parameters:

event - the event object describing the change.

childrenChanged

public void childrenChanged(PsiTreeChangeEvent event)

Description copied from interface: PsiTreeChangeListener

Invoked after a mass change of children of the specified node.
The parent the nodes of which have changed is returned by event.getParent().

Specified by:

childrenChanged in interface PsiTreeChangeListener

Overrides:

childrenChanged in class PsiTreeChangeAdapter

Parameters:

event - the event object describing the change.

setIgnorePsiEvents

public void setIgnorePsiEvents(boolean ignorePsiEvents)

isIgnorePsiEvents

public boolean isIgnorePsiEvents()

toProcessPsiEvent

public boolean toProcessPsiEvent()

replaceString

public void replaceString(Document document,
                          int startOffset,
                          int endOffset,
                          java.lang.String s)

insertString

public void insertString(Document document,
                         int offset,
                         java.lang.String s)

startTransaction

public void startTransaction(Project project,
                             Document doc,
                             PsiElement scope)

commitTransaction

public boolean commitTransaction(Document document)

isDocumentAffectedByTransactions

public boolean isDocumentAffectedByTransactions(Document document)