net.sourceforge.nite.gui.textviewer
Class NITEStyledDocument

java.lang.Object
  javax.swing.text.AbstractDocument
      javax.swing.text.DefaultStyledDocument
          net.sourceforge.nite.gui.textviewer.NITEStyledDocument

All Implemented Interfaces:

java.awt.print.Printable, java.io.Serializable, javax.swing.text.Document, javax.swing.text.StyledDocument

public class NITEStyledDocument
extends javax.swing.text.DefaultStyledDocument
implements java.awt.print.Printable

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

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_SIZE_DEFAULT

Fields inherited from class javax.swing.text.AbstractDocument

BidiElementName, ContentElementName, ElementNameAttribute, ParagraphElementName, SectionElementName

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface javax.swing.text.Document

StreamDescriptionProperty, TitleProperty

Constructor Summary

NITEStyledDocument(javax.swing.JTextPane jtp, javax.swing.text.StyleContext styles)

Method Summary

NTextElement	getElementAtPosition(int pos)
java.util.Set	getElementsAtTime(double time) Returns a set of NTextElements which are in time scope at the specified time
java.util.Set	getElementsBetweenPositions(int start, int end)
java.util.Set	getElementsBetweenTimes(double start, double end) Returns a set of NTextElements which are in time scope between the given start and end times
int	getTextElementPosition(NTextElement e)
void	indexElement(int offset, NTextElement te, int length) Insert an element at the end of the current document.
void	insertElement(int offset, NTextElement te, int length) This will insert an element in the middle of a NTextArea.
void	insertString(int offset, java.lang.String s, java.lang.String stylename, NTextElement te)
int	print(java.awt.Graphics pg, java.awt.print.PageFormat pageFormat, int pageIndex)
void	removeTextElement(NTextElement textelement) Method removeTextElement.
void	replaceText(NTextElement oldEl, java.lang.String newText) replace the text of an existing text element without removing the element
void	replaceTextElement(NTextElement oldEl, NTextElement newEl) replace the old text element with the new text element in the document

Methods inherited from class javax.swing.text.DefaultStyledDocument

addDocumentListener, addStyle, getBackground, getCharacterElement, getDefaultRootElement, getFont, getForeground, getLogicalStyle, getParagraphElement, getStyle, getStyleNames, removeDocumentListener, removeStyle, setCharacterAttributes, setLogicalStyle, setParagraphAttributes

Methods inherited from class javax.swing.text.AbstractDocument

addUndoableEditListener, createPosition, dump, getAsynchronousLoadPriority, getBidiRootElement, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, insertString, putProperty, readLock, readUnlock, remove, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties

Methods inherited from class java.lang.Object

equals, 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, insertString, putProperty, remove, removeUndoableEditListener, render

Constructor Detail

NITEStyledDocument

public NITEStyledDocument(javax.swing.JTextPane jtp,
                          javax.swing.text.StyleContext styles)

Method Detail

insertString

public void insertString(int offset,
                         java.lang.String s,
                         java.lang.String stylename,
                         NTextElement te)
                  throws javax.swing.text.BadLocationException

Throws:

javax.swing.text.BadLocationException

indexElement

public void indexElement(int offset,
                         NTextElement te,
                         int length)

Insert an element at the end of the current document. Faster than insertElement as it doesn't need to recalculate other elements' positions.

insertElement

public void insertElement(int offset,
                          NTextElement te,
                          int length)

This will insert an element in the middle of a NTextArea. It is very much slower than indexElement which adds the element at the end

replaceTextElement

public void replaceTextElement(NTextElement oldEl,
                               NTextElement newEl)

replace the old text element with the new text element in the document

replaceText

public void replaceText(NTextElement oldEl,
                        java.lang.String newText)

replace the text of an existing text element without removing the element

removeTextElement

public void removeTextElement(NTextElement textelement)

Method removeTextElement.

Parameters:

textelement -

getTextElementPosition

public int getTextElementPosition(NTextElement e)

getElementAtPosition

public NTextElement getElementAtPosition(int pos)

getElementsBetweenPositions

public java.util.Set getElementsBetweenPositions(int start,
                                                 int end)

getElementsAtTime

public java.util.Set getElementsAtTime(double time)

Returns a set of NTextElements which are in time scope at the specified time

getElementsBetweenTimes

public java.util.Set getElementsBetweenTimes(double start,
                                             double end)

Returns a set of NTextElements which are in time scope between the given start and end times

print

public int print(java.awt.Graphics pg,
                 java.awt.print.PageFormat pageFormat,
                 int pageIndex)
          throws java.awt.print.PrinterException

Specified by:

print in interface java.awt.print.Printable

Throws:

java.awt.print.PrinterException