org.apache.cocoon.portal.layout.renderer.aspect.impl
Class PortletWindowAspect

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractAspect
          org.apache.cocoon.portal.layout.renderer.aspect.impl.PortletWindowAspect

All Implemented Interfaces:

Component, Contextualizable, LogEnabled, Serviceable, ThreadSafe, RendererAspect

public final class PortletWindowAspect
extends AbstractAspect
implements Contextualizable

This aspect draws a portlet window for a JSR-168 implementation.

Example XML:

   <window>
     <title>title</title>
     <maximize-uri>event</maximize-uri>
     <minimize-uri>event</minimize-uri>
     <fullscreen-uri>event</fullscreen-uri>
     <edit-uri>event</edit-uri>
     <help-uri>event</help-uri>
     <view-uri>event</view-uri>
     <!-- output of following renderers -->
   </window>
 

Applicable to:

• CopletLayout

Parameters

root-tag	Should a root tag surrounding the following output be generated?		boolean	true
tag-name	Name of the root tag if requested.		String	"window"

Version:

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

Author:

Carsten Ziegeler

Nested Class Summary

protected static class

PortletWindowAspect.PreparedConfiguration

Field Summary

protected org.apache.pluto.services.PortletContainerEnvironment

environment The environment

Fields inherited from class org.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractAspect

manager

Fields inherited from interface org.apache.cocoon.portal.layout.renderer.aspect.RendererAspect

ROLE

Constructor Summary

PortletWindowAspect()

Method Summary

void	contextualize(Context context)
Object	prepareConfiguration(Parameters configuration) Compile the configuration.
void	toSAX(RendererAspectContext context, Layout layout, PortalService service, ContentHandler contenthandler) Stream out raw layout

Methods inherited from class org.apache.cocoon.portal.layout.renderer.aspect.impl.AbstractAspect

getAspectDescriptions, isRequired, service

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

environment

protected org.apache.pluto.services.PortletContainerEnvironment environment

The environment

Constructor Detail

PortletWindowAspect

public PortletWindowAspect()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

toSAX

public void toSAX(RendererAspectContext context,
                  Layout layout,
                  PortalService service,
                  ContentHandler contenthandler)
           throws SAXException

Description copied from interface: RendererAspect

Stream out raw layout

Specified by:

toSAX in interface RendererAspect

Overrides:

toSAX in class AbstractAspect

Throws:

SAXException

prepareConfiguration

public Object prepareConfiguration(Parameters configuration)
                            throws ParameterException

Description copied from interface: RendererAspect

Compile the configuration. A renderer aspect can "compile" the configuration in order to increase performance. If the renderer does not want to compile it should simply return the configuration. The "compiled" configuration is passed to the RendererAspect.getAspectDescriptions(Object) method and is available during streaming via the context object. This method can also be used for validation the configuration.

Specified by:

prepareConfiguration in interface RendererAspect

Overrides:

prepareConfiguration in class AbstractAspect

Throws:

ParameterException