CaseDocumentFilter

java.lang.Object

javax.swing.text.DocumentFilter

is.codion.swing.common.ui.component.text.ValidationDocumentFilter<T>

is.codion.swing.common.ui.component.text.ParsingDocumentFilter<String>

is.codion.swing.common.ui.component.text.CaseDocumentFilter

public final class CaseDocumentFilter extends ParsingDocumentFilter<String>

A DocumentFilter implementation with automatic conversion to upper or lower case.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

CaseDocumentFilter.DocumentCase

Specifies possible case conversions for document text.

Nested classes/interfaces inherited from class javax.swing.text.DocumentFilter
DocumentFilter.FilterBypass
Method Summary

Modifier and Type

Method

Description

static CaseDocumentFilter

caseDocumentFilter()

Creates a new CaseDocumentFilter instance, configured with CaseDocumentFilter.DocumentCase.NONE

CaseDocumentFilter.DocumentCase

getDocumentCase()

CaseDocumentFilter

setDocumentCase(CaseDocumentFilter.DocumentCase documentCase)

protected String

transform(String string)

Perform any required transformation of the string, the resulting string must be of the same length as the original string.

Methods inherited from class is.codion.swing.common.ui.component.text.ParsingDocumentFilter
insertString, remove, replace

Methods inherited from class is.codion.swing.common.ui.component.text.ValidationDocumentFilter
addValidator, validate, validators

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- setDocumentCase
  
  public CaseDocumentFilter setDocumentCase(CaseDocumentFilter.DocumentCase documentCase)
  
  Parameters:
  
  documentCase - the document case setting
  
  Returns:
  
  this CaseDocumentFilter instance
- getDocumentCase
  
  public CaseDocumentFilter.DocumentCase getDocumentCase()
  
  Returns:
  
  the document case setting
- caseDocumentFilter
  
  public static CaseDocumentFilter caseDocumentFilter()
  
  Creates a new CaseDocumentFilter instance, configured with CaseDocumentFilter.DocumentCase.NONE
  
  Returns:
  
  a new CaseDocumentFilter instance
- transform
  
  protected String transform(String string)
  
  Description copied from class: ParsingDocumentFilter
  
  Perform any required transformation of the string, the resulting string must be of the same length as the original string. Returns the string unchanged by default.
  
  Overrides:
  
  transform in class ParsingDocumentFilter<String>
  
  Parameters:
  
  string - the string to transform
  
  Returns:
  
  the transformed string