public static abstract class

DocumentFilter.FilterBypass

extends Object
java.lang.Object
   ↳ javax.swing.text.DocumentFilter.FilterBypass

Class Overview

Used as a way to circumvent calling back into the Document to change it. Document implementations that wish to support a DocumentFilter must provide an implementation that will not callback into the DocumentFilter when the following methods are invoked from the DocumentFilter.

Summary

Public Constructors
DocumentFilter.FilterBypass()
Public Methods
abstract Document getDocument()
Returns the Document the mutation is occuring on.
abstract void insertString(int offset, String string, AttributeSet attr)
Inserts the specified text, bypassing the DocumentFilter.
abstract void remove(int offset, int length)
Removes the specified region of text, bypassing the DocumentFilter.
abstract void replace(int offset, int length, String string, AttributeSet attrs)
Deletes the region of text from offset to offset + length, and replaces it with text.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public DocumentFilter.FilterBypass ()

Public Methods

public abstract Document getDocument ()

Returns the Document the mutation is occuring on.

Returns
  • Document that remove/insertString will operate on

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

Inserts the specified text, bypassing the DocumentFilter.

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

public abstract void remove (int offset, int length)

Removes the specified region of text, bypassing the DocumentFilter.

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.

public abstract void replace (int offset, int length, String string, AttributeSet attrs)

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

Parameters
offset Location in Document
length Length of text to delete
string 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