Package com.inductiveautomation.ignition.client.jedittextarea

Class SyntaxDocument

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.PlainDocument

com.inductiveautomation.ignition.client.jedittextarea.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	Description
protected TokenMarker	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	Description
SyntaxDocument()

Method Summary

Modifier and Type	Method	Description
void	addUndoableEdit(javax.swing.undo.UndoableEdit edit)	Adds an undoable edit to this document's undo list.
void	beginCompoundEdit()	Starts a compound edit that can be undone in one operation.
void	endCompoundEdit()	Ends a compound edit that can be undone in one operation.
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.
TokenMarker	getTokenMarker()	Returns the token marker that is to be used to split lines of this document up into tokens.
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(int start, int len)	Reparses the document, by passing the specified lines to the token marker.

Methods inherited from class javax.swing.text.PlainDocument

createDefaultRoot, getDefaultRootElement, getParagraphElement, insertString, 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, remove, 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

Constructor Detail

SyntaxDocument

public SyntaxDocument()

Method Detail

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.

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(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

beginCompoundEdit

public void beginCompoundEdit()

Starts a compound edit that can be undone in one operation. Subclasses that implement undo should override this method; this class has no undo functionality so this method is empty.

endCompoundEdit

public void endCompoundEdit()

Ends a compound edit that can be undone in one operation. Subclasses that implement undo should override this method; this class has no undo functionality so this method is empty.

addUndoableEdit

public void addUndoableEdit(javax.swing.undo.UndoableEdit edit)

Adds an undoable edit to this document's undo list. The edit should be ignored if something is currently being undone.

Parameters:

edit - The undoable edit

Since:

jEdit 2.2pre1

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

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