HiRISE.HiPlan.Utilities

Class Comment_Document

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.PlainDocument

HiRISE.HiPlan.Utilities.Comment_Document

All Implemented Interfaces:

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

public class Comment_Document
extends javax.swing.text.PlainDocument

A plain document that converts input text into text suitable for the PTF comment field. Only ASCII characters between decimal 32 and decimal 126, inclusive, are allowed; other characters are removed from the input. Double-quotes are converted to single quotes, since the PTF format disallows double-quotes. Note that newlines and tabs are outside the allowed range.

Version:

1.4

Author:

Christian Schaller - UA/PIRL

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 and Description
static java.lang.String	ID Class identification name with source code version and date.

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
Comment_Document() Creates a new Comment_Document using the PlainDocument's default content container.
Comment_Document(javax.swing.text.AbstractDocument.Content container) Creates a new Comment_Document using the specified container for the document's content.

Method Summary

Modifier and Type	Method and Description
void	insertString(int offset, java.lang.String str, javax.swing.text.AttributeSet a) Inserts 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

ID

public static final java.lang.String ID

Class identification name with source code version and date.

See Also:

Constant Field Values

Constructor Detail

Comment_Document

public Comment_Document()

Creates a new Comment_Document using the PlainDocument's default content container.

See Also:

PlainDocument()

Comment_Document

public Comment_Document(javax.swing.text.AbstractDocument.Content container)

Creates a new Comment_Document using the specified container for the document's content.

Parameters:

container - the document's content container.

See Also:

PlainDocument(AbstractDocument.Content)

Method Detail

insertString

public void insertString(int offset,
                         java.lang.String str,
                         javax.swing.text.AttributeSet a)
                  throws javax.swing.text.BadLocationException

Inserts content into the document. Each whitespace character is replaced by a simple space.

Specified by:

insertString in interface javax.swing.text.Document

Overrides:

insertString in class javax.swing.text.PlainDocument

Parameters:

offset - the starting offset, at least 0.

str - the string to insert; null/empty strings are not inserted.

a - the attributes for the inserted content; this document does not use attributes.

Throws:

javax.swing.text.BadLocationException

See Also:

PlainDocument.insertString(int, java.lang.String, javax.swing.text.AttributeSet)