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.inputTextHelp;
20
21 import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;
22 import org.apache.myfaces.component.html.ext.HtmlInputText;
23
24 /**
25 * Extends standard inputText by helptext support.
26 *
27 * Unless otherwise specified, all attributes accept static values or EL expressions.
28 *
29 * @JSFComponent
30 * name = "t:inputTextHelp"
31 * class = "org.apache.myfaces.custom.inputTextHelp.HtmlInputTextHelp"
32 * tagClass = "org.apache.myfaces.custom.inputTextHelp.HtmlInputTextHelpTag"
33 * @since 1.1.7
34 * @author Thomas Obereder
35 * @version $Date: 2005-07-02 15:32:34 +01:00 (Thu, 09 Jun 2005)
36 */
37 public abstract class AbstractHtmlInputTextHelp extends HtmlInputText
38 {
39 public static final String JS_FUNCTION_SELECT_TEXT = "selectText";
40 public static final String JS_FUNCTION_RESET_HELP = "resetHelpValue";
41 public static final String COMPONENT_TYPE = "org.apache.myfaces.HtmlInputTextHelp";
42 public static final String DEFAULT_RENDERER_TYPE = "org.apache.myfaces.TextHelp";
43
44 /**
45 * @JSFProperty
46 */
47 public abstract String getHelpText();
48
49 /**
50 * @JSFProperty
51 * defaultValue="false"
52 */
53 public abstract boolean isSelectText();
54
55 /**
56 * Overrides the name field used by this input.
57 */
58 @JSFProperty(tagExcluded=true)
59 public abstract String getName();
60
61 /**
62 * Overrides the targetClientId used for rendered client behaviors by this component.
63 */
64 @JSFProperty(tagExcluded=true)
65 public abstract String getTargetClientId();
66 }