CompositeLayout


1   /*
2    * Copyright 1999-2002,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.apache.cocoon.portal.layout;
17  
18  import java.util.List  ;
19  
20  
21  /**
22   * A composite layout is a layout that contains other layouts.
23   * 
24   * @author <a HREF="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
25   * @author <a HREF="mailto:volker.schmitt@basf-it-services.com">Volker Schmitt</a>
26   * 
27   * @version CVS $Id: CompositeLayout.java 219049 2005-07-14 15:11:52Z cziegeler $
28   */
29  public interface CompositeLayout 
30      extends Layout {
31  
32      /**
33       * Add indexed item to the itemList.
34       * @param index index for the position inside the list
35       * @param item item to add
36       */
37      void addItem(int index, Item item);
38  
39      /**
40       * Add Item to the ItemList.
41       * @param item item to add
42       */
43      void addItem(Item item);
44  
45      /**
46       * Get the item at the index
47       * @param index
48       * @return The item or null
49       */
50      Item getItem(int index);
51  
52      /**
53       * Get the ItemList.
54       * @return items
55       */
56      List   getItems();
57  
58      /**
59       * Get size of ItemList.
60       * @return size
61       */
62      int getSize();
63      
64      /**
65       * Remove an item
66       * @param item
67       */
68      void removeItem(Item item);
69      
70      /**
71       * Create a new item.
72       * This item is not added to the composite layout
73       */
74      Item createNewItem();
75  
76      /**
77       * @return Returns the item class name.
78       */
79      String   getItemClassName();
80      
81      /**
82       * @param value The item class name to set.
83       */
84      void setItemClassName(String   value);
85      
86  }
87
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags