|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.jface.text.ChildDocumentManager
Manages a set of child documents for given parent documents.
A child document represents a particular range of the parent
document and is accordingly adapted to changes of the parent document.
Vice versa, the parent document is accordingly adapted to changes of
its child documents. The manager does not maintain any particular management
structure but utilizes mechanisms given by IDocument
such
as position categories and position updaters.
For internal use only.
Field Summary | |
static String |
CHILDDOCUMENTS
Name of the position categories used to keep track of the child documents offset ranges into the parent document. |
Constructor Summary | |
ChildDocumentManager()
|
Method Summary | |
ChildDocument |
createChildDocument(IDocument parent,
int offset,
int length)
Creates and returns a new child document for the specified range of the given parent document. |
void |
documentAboutToBeChanged(DocumentEvent event)
The manipulation described by the document event will be performed. |
void |
documentChanged(DocumentEvent event)
The manipulation described by the document event has been performed. |
protected void |
fireDocumentEvent(boolean about,
DocumentEvent event)
Informs all child documents of the document which issued this document event. |
void |
freeChildDocument(ChildDocument childDocument)
Disconnects the given child document from it's parent document and frees all resources which are no longer needed. |
protected IPositionUpdater |
getChildPositionUpdater()
Returns the child position updater. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String CHILDDOCUMENTS
Constructor Detail |
public ChildDocumentManager()
Method Detail |
protected IPositionUpdater getChildPositionUpdater()
public ChildDocument createChildDocument(IDocument parent, int offset, int length) throws BadLocationException
parent
- the parent documentoffset
- the offset of the parent document rangelength
- the length of the parent document range
BadLocationException
- if the specified range is invalid in the parent documentpublic void freeChildDocument(ChildDocument childDocument)
childDocument
- the child document to be freedprotected void fireDocumentEvent(boolean about, DocumentEvent event)
about
- indicates whether the change is about to happen or alread happendevent
- the document event which will be processed to inform child documentspublic void documentChanged(DocumentEvent event)
IDocumentListener
documentChanged
in interface IDocumentListener
event
- the document event describing the document changepublic void documentAboutToBeChanged(DocumentEvent event)
IDocumentListener
documentAboutToBeChanged
in interface IDocumentListener
event
- the document event describing the document change
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |