01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.portal.layout;
18:
19: import java.util.List;
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 433543 2006-08-22 06:22:54Z crossley $
28: */
29: public interface CompositeLayout extends Layout {
30:
31: /**
32: * Add indexed item to the itemList.
33: * @param index index for the position inside the list
34: * @param item item to add
35: */
36: void addItem(int index, Item item);
37:
38: /**
39: * Add Item to the ItemList.
40: * @param item item to add
41: */
42: void addItem(Item item);
43:
44: /**
45: * Get the item at the index
46: * @param index
47: * @return The item or null
48: */
49: Item getItem(int index);
50:
51: /**
52: * Get the ItemList.
53: * @return items
54: */
55: List getItems();
56:
57: /**
58: * Get size of ItemList.
59: * @return size
60: */
61: int getSize();
62:
63: /**
64: * Remove an item
65: * @param item
66: */
67: void removeItem(Item item);
68:
69: /**
70: * Create a new item.
71: * This item is not added to the composite layout
72: */
73: Item createNewItem();
74:
75: /**
76: * @return Returns the item class name.
77: */
78: String getItemClassName();
79:
80: /**
81: * @param value The item class name to set.
82: */
83: void setItemClassName(String value);
84:
85: }
|