Class RegularExpressionDocument

  • All Implemented Interfaces:
    java.io.Serializable, javax.swing.text.Document
    Direct Known Subclasses:
    NumberValuesDocument

    public class RegularExpressionDocument
    extends javax.swing.text.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

        javax.swing.text.AbstractDocument.AbstractElement, javax.swing.text.AbstractDocument.AttributeContext, javax.swing.text.AbstractDocument.BranchElement, javax.swing.text.AbstractDocument.Content, javax.swing.text.AbstractDocument.DefaultDocumentEvent, javax.swing.text.AbstractDocument.ElementEdit, javax.swing.text.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
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void insertString​(int offset, java.lang.String string, javax.swing.text.AttributeSet attributes)
      void remove​(int offset, int length)
      java.lang.String validate​(java.lang.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 java.lang.String regex)
        Instantiates a new RegularExpressionDocument object.
        Parameters:
        regex - the regular expression
    • Method Detail

      • insertString

        public void insertString​(int offset,
                                 java.lang.String string,
                                 javax.swing.text.AttributeSet attributes)
                          throws javax.swing.text.BadLocationException
        Specified by:
        insertString in interface javax.swing.text.Document
        Overrides:
        insertString in class javax.swing.text.PlainDocument
        Throws:
        javax.swing.text.BadLocationException
      • remove

        public void remove​(int offset,
                           int length)
                    throws javax.swing.text.BadLocationException
        Specified by:
        remove in interface javax.swing.text.Document
        Overrides:
        remove in class javax.swing.text.AbstractDocument
        Throws:
        javax.swing.text.BadLocationException
      • validate

        public java.lang.String validate​(java.lang.String proposedValue)
                                  throws java.lang.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:
        java.lang.IllegalArgumentException - if the validation fails