View Javadoc
1   /**
2    * Copyright 2005-2015 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  package org.kuali.rice.kns.datadictionary.control;
17  
18  
19  /**
20   * The currency element defines an HTML text control for entering dollar and cents amounts.  Only two decimals to the
21   * right of the decimal point are allowed.  Formatted value is displayed with commas.
22   *
23   * Used Properties: size, formattedMaxLength
24   *
25   * @deprecated Only used by KNS classes, use KRAD.
26   */
27  @Deprecated
28  public class CurrencyControlDefinition extends ControlDefinitionBase {
29      private static final long serialVersionUID = 1650000676894176080L;
30      
31  	/**
32       * the maxLength for text that has been formatted. ie if maxLength=5. [12345]. but after going through the formatter the value
33       * is [12,345.00] and will no longer fit in a field whos maxLength=5. formattedMaxLength solves this problem.
34       */
35      protected Integer formattedMaxLength;
36  
37      public CurrencyControlDefinition() {
38      }
39  
40      /**
41       * 
42       * @see org.kuali.rice.krad.datadictionary.control.ControlDefinition#isCurrency()
43       */
44      public boolean isCurrency() {
45          return true;
46      }
47  
48      /**
49       * @see java.lang.Object#toString()
50       */
51      public String toString() {
52          return "CurrencyControlDefinition";
53      }
54  
55      /**
56       * @return Returns the formattedMaxLength parameter for currency controls.
57       */
58      public Integer getFormattedMaxLength() {
59          return formattedMaxLength;
60      }
61  
62      /**
63       * the maxLength for text that has been formatted. ie if maxLength=5. [12345]. but after going through the formatter the value
64       * is [12,345.00] and will no longer fit in a field whos maxLength=5. formattedMaxLength solves this problem.
65       */
66      public void setFormattedMaxLength(Integer formattedMaxLength) {
67          this.formattedMaxLength = formattedMaxLength;
68      }
69  
70  }