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.component;
20  
21  /**
22   * Behavioral interface.
23   * Components that support forceId generation should implement 
24   * this interface to optimize property access.
25   *
26   * @since 1.1.7
27   * @author Leonardo Uribe (latest modification by $Author: lu4242 $)
28   * @version $Revision: 691856 $ $Date: 2008-09-03 21:40:30 -0500 (Wed, 03 Sep 2008) $
29   */
30  public interface ForceIdAware
31  {
32  
33      /**
34       * If true, this component will force the use of the specified id when rendering.
35       * 
36       * @JSFProperty
37       *   literalOnly = "true"
38       *   defaultValue = "false"
39       *   
40       * @return
41       */
42      public boolean isForceId();
43      
44      public void setForceId(boolean forceId);
45      
46      /**
47       *  If false, this component will not append a '[n]' suffix 
48       *  (where 'n' is the row index) to components that are 
49       *  contained within a "list." This value will be true by 
50       *  default and the value will be ignored if the value of 
51       *  forceId is false (or not specified.)
52       * 
53       * @JSFProperty
54       *   literalOnly = "true"
55       *   defaultValue = "true"
56       *   
57       * @return
58       */
59      public boolean isForceIdIndex();
60      
61      public void setForceIdIndex(boolean forceIdIndex);
62      
63  }