org.jeditor.core

Class SyntaxDocument

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.PlainDocument

org.jeditor.core.SyntaxDocument

All Implemented Interfaces:

java.io.Serializable, javax.swing.text.Document

public class SyntaxDocument
extends javax.swing.text.PlainDocument

A document implementation that can be tokenized by the syntax highlighting system.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.text.AbstractDocument

javax.swing.text.AbstractDocument.AbstractElement, javax.swing.text.AbstractDocument.AttributeContext, javax.swing.text.AbstractDocument.BranchElement, javax.swing.text.AbstractDocument.Content, javax.swing.text.AbstractDocument.DefaultDocumentEvent, javax.swing.text.AbstractDocument.ElementEdit, javax.swing.text.AbstractDocument.LeafElement

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	editable True if the document is editable.
protected javax.swing.undo.UndoManager	manager The document UndoManager.
protected TokenMarker	tokenMarker The document TokenMarker.

Fields inherited from class javax.swing.text.PlainDocument

lineLimitAttribute, tabSizeAttribute

Fields inherited from class javax.swing.text.AbstractDocument

BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName

Fields inherited from interface javax.swing.text.Document

StreamDescriptionProperty, TitleProperty

Constructor Summary

Constructors

Constructor and Description
SyntaxDocument()

Method Summary

Modifier and Type	Method and Description
protected void	fireInsertUpdate(javax.swing.event.DocumentEvent evt) We overwrite this method to update the token marker state immediately so that any event listeners get a consistent token marker.
protected void	fireRemoveUpdate(javax.swing.event.DocumentEvent evt) We overwrite this method to update the token marker state immediately so that any event listeners get a consistent token marker.
int	getLineOfOffset(int offset) Returns the line containing the specified offset.
TokenMarker	getTokenMarker() Returns the token marker that is to be used to split lines of this document up into tokens.
javax.swing.undo.UndoManager	getUndoManager() Return the document UndoManager.
void	insertString(int offs, java.lang.String string, javax.swing.text.AttributeSet a)
void	remove(int offs, int length)
void	setEditable(boolean editable) Set if the document is editable.
void	setTokenMarker(TokenMarker tm) Sets the token marker that is to be used to split lines of this document up into tokens.
void	tokenizeLines() Reparses the document, by passing all lines to the token marker.
void	tokenizeLines(boolean forceMultiline) Reparses the document, by passing all lines to the token marker.
void	tokenizeLines(int start, int len) Reparses the document, by passing the specified lines to the token marker.
void	tokenizeLines(int start, int len, boolean forceMultiline) Reparses the document, by passing the specified lines to the token marker.

Methods inherited from class javax.swing.text.PlainDocument

createDefaultRoot, getDefaultRootElement, getParagraphElement, insertUpdate, removeUpdate

Methods inherited from class javax.swing.text.AbstractDocument

addDocumentListener, addUndoableEditListener, createBranchElement, createLeafElement, createPosition, dump, fireChangedUpdate, fireUndoableEditUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, postRemoveUpdate, putProperty, readLock, readUnlock, removeDocumentListener, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

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

Field Detail

tokenMarker

protected TokenMarker tokenMarker

The document TokenMarker.

manager

protected javax.swing.undo.UndoManager manager

The document UndoManager.

editable

protected boolean editable

True if the document is editable.

Constructor Detail

SyntaxDocument

public SyntaxDocument()

Method Detail

setEditable

public void setEditable(boolean editable)

Set if the document is editable.

Parameters:

editable - true if the document is editable

getUndoManager

public javax.swing.undo.UndoManager getUndoManager()

Return the document UndoManager.

Returns:

the document UndoManager

getTokenMarker

public TokenMarker getTokenMarker()

Returns the token marker that is to be used to split lines of this document up into tokens. May return null if this document is not to be colorized.

Returns:

the token marker

insertString

public void insertString(int offs,
                         java.lang.String string,
                         javax.swing.text.AttributeSet a)
                  throws javax.swing.text.BadLocationException

Specified by:

insertString in interface javax.swing.text.Document

Overrides:

insertString in class javax.swing.text.PlainDocument

Throws:

javax.swing.text.BadLocationException

remove

public void remove(int offs,
                   int length)
            throws javax.swing.text.BadLocationException

Specified by:

remove in interface javax.swing.text.Document

Overrides:

remove in class javax.swing.text.AbstractDocument

Throws:

javax.swing.text.BadLocationException

getLineOfOffset

public final int getLineOfOffset(int offset)

Returns the line containing the specified offset.

Parameters:

offset - The offset

Returns:

the line number

setTokenMarker

public void setTokenMarker(TokenMarker tm)

Sets the token marker that is to be used to split lines of this document up into tokens. May throw an exception if this is not supported for this type of document.

Parameters:

tm - the new token marker

tokenizeLines

public void tokenizeLines()

Reparses the document, by passing all lines to the token marker. This should be called after the document is first loaded.

tokenizeLines

public void tokenizeLines(boolean forceMultiline)

Reparses the document, by passing all lines to the token marker. This should be called after the document is first loaded.

Parameters:

forceMultiline - true if the tokenization will be performed even if the Tokenmarker does not support multiline

tokenizeLines

public void tokenizeLines(int start,
                          int len)

Reparses the document, by passing the specified lines to the token marker. This should be called after a large quantity of text is first inserted.

Parameters:

start - The first line to parse

len - The number of lines, after the first one to parse

tokenizeLines

public void tokenizeLines(int start,
                          int len,
                          boolean forceMultiline)

Reparses the document, by passing the specified lines to the token marker. This should be called after a large quantity of text is first inserted.

Parameters:

start - The first line to parse

len - The number of lines, after the first one to parse

forceMultiline - true if the tokenization will be performed even if the Tokenmarker does not support multiline

fireInsertUpdate

protected void fireInsertUpdate(javax.swing.event.DocumentEvent evt)

We overwrite this method to update the token marker state immediately so that any event listeners get a consistent token marker.

Overrides:

fireInsertUpdate in class javax.swing.text.AbstractDocument

Parameters:

evt - the DocumentEvent

fireRemoveUpdate

protected void fireRemoveUpdate(javax.swing.event.DocumentEvent evt)

We overwrite this method to update the token marker state immediately so that any event listeners get a consistent token marker.

Overrides:

fireRemoveUpdate in class javax.swing.text.AbstractDocument

Parameters:

evt - the DocumentEvent