javax.swing.text

Class DocumentFilter.FilterBypass

Contents
  • Enclosing class:
    DocumentFilter

    public abstract static class DocumentFilter.FilterBypass
extends Object
    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.
    Since:
    1.4

    • Constructor Detail

      • DocumentFilter.FilterBypass

        public DocumentFilter.FilterBypass()

    • Method Detail

      • getDocument

        public abstract Document getDocument()
        Returns the Document the mutation is occuring on.
        Returns:
        Document that remove/insertString will operate on

      • remove

        public abstract void remove(int offset,
          int length)
                     throws BadLocationException
        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.

      • insertString

        public abstract void insertString(int offset,
                String string,
                AttributeSet attr)
                           throws BadLocationException
        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

      • replace

        public abstract void replace(int offset,
           int length,
           String string,
           AttributeSet attrs)
                      throws BadLocationException
        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

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/text/documentfilter.filterbypass.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut