View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.myfaces.custom.captcha;
20  
21  import javax.faces.component.UIComponentBase;
22  
23  /**
24   * 
25   * @JSFComponent
26   *   name = "t:captcha"
27   *   class = "org.apache.myfaces.custom.captcha.CAPTCHAComponent"
28   *   tagClass = "org.apache.myfaces.custom.captcha.CAPTCHATag"
29   * @since 1.1.7
30   * @author Hazem Saleh
31   *
32   */
33  public abstract class AbstractCAPTCHAComponent extends UIComponentBase {
34  
35      public static String COMPONENT_TYPE = "org.apache.myfaces.CAPTCHA";
36      public static String COMPONENT_FAMILY = "org.apache.myfaces.CAPTCHA";
37      public static String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.CAPTCHA";
38      
39      // Value binding constants
40      public static final String ATTRIBUTE_CAPTCHA_SESSION_KEY_NAME = "captchaSessionKeyName";
41      public static final String ATTRIBUTE_IMAGE_WIDTH = "imageWidth";
42      public static final String ATTRIBUTE_IMAGE_HEIGHT = "imageHeight";
43      
44      /**
45       * Determines the CAPTCHA session key name.
46       * 
47       * @JSFProperty
48       * @return
49       */
50      public abstract String getCaptchaSessionKeyName();
51      
52      /**
53       * Integer to indicate the CAPTCHA width. default is 290.
54       * 
55       * @JSFProperty
56       */
57      public abstract String getImageWidth();
58  
59      /**
60       * Integer to indicate the CAPTCHA height. default is 81.
61       * 
62       * @JSFProperty
63       */
64      public abstract String getImageHeight();      
65     
66  }