net.thevpc.jeep.editor

Class JSyntaxDocument

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.DefaultStyledDocument

net.thevpc.jeep.editor.JSyntaxDocument

All Implemented Interfaces:

Serializable, Document, StyledDocument

public class JSyntaxDocument
extends DefaultStyledDocument

A document that supports being highlighted. The document maintains an internal List of all the Tokens. The Tokens are updated using a Lexer, passed to it during construction.

Author:

Ayman Al-Sairafi

See Also:

Serialized Form

Nested Class Summary

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

DefaultStyledDocument.AttributeUndoableEdit, DefaultStyledDocument.ElementBuffer, DefaultStyledDocument.ElementSpec, DefaultStyledDocument.SectionElement

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

AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement

Field Summary

Fields inherited from class javax.swing.text.DefaultStyledDocument

buffer, BUFFER_SIZE_DEFAULT

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
JSyntaxDocument(net.thevpc.jeep.JContext jcontext)

Method Summary

Modifier and Type	Method and Description
void	clearUndos() This will discard all undoable edits
void	doRedo() Perform a redo action, if possible.
void	doUndo() Perform an undo action, if possible
protected void	fireChangedUpdate(DocumentEvent e)
protected void	fireInsertUpdate(DocumentEvent e)
protected void	fireRemoveUpdate(DocumentEvent e)
protected void	fireUndoableEditUpdate(UndoableEditEvent e)
int	getLineCount() Return the number of lines in this document
int	getLineEndOffset(int pos) Returns the end position of the line at pos.
int	getLineNumberAt(int pos) Return the line number at given position.
int	getLineStartOffset(int pos) Returns the starting position of the line at pos
net.thevpc.jeep.JToken	getPairFor(net.thevpc.jeep.JToken t) This is used to return the other part of a paired token in the document.
net.thevpc.jeep.JToken	getTokenAt(int pos) Find the token at a given position.
Iterator<net.thevpc.jeep.JToken>	getTokens(int start, int end) Return an iterator of tokens between p0 and p1.
UndoManager	getUndoManager()
void	replaceToken(net.thevpc.jeep.JToken token, String replacement) Replace the token with the replacement string
String	toString()

Methods inherited from class javax.swing.text.DefaultStyledDocument

addDocumentListener, addStyle, create, createDefaultRoot, getBackground, getCharacterElement, getDefaultRootElement, getFont, getForeground, getLogicalStyle, getParagraphElement, getStyle, getStyleNames, insert, insertUpdate, removeDocumentListener, removeElement, removeStyle, removeUpdate, setCharacterAttributes, setLogicalStyle, setParagraphAttributes, styleChanged

Methods inherited from class javax.swing.text.AbstractDocument

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.text.Document

addUndoableEditListener, createPosition, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, insertString, putProperty, remove, removeUndoableEditListener, render

Constructor Detail

JSyntaxDocument

public JSyntaxDocument(net.thevpc.jeep.JContext jcontext)

Method Detail

getUndoManager

public UndoManager getUndoManager()

fireChangedUpdate

protected void fireChangedUpdate(DocumentEvent e)

Overrides:

fireChangedUpdate in class AbstractDocument

fireInsertUpdate

protected void fireInsertUpdate(DocumentEvent e)

Overrides:

fireInsertUpdate in class AbstractDocument

fireRemoveUpdate

protected void fireRemoveUpdate(DocumentEvent e)

Overrides:

fireRemoveUpdate in class AbstractDocument

fireUndoableEditUpdate

protected void fireUndoableEditUpdate(UndoableEditEvent e)

Overrides:

fireUndoableEditUpdate in class AbstractDocument

replaceToken

public void replaceToken(net.thevpc.jeep.JToken token,
                         String replacement)

Replace the token with the replacement string

Parameters:

token -

replacement -

getTokens

public Iterator<net.thevpc.jeep.JToken> getTokens(int start,
                                                  int end)

Return an iterator of tokens between p0 and p1.

Parameters:

start - start position for getting tokens

end - position for last token

Returns:

Iterator for tokens that overal with range from start to end

getTokenAt

public net.thevpc.jeep.JToken getTokenAt(int pos)

Find the token at a given position. May return null if no token is found (whitespace skipped) or if the position is out of range:

Parameters:

pos -

Returns:

getPairFor

public net.thevpc.jeep.JToken getPairFor(net.thevpc.jeep.JToken t)

This is used to return the other part of a paired token in the document. A paired part has token.pairValue <> 0, and the paired token will have the negative of t.pairValue. This method properly handles nesting of same pairValues, but overlaps are not checked. if The document does not contain a paired

Parameters:

t -

Returns:

the other pair's token, or null if nothing is found.

doUndo

public void doUndo()

Perform an undo action, if possible

doRedo

public void doRedo()

Perform a redo action, if possible.

getLineStartOffset

public int getLineStartOffset(int pos)

Returns the starting position of the line at pos

Parameters:

pos -

Returns:

starting position of the line

getLineEndOffset

public int getLineEndOffset(int pos)

Returns the end position of the line at pos. Does a bounds check to ensure the returned value does not exceed document length

Parameters:

pos -

Returns:

getLineCount

public int getLineCount()

Return the number of lines in this document

Returns:

getLineNumberAt

public int getLineNumberAt(int pos)

Return the line number at given position. The line numbers are zero based

Parameters:

pos -

Returns:

clearUndos

public void clearUndos()

This will discard all undoable edits

toString

public String toString()

Overrides:

toString in class Object