org.bounce.text.xml

Class XMLDocument

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.PlainDocument

org.bounce.text.xml.XMLDocument

All Implemented Interfaces:

Serializable, Document

public class XMLDocument
extends PlainDocument

The XML Document is responsible for handling the user insertions and deletions, for changing the tab characters to spaces and to automatically indent the text correctly.

Note: The XML Editor package is based on the JavaEditorKit example as described in the article 'Customizing a Text Editor' by Timothy Prinzing . See: http://java.sun.com/products/jfc/tsc/articles/text/editor_kit/

Version:

$Revision: 1.2 $, $Date: 2005/03/28 13:46:07 $

Author:

Edwin Dankert

See Also:

Serialized Form

Nested Class Summary

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

Modifier and Type	Field and Description
static String	AUTO_INDENTATION_ATTRIBUTE Name of the attribute that specifies whether auto indentation is enabled.
static String	TAG_COMPLETION_ATTRIBUTE Name of the attribute that specifies whether tag-completion is enabled.

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
XMLDocument(JEditorPane editor) Constructs the XML Document with a new GapContent buffer.

Method Summary

Modifier and Type	Method and Description
void	insertString(int off, String str, AttributeSet set) Inserts some content into the document.

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, fireInsertUpdate, fireRemoveUpdate, 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

TAG_COMPLETION_ATTRIBUTE

public static final String TAG_COMPLETION_ATTRIBUTE

Name of the attribute that specifies whether tag-completion is enabled. The type for the value is Boolean.

See Also:

Constant Field Values

AUTO_INDENTATION_ATTRIBUTE

public static final String AUTO_INDENTATION_ATTRIBUTE

Name of the attribute that specifies whether auto indentation is enabled. The type for the value is Boolean.

See Also:

Constant Field Values

Constructor Detail

XMLDocument

public XMLDocument(JEditorPane editor)

Constructs the XML Document with a new GapContent buffer.

Parameters:

editor - the editor component.

Method Detail

insertString

public void insertString(int off,
                         String str,
                         AttributeSet set)
                  throws BadLocationException

Inserts some content into the document. When the content is a '>' character and it is the end of a start-tag and auto tag completion has been enabled, a new end-tag will be created. When the content is a new line character and auto indentation has been enabled, an indentation will be added to the content.

Specified by:

insertString in interface Document

Overrides:

insertString in class PlainDocument

Throws:

BadLocationException

See Also:

PlainDocument.insertString( int, String, AttributeSet)