View Javadoc

1   /*
2    *  jDTAUS Banking Utilities
3    *  Copyright (C) 2005 Christian Schulte
4    *  <cs@schulte.it>
5    *
6    *  This library is free software; you can redistribute it and/or
7    *  modify it under the terms of the GNU Lesser General Public
8    *  License as published by the Free Software Foundation; either
9    *  version 2.1 of the License, or any later version.
10   *
11   *  This library is distributed in the hope that it will be useful,
12   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   *  Lesser General Public License for more details.
15   *
16   *  You should have received a copy of the GNU Lesser General Public
17   *  License along with this library; if not, write to the Free Software
18   *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19   *
20   */
21  package org.jdtaus.banking.util.swing;
22  
23  import java.text.ParseException;
24  import javax.swing.JFormattedTextField;
25  import javax.swing.JFormattedTextField.AbstractFormatter;
26  import javax.swing.text.AttributeSet;
27  import javax.swing.text.BadLocationException;
28  import javax.swing.text.DocumentFilter;
29  import javax.swing.text.DocumentFilter.FilterBypass;
30  import org.jdtaus.banking.Referenznummer10;
31  import org.jdtaus.core.container.ContainerFactory;
32  import org.jdtaus.core.container.PropertyException;
33  
34  /**
35   * {@code JFormattedTextField} supporting the {@code Referenznummer10} type.
36   * <p>This textfield uses the {@link Referenznummer10} type for parsing and formatting. An empty string value is treated
37   * as {@code null}. Property {@code format} controls formatting and takes one of the format constants defined in class
38   * {@code Referenznummer10}. By default the {@code ELECTRONIC_FORMAT} is used. The {@code validating} flag controls
39   * validation of values entered into the textfield. If {@code true} (default), a {@code DocumentFilter} is registered
40   * with the textfield disallowing invalid values, that is, values which are not {@code null} and not empty strings and
41   * for which the {@link Referenznummer10#parse(String)} method throws a {@code ParseException}.</p>
42   *
43   * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
44   * @version $JDTAUS: Referenznummer10TextField.java 8661 2012-09-27 11:29:58Z schulte $
45   */
46  public final class Referenznummer10TextField extends JFormattedTextField
47  {
48  
49      /** Serial version UID for backwards compatibility with 1.1.x classes. */
50      private static final long serialVersionUID = -7966250999405224485L;
51  
52      /**
53       * Format used when formatting Referenznummer10 instances.
54       * @serial
55       */
56      private Integer format;
57  
58      /**
59       * Flag indicating if validation is performed.
60       * @serial
61       */
62      private Boolean validating;
63  
64      /** Creates a new default {@code Referenznummer10TextField} instance. */
65      public Referenznummer10TextField()
66      {
67          super();
68          this.assertValidProperties();
69          this.setColumns( Referenznummer10.MAX_CHARACTERS );
70          this.setFormatterFactory( new AbstractFormatterFactory()
71          {
72  
73              public AbstractFormatter getFormatter( final JFormattedTextField ftf )
74              {
75                  return new AbstractFormatter()
76                  {
77  
78                      public Object stringToValue( final String text ) throws ParseException
79                      {
80                          Object value = null;
81  
82                          if ( text != null && text.trim().length() > 0 )
83                          {
84                              value = Referenznummer10.parse( text );
85                          }
86  
87                          return value;
88                      }
89  
90                      public String valueToString( final Object value ) throws ParseException
91                      {
92                          String ret = null;
93  
94                          if ( value instanceof Referenznummer10 )
95                          {
96                              final Referenznummer10 ref = (Referenznummer10) value;
97                              ret = ref.format( getFormat() );
98                          }
99  
100                         return ret;
101                     }
102 
103                     protected DocumentFilter getDocumentFilter()
104                     {
105                         return new DocumentFilter()
106                         {
107 
108                             public void insertString( final FilterBypass fb, final int o, String s,
109                                                       final AttributeSet a ) throws BadLocationException
110                             {
111                                 if ( isValidating() )
112                                 {
113                                     final StringBuffer b = new StringBuffer( fb.getDocument().getLength() + s.length() );
114                                     b.append( fb.getDocument().getText( 0, fb.getDocument().getLength() ) );
115                                     b.insert( o, s );
116 
117                                     try
118                                     {
119                                         Referenznummer10.parse( b.toString() );
120                                     }
121                                     catch ( ParseException e )
122                                     {
123                                         invalidEdit();
124                                         return;
125                                     }
126                                 }
127 
128                                 super.insertString( fb, o, s, a );
129                             }
130 
131                             public void replace( final FilterBypass fb, final int o, final int l, String s,
132                                                  final AttributeSet a ) throws BadLocationException
133                             {
134                                 if ( isValidating() )
135                                 {
136                                     final StringBuffer b = new StringBuffer( fb.getDocument().getLength() + s.length() );
137                                     b.append( fb.getDocument().getText( 0, fb.getDocument().getLength() ) );
138                                     b.replace( o, o + s.length(), s );
139 
140                                     try
141                                     {
142                                         Referenznummer10.parse( b.toString() );
143                                     }
144                                     catch ( ParseException e )
145                                     {
146                                         invalidEdit();
147                                         return;
148                                     }
149                                 }
150 
151                                 super.replace( fb, o, l, s, a );
152                             }
153 
154                         };
155                     }
156 
157                 };
158             }
159 
160         } );
161     }
162 
163     /**
164      * Gets the last valid {@code Referenznummer10}.
165      *
166      * @return the last valid {@code Referenznummer10} or {@code null}.
167      */
168     public Referenznummer10 getReferenznummer10()
169     {
170         return (Referenznummer10) this.getValue();
171     }
172 
173     /**
174      * Gets the constant of the format used when formatting Referenznummer10 instances.
175      *
176      * @return the constant of the format used when formatting Referenznummer10 instances.
177      *
178      * @see Referenznummer10#ELECTRONIC_FORMAT
179      * @see Referenznummer10#LETTER_FORMAT
180      */
181     public int getFormat()
182     {
183         if ( this.format == null )
184         {
185             this.format = this.getDefaultFormat();
186         }
187 
188         return this.format.intValue();
189     }
190 
191     /**
192      * Sets the constant of the format to use when formatting Referenznummer10 instances.
193      *
194      * @param value the constant of the format to use when formatting Referenznummer10 instances.
195      *
196      * @throws IllegalArgumentException if {@code format} is neither {@code ELECTRONIC_FORMAT} nor
197      * {@code LETTER_FORMAT}.
198      *
199      * @see Referenznummer10#ELECTRONIC_FORMAT
200      * @see Referenznummer10#LETTER_FORMAT
201      */
202     public void setFormat( final int value )
203     {
204         if ( value != Referenznummer10.ELECTRONIC_FORMAT && value != Referenznummer10.LETTER_FORMAT )
205         {
206             throw new IllegalArgumentException( Integer.toString( value ) );
207         }
208 
209         this.format = new Integer( value );
210     }
211 
212     /**
213      * Gets the flag indicating if validation should be performed.
214      *
215      * @return {@code true} if the field's value is validated; {@code false} if no validation of the field's value is
216      * performed.
217      */
218     public boolean isValidating()
219     {
220         if ( this.validating == null )
221         {
222             this.validating = this.isDefaultValidating();
223         }
224 
225         return this.validating.booleanValue();
226     }
227 
228     /**
229      * Sets the flag indicating if validation should be performed.
230      *
231      * @param value {@code true} to validate the field's value; {@code false} to not validate the field's value.
232      */
233     public void setValidating( boolean value )
234     {
235         this.validating = Boolean.valueOf( value );
236     }
237 
238     /**
239      * Checks configured properties.
240      *
241      * @throws PropertyException for invalid property values.
242      */
243     private void assertValidProperties()
244     {
245         if ( this.getFormat() != Referenznummer10.ELECTRONIC_FORMAT &&
246              this.getFormat() != Referenznummer10.LETTER_FORMAT )
247         {
248             throw new PropertyException( "format", Integer.toString( this.getFormat() ) );
249         }
250     }
251 
252     //--Properties--------------------------------------------------------------
253 
254 // <editor-fold defaultstate="collapsed" desc=" Generated Code ">//GEN-BEGIN:jdtausProperties
255     // This section is managed by jdtaus-container-mojo.
256 
257     /**
258      * Gets the value of property <code>defaultValidating</code>.
259      *
260      * @return Default value of the flag indicating if validation should be performed.
261      */
262     private java.lang.Boolean isDefaultValidating()
263     {
264         return (java.lang.Boolean) ContainerFactory.getContainer().
265             getProperty( this, "defaultValidating" );
266 
267     }
268 
269     /**
270      * Gets the value of property <code>defaultFormat</code>.
271      *
272      * @return Default value of the format to use when formatting Referenznummer10 instances (5001 = electronic format, 5002 letter format).
273      */
274     private java.lang.Integer getDefaultFormat()
275     {
276         return (java.lang.Integer) ContainerFactory.getContainer().
277             getProperty( this, "defaultFormat" );
278 
279     }
280 
281 // </editor-fold>//GEN-END:jdtausProperties
282 
283     //--------------------------------------------------------------Properties--
284 }