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

org.apache.cocoon.portal.layout
Class AbstractLayout

java.lang.Object
  org.apache.cocoon.portal.aspect.impl.AbstractAspectalizable
      org.apache.cocoon.portal.factory.impl.AbstractProducible
          org.apache.cocoon.portal.layout.AbstractLayout

All Implemented Interfaces:

Cloneable, Aspectalizable, Producible, Layout, Parameters

Direct Known Subclasses:

CompositeLayoutImpl, CopletLayout, FrameLayout, LinkLayout

public abstract class AbstractLayout
extends AbstractProducible
implements Layout, Parameters

Version:

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

Author:

Carsten Ziegeler, Volker Schmitt

Field Summary

protected Map	parameters
protected Item	parent
protected String	rendererName

Fields inherited from class org.apache.cocoon.portal.factory.impl.AbstractProducible

description, id, name

Fields inherited from class org.apache.cocoon.portal.aspect.impl.AbstractAspectalizable

aspectDataHandler, persistentDatas

Constructor Summary

AbstractLayout()

Method Summary

void	addParameter(org.apache.pluto.om.common.Parameter parameter)
protected Object	clone()
Layout	copy() Make a copy of this layout object and of all it's children.
Set	getCastorParameters()
String	getLayoutRendererName() Get the name of a custom Renderer for this layout.
Map	getParameters() Get custom parameters as List of org.apache.cocoon.portal.layout.impl.Parameters.
Item	getParent()
String	getRendererName() Get the name of the Renderer to draw this layout.
void	setLayoutRendererName(String value)
void	setParent(Item item)

Methods inherited from class org.apache.cocoon.portal.factory.impl.AbstractProducible

getId, getName, initialize, setDescription, setId, setName

Methods inherited from class org.apache.cocoon.portal.aspect.impl.AbstractAspectalizable

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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Field Detail

rendererName

protected String rendererName

parent

protected Item parent

parameters

protected Map parameters

Constructor Detail

AbstractLayout

public AbstractLayout()

Method Detail

getParameters

public final Map getParameters()

Description copied from interface: Parameters

Get custom parameters as List of org.apache.cocoon.portal.layout.impl.Parameters. This method never returns null.

Specified by:

getParameters in interface Parameters

Returns:

List

getCastorParameters

public final Set getCastorParameters()

addParameter

public void addParameter(org.apache.pluto.om.common.Parameter parameter)

getRendererName

public String getRendererName()

Description copied from interface: Layout

Get the name of the Renderer to draw this layout. If this layout has an own renderer Layout.getLayoutRendererName() return this, otherwise the default renderer is returned.

Specified by:

getRendererName in interface Layout

Returns:

String The role name

See Also:

Layout.getRendererName()

setLayoutRendererName

public void setLayoutRendererName(String value)

getParent

public Item getParent()

Specified by:

getParent in interface Layout

setParent

public void setParent(Item item)

Specified by:

setParent in interface Layout

getLayoutRendererName

public String getLayoutRendererName()

Description copied from interface: Layout

Get the name of a custom Renderer for this layout.

Specified by:

getLayoutRendererName in interface Layout

Returns:

String The role name

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class AbstractProducible

Throws:

CloneNotSupportedException

copy

public Layout copy()

Description copied from interface: Layout

Make a copy of this layout object and of all it's children. This includes copies of items and copletinstancedatas.

Specified by:

copy in interface Layout