View Javadoc

1   /*
2    * Copyright 2006-2008 The Kuali Foundation
3    * 
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    * http://www.opensource.org/licenses/ecl2.php
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.kuali.rice.kns.datadictionary.control;
18  
19  
20  /**
21                          The currency element defines an HTML text control for
22                          entering dollar and cents amounts.  Only two decimals to
23                          the right of the decimal point are allowed.  Formatted
24                          value is displayed with commas.
25                          
26                          Used Properties: size, formattedMaxLength
27   */
28  @Deprecated
29  public class CurrencyControlDefinition extends ControlDefinitionBase {
30      private static final long serialVersionUID = 1650000676894176080L;
31      
32  	/**
33       * the maxLength for text that has been formatted. ie if maxLength=5. [12345]. but after going through the formatter the value
34       * is [12,345.00] and will no longer fit in a field whos maxLength=5. formattedMaxLength solves this problem.
35       */
36      protected Integer formattedMaxLength;
37  
38      public CurrencyControlDefinition() {
39      }
40  
41      /**
42       * 
43       * @see org.kuali.rice.krad.datadictionary.control.ControlDefinition#isCurrency()
44       */
45      public boolean isCurrency() {
46          return true;
47      }
48  
49      /**
50       * @see java.lang.Object#toString()
51       */
52      public String toString() {
53          return "CurrencyControlDefinition";
54      }
55  
56      /**
57       * @return Returns the formattedMaxLength parameter for currency controls.
58       */
59      public Integer getFormattedMaxLength() {
60          return formattedMaxLength;
61      }
62  
63      /**
64       * the maxLength for text that has been formatted. ie if maxLength=5. [12345]. but after going through the formatter the value
65       * is [12,345.00] and will no longer fit in a field whos maxLength=5. formattedMaxLength solves this problem.
66       */
67      public void setFormattedMaxLength(Integer formattedMaxLength) {
68          this.formattedMaxLength = formattedMaxLength;
69      }
70  
71  }