| java.lang.Object
 javax.swing.text.DocumentFilter
| DocumentFilter | | public class DocumentFilter (Code) | | 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.
By default, text related document mutation methods such as
insertString, replace and remove
in AbstractDocument use DocumentFilter when
available, and Element related mutation methods such as
create, insert and removeElement in
DefaultStyledDocument do not use DocumentFilter.
If a method doesn't follow these defaults, this must be explicitly stated
in the method documentation.
See Also: javax.swing.text.Document
See Also: javax.swing.text.AbstractDocument
See Also: javax.swing.text.DefaultStyledDocument
version:
1.13 05/05/07
since:
1.4 |
| Inner Class :abstract public static class FilterBypass | |
| Method Summary | |
| public void | insertString(FilterBypass fb, int offset, String string, AttributeSet attr)
Invoked prior to insertion of text into the
specified Document. | | public void | remove(FilterBypass fb, int offset, int length)
Invoked prior to removal of the specified region in the
specified Document. | | public void | replace(FilterBypass fb, int offset, int length, String text, AttributeSet attrs)
Invoked prior to replacing a region of text in the
specified Document. |
| insertString | | public void insertString(FilterBypass fb, int offset, String string, AttributeSet attr) throws BadLocationException(Code) | | Invoked prior to insertion of text into the
specified Document. Subclasses that want to conditionally allow
insertion should override this and only call supers implementation as
necessary, or call directly into the FilterBypass.
Parameters:
fb - FilterBypass that can be used to mutate Document
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.
Parameters:
string - the string to insert
Parameters:
attr - the attributes to associate with the insertedcontent. This may be null if there are no attributes.
exception:
BadLocationException - the given insert position is not avalid position within the document |
| remove | | public void remove(FilterBypass fb, int offset, int length) throws BadLocationException(Code) | | 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
Parameters:
offset - the offset from the beginning >= 0
Parameters:
length - the number of characters to remove >= 0
exception:
BadLocationException - some portion of the removal rangewas not a valid part of the document. The location in the exceptionis the first bad position encountered. |
| replace | | public void replace(FilterBypass fb, int offset, int length, String text, AttributeSet attrs) throws BadLocationException(Code) | | Invoked prior to replacing a region of text in the
specified Document. Subclasses that want to conditionally allow
replace should override this and only call supers implementation as
necessary, or call directly into the FilterBypass.
Parameters:
fb - FilterBypass that can be used to mutate Document
Parameters:
offset - Location in Document
Parameters:
length - Length of text to delete
Parameters:
text - Text to insert, null indicates no text to insert
Parameters:
attrs - AttributeSet indicating attributes of inserted text,null is legal.
exception:
BadLocationException - the given insert position is not avalid position within the document |
|
|