- java.lang.Object
-
- javax.swing.text.DocumentFilter
-
public class DocumentFilter extends Object
DocumentFilter
, as the name implies, is a filter for theDocument
mutation methods. When aDocument
containing aDocumentFilter
is modified (either throughinsert
orremove
), it forwards the appropriate method invocation to theDocumentFilter
. 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 inFilterBypass
. Subclasses should NOT call back into the Document for the modification instead call into the superclass or theFilterBypass
.When
remove
orinsertString
is invoked on theDocumentFilter
, theDocumentFilter
may callback into theFilterBypass
multiple times, or for different regions, but it should not callback into theFilterBypass
after returning from theremove
orinsertString
method.By default, text related document mutation methods such as
insertString
,replace
andremove
inAbstractDocument
useDocumentFilter
when available, andElement
related mutation methods such ascreate
,insert
andremoveElement
inDefaultStyledDocument
do not useDocumentFilter
. If a method doesn't follow these defaults, this must be explicitly stated in the method documentation.- Since:
- 1.4
- See Also:
Document
,AbstractDocument
,DefaultStyledDocument
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
DocumentFilter.FilterBypass
Used as a way to circumvent calling back into the Document to change it.
-
Constructor Summary
Constructors Constructor and Description DocumentFilter()
-
Method Summary
Methods Modifier and Type Method and Description void
insertString(DocumentFilter.FilterBypass fb, int offset, String string, AttributeSet attr)
Invoked prior to insertion of text into the specified Document.void
remove(DocumentFilter.FilterBypass fb, int offset, int length)
Invoked prior to removal of the specified region in the specified Document.void
replace(DocumentFilter.FilterBypass fb, int offset, int length, String text, AttributeSet attrs)
Invoked prior to replacing a region of text in the specified Document.
-
-
-
Method Detail
-
remove
public void remove(DocumentFilter.FilterBypass fb, int offset, int length) throws BadLocationException
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 theFilterBypass
as necessary.- Parameters:
fb
- FilterBypass that can be used to mutate Documentoffset
- the offset from the beginning >= 0length
- 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 void insertString(DocumentFilter.FilterBypass fb, int offset, String string, AttributeSet attr) throws BadLocationException
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 Documentoffset
- 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 insertattr
- 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 void replace(DocumentFilter.FilterBypass fb, int offset, int length, String text, AttributeSet attrs) throws BadLocationException
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 Documentoffset
- Location in Documentlength
- Length of text to deletetext
- Text to insert, null indicates no text to insertattrs
- AttributeSet indicating attributes of inserted text, null is legal.- Throws:
BadLocationException
- the given insert position is not a valid position within the document
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
05/11/2024 16:30:20 Cette version de la page est en cache (à la date du 05/11/2024 16:30:20) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 30/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/swing/text/DocumentFilter.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.