DocumentFilter JDK 1.6)

Description

public class DocumentFilter

DocumentFilter, as the name implies, is a filter for the Document mutation methods.

DocumentFilter, as the name implies, is a filter for the Document mutation methods. When a Document containing a DocumentFilter is modified (either through insert or remove), it forwards the appropriate method invocation to the DocumentFilter. The default implementation allows the modification to occur. Subclasses can filter the modifications by conditionally invoking methods on the superclass, or invoking the necessary methods on the passed in FilterBypass. Subclasses should NOT call back into the Document for the modification instead call into the superclass or the FilterBypass.

When remove or insertString is invoked on the DocumentFilter, the DocumentFilter may callback into the FilterBypass multiple times, or for different regions, but it should not callback into the FilterBypass after returning from the remove or insertString method.

See also: Document

Methods

Hide/Show inherited methods

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

Invoked prior to insertion of text into the specified Document.

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

Invoked prior to removal of the specified region in the specified Document.

Invoked prior to removal of the specified region in the
specified Document. Subclasses that want to conditionally allow
removal should override this and only call supers implementation as
necessary, or call directly into the FilterBypass as
necessary.
Parameters:
- fb - FilterBypass that can be used to mutate Document
- 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 void replace (FilterBypass fb, int offset, int length, String text, AttributeSet attrs) throws BadLocationException

Invoked prior to replacing a region of text in the specified Document.