edu.cmu.minorthird.text.gui
Class SpanDocument

java.lang.Object
  javax.swing.text.AbstractDocument
      javax.swing.text.DefaultStyledDocument
          edu.cmu.minorthird.text.gui.SpanDocument

All Implemented Interfaces:

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

public class SpanDocument
extends javax.swing.text.DefaultStyledDocument

A StyledDocument that holds a single span.

Author:

William Cohen

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.text.DefaultStyledDocument.AttributeUndoableEdit, javax.swing.text.DefaultStyledDocument.ElementBuffer, javax.swing.text.DefaultStyledDocument.ElementSpec, javax.swing.text.DefaultStyledDocument.SectionElement

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

SpanDocument()

SpanDocument(Span span)

SpanDocument(Span span, int contextWidth)

Method Summary

void	highlight(Span subspan, javax.swing.text.AttributeSet attributeSet) Highlight a subspan of the current span.
void	insertString(int off, java.lang.String s, javax.swing.text.AttributeSet attribs) Overrides default insertString, since insertions are not allowed.
void	remove(int off, int len) Overrides default insertString, since insertions are not allowed.
void	resetHighlights() Clear all highlights.
int	toLogicalCharIndex(int charIndex) Convert a character index in the text being displayed to a char index in the actual document which the display is a part of

Methods inherited from class javax.swing.text.DefaultStyledDocument

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

Methods inherited from class javax.swing.text.AbstractDocument

addUndoableEditListener, createBranchElement, createLeafElement, createPosition, dump, fireChangedUpdate, fireInsertUpdate, fireRemoveUpdate, fireUndoableEditUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, postRemoveUpdate, putProperty, readLock, readUnlock, 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

Methods inherited from interface javax.swing.text.Document

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

Constructor Detail

SpanDocument

public SpanDocument()

SpanDocument

public SpanDocument(Span span)

SpanDocument

public SpanDocument(Span span,
                    int contextWidth)

Method Detail

insertString

public void insertString(int off,
                         java.lang.String s,
                         javax.swing.text.AttributeSet attribs)
                  throws javax.swing.text.BadLocationException

Overrides default insertString, since insertions are not allowed.

Specified by:

insertString in interface javax.swing.text.Document

Overrides:

insertString in class javax.swing.text.AbstractDocument

Throws:

javax.swing.text.BadLocationException

remove

public void remove(int off,
                   int len)
            throws javax.swing.text.BadLocationException

Overrides default insertString, since insertions are not allowed.

Specified by:

remove in interface javax.swing.text.Document

Overrides:

remove in class javax.swing.text.AbstractDocument

Throws:

javax.swing.text.BadLocationException

resetHighlights

public void resetHighlights()

Clear all highlights.

toLogicalCharIndex

public int toLogicalCharIndex(int charIndex)

Convert a character index in the text being displayed to a char index in the actual document which the display is a part of

highlight

public void highlight(Span subspan,
                      javax.swing.text.AttributeSet attributeSet)

Highlight a subspan of the current span.