Converts the ValueModel interface into the Document interface, which is the model interface for Swing text components. It is used to bind String values to text components, for example a JTextField. At construction time the document is updated with the subject's contents.
Instead of extending AbstractDocument or the specialized PlainDocument this class holds a reference to a Document instance and forwards all Document messages to the corresponding method in the reference. By default the delegate is initialized as an instance of PlainDocument; the two parameter constructor allows to provide any other Document implementation. The latter can be useful if the text component uses a custom Document, for example a custom IntegerDocument or MaskedDocument.
This DocumentAdapter provides limited support for handling subject value modifications while updating the subject. If a Document change initiates a subject value update, the subject will be observed and a property change fired by the subject will be handled - if any. In most cases, the subject will notify about a change to the text that was just set by this DocumentAdapter. However, in some cases the subject may decide to modify this text, for example to ensure upper case characters. Since at this moment, this adapter's Document is still write-locked, the Document update is performed later using SwingUtilities#invokeLater. Note: Such an update will typically change the Caret position in JTextField's and other JTextComponent's that use this DocumentAdapter as model. Hence, the subject value modifications can be used with commit-on-focus-lost text components, but typically not with a commit-on-key-typed component. For the latter case, you may consider using a custom DocumentFilter.
Constraints: The ValueModel must be of type String.
Examples:
ValueModel lastNameModel = new PropertyAdapter(customer, "lastName", true); JTextField lastNameField = new JTextField(); lastNameField.setDocument(new DocumentAdapter(lastNameModel)); ValueModel codeModel = new PropertyAdapter(shipment, "code", true); JTextField codeField = new JTextField(); codeField.setDocument(new DocumentAdapter(codeModel), new MaskedDocument(...));
@author Karsten Lentzsch
@version $Revision: 1.11 $
@see ValueModel
@see Document
@see PlainDocument Copyright (c) 2002-2005 JGoodies Karsten Lentzsch. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: o Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. o Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. o Neither the name of JGoodies Karsten Lentzsch nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.