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.imageloop;
20  
21  import javax.faces.component.UIComponentBase;
22  
23  /**
24   * Image loop items.
25   * 
26   * @JSFComponent
27   *   name = "s:imageLoopItems"
28   *   class = "org.apache.myfaces.custom.imageloop.ImageLoopItems"
29   *   tagClass = "org.apache.myfaces.custom.imageloop.ImageLoopItemsTag"
30   *   
31   * @author Felix Röthenbacher (latest modification by $Author: lu4242 $)
32   * @version $Revision: 663481 $ $Date: 2008-06-05 02:00:34 -0500 (Thu, 05 Jun 2008) $
33   */
34  public abstract class AbstractImageLoopItems extends UIComponentBase {
35      
36      public static final String COMPONENT_FAMILY = "org.apache.myfaces.ImageLoopItems";
37      public static final String COMPONENT_TYPE = "org.apache.myfaces.ImageLoopItems";
38      
39      // Value binding constants.
40      private static final String VB_VALUE = "value";
41  
42      /**
43       * An EL expression that specifies the elements of the image loop.
44       * The expression can refer to one of the following:
45       * <ol>
46       *     <li>A single GraphicItem</li>
47       *     <li>An array or Collection of GraphicItem instances</li>
48       * </ol>
49       * The value properties of each of the ImageLoopItems must be of the same
50       * basic type as the parent component's value.
51       * 
52       * @JSFProperty
53       */
54      public abstract Object getValue();
55  }