com.gargoylesoftware.base.util

Class DocumentUtil

public class DocumentUtil extends Object

Various utility methods relating to documents.

Version: $Revision: 1.4 $

Author: Mike Bowler

Nested Class Summary
static classDocumentUtil.LengthLimitedDocument
A wrapper document that prevents the user from typing more than a specified number of characters.
abstract static classDocumentUtil.PassthroughDocument
A document that merely passes all requests through to another document.
Constructor Summary
DocumentUtil()
Private constructor to prevent instantiation of this class.
Method Summary
static DocumentlengthLimitedDocument(Document document, int maxLength)
Return a wrapper document that prevents the user from typing more than a specified number of characters.
static DocumentlengthLimitedDocument(int maxLength)
Return a PlainDocument wrappered so that it is length limited.
static DocumentupperCaseDocument(Document document)
Return a wrapper document that converts all input to uppercase.
static DocumentupperCaseDocument()
Return a PlainDocument wrappered so that it accepts uppercase input only.

Constructor Detail

DocumentUtil

private DocumentUtil()
Private constructor to prevent instantiation of this class.

Method Detail

lengthLimitedDocument

public static Document lengthLimitedDocument(Document document, int maxLength)
Return a wrapper document that prevents the user from typing more than a specified number of characters.

Parameters: document The document to wrapper. maxLength The maximum number of characters that can be placed in this document.

Returns: The new wrapper document.

lengthLimitedDocument

public static Document lengthLimitedDocument(int maxLength)
Return a PlainDocument wrappered so that it is length limited.

Parameters: maxLength The maximum number of characters that can be placed in this document.

Returns: The new wrapper document.

upperCaseDocument

public static Document upperCaseDocument(Document document)
Return a wrapper document that converts all input to uppercase.

Parameters: document The document to wrapper.

Returns: The new wrapper document.

upperCaseDocument

public static Document upperCaseDocument()
Return a PlainDocument wrappered so that it accepts uppercase input only.

Returns: The new wrapper document.