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  
20  package org.apache.myfaces.tobago.internal.taglib.declaration;
21  
22  import org.apache.myfaces.tobago.apt.annotation.DynamicExpression;
23  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
24  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
25  
26  public interface HasSuggestMethod {
27  
28    /**
29     * MethodBinding which generates a list of suggested input values based on
30     * the currently entered text, which could be retrieved via getSubmittedValue() on the UIIn.
31     * The expression has to evaluate to a public method which has a javax.faces.component.UIInput parameter
32     * and returns a List<String>(deprecated), a List<org.apache.myfaces.tobago.model.AutoSuggestItem>
33     * or a org.apache.myfaces.tobago.model.AutoSuggestItems.
34     */
35    @TagAttribute
36    @UIComponentTagAttribute(type = {},
37        expression = DynamicExpression.METHOD_EXPRESSION_REQUIRED,
38        methodSignature = "javax.faces.component.UIInput",
39        methodReturnType = "java.lang.Object")
40    void setSuggestMethod(String suggestMethod);
41  
42    /**
43     * Minimum number of chars to type before the list will be requested.
44     *
45     * @since 1.5.9 and 2.0.0
46     */
47    @TagAttribute
48    @UIComponentTagAttribute(type = "java.lang.Integer", defaultValue = "1")
49    void setSuggestMinChars(String suggestMinChars);
50  
51    /**
52     * Time in milli seconds before the list will be requested.
53     *
54     * @since 1.5.9 and 2.0.0
55     */
56    @TagAttribute
57    @UIComponentTagAttribute(type = "java.lang.Integer", defaultValue = "300")
58    void setSuggestDelay(String suggestDelay);
59  }