de.alpharogroup.swing.document

Class RegularExpressionDocument

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.PlainDocument

de.alpharogroup.swing.document.RegularExpressionDocument

All Implemented Interfaces:

Serializable, Document

Direct Known Subclasses:

NumberValuesDocument

public class RegularExpressionDocument
extends PlainDocument

The class RegularExpressionDocument can take any character that is specified in the given regular expression

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.text.AbstractDocument

AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement

Field Summary

Fields inherited from class javax.swing.text.PlainDocument

lineLimitAttribute, tabSizeAttribute

Fields inherited from class javax.swing.text.AbstractDocument

BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName

Fields inherited from interface javax.swing.text.Document

StreamDescriptionProperty, TitleProperty

Constructor Summary

Constructors

Constructor and Description
RegularExpressionDocument(@NonNull String regex) Instantiates a new RegularExpressionDocument object.

Method Summary

Modifier and Type	Method and Description
void	insertString(int offset, String string, AttributeSet attributes)
void	remove(int offset, int length)
String	validate(String proposedValue) Validate the given value by this RegularExpressionDocument object

Methods inherited from class javax.swing.text.PlainDocument

createDefaultRoot, getDefaultRootElement, getParagraphElement, insertUpdate, removeUpdate

Methods inherited from class javax.swing.text.AbstractDocument

addDocumentListener, addUndoableEditListener, createBranchElement, createLeafElement, createPosition, dump, fireChangedUpdate, fireInsertUpdate, fireRemoveUpdate, fireUndoableEditUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, postRemoveUpdate, putProperty, readLock, readUnlock, removeDocumentListener, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegularExpressionDocument

public RegularExpressionDocument(@NonNull
                                 @NonNull String regex)

Instantiates a new RegularExpressionDocument object.

Parameters:

regex - the regular expression

Method Detail

insertString

public void insertString(int offset,
                         String string,
                         AttributeSet attributes)
                  throws BadLocationException

Specified by:

insertString in interface Document

Overrides:

insertString in class PlainDocument

Throws:

BadLocationException

remove

public void remove(int offset,
                   int length)
            throws BadLocationException

Specified by:

remove in interface Document

Overrides:

remove in class AbstractDocument

Throws:

BadLocationException

validate

public String validate(String proposedValue)
                throws IllegalArgumentException

Validate the given value by this RegularExpressionDocument object

Parameters:

proposedValue - the proposed value

Returns:

the proposed value or throws an IllegalArgumentException if the validation fails

Throws:

IllegalArgumentException - if the validation fails