javax.swing.text
Class AbstractDocument.DefaultFilterBypass

java.lang.Object
  javax.swing.text.DocumentFilter.FilterBypass
      javax.swing.text.AbstractDocument.DefaultFilterBypass

Enclosing class:

AbstractDocument

private class AbstractDocument.DefaultFilterBypass

extends DocumentFilter.FilterBypass

Constructor Summary

private

AbstractDocument.DefaultFilterBypass()

Method Summary

Document	getDocument() Returns the Document the mutation is occuring on.
void	insertString(int offset, String string, AttributeSet attr) Inserts the specified text, bypassing the DocumentFilter.
void	remove(int offset, int length) Removes the specified region of text, bypassing the DocumentFilter.
void	replace(int offset, int length, String text, AttributeSet attrs) Deletes the region of text from offset to offset + length, and replaces it with text.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDocument.DefaultFilterBypass

private AbstractDocument.DefaultFilterBypass()

Method Detail

getDocument

public Document getDocument()

Description copied from class: DocumentFilter.FilterBypass

Returns the Document the mutation is occuring on.

Specified by:

getDocument in class DocumentFilter.FilterBypass

Returns:

Document that remove/insertString will operate on

remove

public void remove(int offset,
                   int length)
            throws BadLocationException

Description copied from class: DocumentFilter.FilterBypass

Removes the specified region of text, bypassing the DocumentFilter.

Specified by:

remove in class DocumentFilter.FilterBypass

Parameters:

offset - the offset from the beginning >= 0

length - the number of characters to remove >= 0

Throws:

BadLocationException - some portion of the removal range was not a valid part of the document. The location in the exception is the first bad position encountered.

insertString

public void insertString(int offset,
                         String string,
                         AttributeSet attr)
                  throws BadLocationException

Description copied from class: DocumentFilter.FilterBypass

Inserts the specified text, bypassing the DocumentFilter.

Specified by:

insertString in class DocumentFilter.FilterBypass

Parameters:

offset - the offset into the document to insert the content >= 0. All positions that track change at or after the given location will move.

string - the string to insert

attr - the attributes to associate with the inserted content. This may be null if there are no attributes.

Throws:

BadLocationException - the given insert position is not a valid position within the document

replace

public void replace(int offset,
                    int length,
                    String text,
                    AttributeSet attrs)
             throws BadLocationException

Description copied from class: DocumentFilter.FilterBypass

Deletes the region of text from offset to offset + length, and replaces it with text.

Specified by:

replace in class DocumentFilter.FilterBypass

Parameters:

offset - Location in Document

length - Length of text to delete

text - Text to insert, null indicates no text to insert

attrs - AttributeSet indicating attributes of inserted text, null is legal.

Throws:

BadLocationException - the given insert is not a valid position within the document