This project has retired. For details please refer to its Attic page.

org.apache.cocoon.portal.layout
Interface CompositeLayout

All Superinterfaces:

Aspectalizable, Layout, Parameters, Producible

All Known Implementing Classes:

CompositeLayoutImpl

public interface CompositeLayout
extends Layout

A composite layout is a layout that contains other layouts.

Version:

CVS $Id: CompositeLayout.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Carsten Ziegeler, Volker Schmitt

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, getLayoutRendererName, getParent, getRendererName, setParent

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

getParameters

Methods inherited from interface org.apache.cocoon.portal.factory.Producible

getId, getName, initialize, setDescription

Methods inherited from interface org.apache.cocoon.portal.aspect.Aspectalizable

addPersistentAspectData, getAspectData, getAspectDatas, getPersistentAspectData, isAspectSupported, setAspectData, setAspectDataHandler

Method Detail

addItem

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

void addItem(Item item)

Add Item to the ItemList.

Parameters:

item - item to add

getItem

Item getItem(int index)

Get the item at the index

Parameters:

index -

Returns:

The item or null

getItems

List getItems()

Get the ItemList.

Returns:

items

getSize

int getSize()

Get size of ItemList.

Returns:

size

removeItem

void removeItem(Item item)

Remove an item

Parameters:

item -

createNewItem

Item createNewItem()

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

getItemClassName

String getItemClassName()

Returns:

Returns the item class name.

setItemClassName

void setItemClassName(String value)

Parameters:

value - The item class name to set.