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.TagAttribute;
23  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
24  
25  
26  public interface HasRenderedPartially {
27    /**
28     * <p>
29     * Indicate the partially rendered components in a case of a submit.
30     * </p>
31     * <p>
32     * The search depends on the number of prefixed colons in the relativeId:
33     * <dl>
34     *   <dd>number of prefixed colons == 0</dd>
35     *   <dt>fully relative</dt>
36     *   <dd>number of prefixed colons == 1</dd>
37     *   <dt>absolute (still normal findComponent syntax)</dt>
38     *   <dd>number of prefixed colons == 2</dd>
39     *   <dt>search in the current naming container (same as 0 colons)</dt>
40     *   <dd>number of prefixed colons == 3</dd>
41     *   <dt>search in the parent naming container of the current naming container</dt>
42     *   <dd>number of prefixed colons > 3</dd>
43     *   <dt>go to the next parent naming container for each additional colon</dt>
44     * </dl>
45     * </p>
46     * <p>
47     * If a literal is specified: to use more than one identifier the identifiers must be space delimited.
48     * </p>
49     * <p>
50     * Using this in a UISheet or UITabGroup component this list indicates components to update when calling
51     * internal AJAX requests like sort or paging commands.
52     * Don't forget to add the sheet-id or tagGroup-id in that case, if needed.
53     * </p>
54     * <p>
55     * You can also use @this for the component itself.
56     * </p>
57     */
58     @TagAttribute
59     @UIComponentTagAttribute(type = "java.lang.String[]")
60     void setRenderedPartially(String componentIds);
61  }