- 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
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 04/03/2020
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-rf-javax/swing/text/DocumentFilter.html
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor Diese Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.