org.apache.cocoon.portal.layout
Interface CompositeLayout

All Superinterfaces:

Layout

All Known Implementing Classes:

CompositeLayoutImpl

public interface CompositeLayout

extends Layout

A composite layout is a layout that contains other layouts.

Version:

$Id: CompositeLayout.java 322471 2005-10-16 13:24:19Z cziegeler $

Method Summary

void	addItem(int index, Item item) Add indexed item to the itemList.
void	addItem(Item item) Add Item to the ItemList.
Item	createNewItem() Create a new item.
Item	getItem(int index) Get the item at the index
String	getItemClassName()
List	getItems() Get the ItemList.
int	getSize() Get size of ItemList.
void	removeItem(Item item) Remove an item
void	setItemClassName(String value)

Methods inherited from interface org.apache.cocoon.portal.layout.Layout

copy, getId, getLayoutRendererName, getName, getParameter, getParameters, getParent, getRendererName, getTemporaryParameter, getTemporaryParameters, initialize, setDescription, setParameter, setParent, setTemporaryParameter

Method Detail

addItem

public void addItem(int index,
                    Item item)

Add indexed item to the itemList.

Parameters:

index - index for the position inside the list

item - item to add

addItem

public void addItem(Item item)

Add Item to the ItemList.

Parameters:

item - item to add

getItem

public Item getItem(int index)

Get the item at the index

Parameters:

index -

Returns:

The item or null

getItems

public List getItems()

Get the ItemList.

Returns:

items

getSize

public int getSize()

Get size of ItemList.

Returns:

size

removeItem

public void removeItem(Item item)

Remove an item

Parameters:

item -

createNewItem

public Item createNewItem()

Create a new item. This item is not added to the composite layout

getItemClassName

public String getItemClassName()

Returns:

Returns the item class name.

setItemClassName

public void setItemClassName(String value)

Parameters:

value - The item class name to set.