Examples of javax.swing.text.DocumentFilter

javax.swing.text.DocumentFilter

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 javax.swing.text.Document @see javax.swing.text.AbstractDocument @see javax.swing.text.DefaultStyledDocument @since 1.4

        if (!(doc instanceof AbstractDocument)) {
            throw new IllegalArgumentException("Specified document cannot be filtered!");
        }


        // set up the filter.
        ((AbstractDocument) doc).setDocumentFilter(new DocumentFilter() {
            @Override public void remove (FilterBypass fb, int offset, int length)
                throws BadLocationException
            {
                if (replaceOk(offset, length, "")) {
                    fb.remove(offset, length);

        // create a document filter which enforces the restrictions on
        // what text may be entered. This is similar to the filter
        // that is configured in SwingUtil.setDocumentHelpers, only the
        // remove operation is modified to do the sneaky highlighting we do.
        final IntDocument doc = (IntDocument) getDocument();
        doc.setDocumentFilter(new DocumentFilter() {
            @Override public void remove (FilterBypass fb, int offset, int length)
                throws BadLocationException
            {
                String current = doc.getText(0, doc.getLength());
                String potential = current.substring(0, offset) +

Examples of javax.swing.text.DocumentFilter

Related Classes of javax.swing.text.DocumentFilter