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

org.apache.cocoon.portal.pluto
Class PortletURLProviderImpl

java.lang.Object
  org.apache.cocoon.portal.pluto.PortletURLProviderImpl

All Implemented Interfaces:

ActionEvent, ConvertableEvent, CopletInstanceEvent, Event, org.apache.pluto.services.information.PortletURLProvider

public class PortletURLProviderImpl
extends Object
implements org.apache.pluto.services.information.PortletURLProvider, CopletInstanceEvent, ConvertableEvent

Create the URL for a portlet.

Version:

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

Author:

Carsten Ziegeler

Field Summary

protected boolean	action Is this an action
protected boolean	clearParameters Clear parameters
protected String	generatedURL The generated url
protected javax.portlet.PortletMode	mode The new portlet mode
protected Map	parameters Parameters
protected org.apache.pluto.om.window.PortletWindow	portletWindow The portlet window (target)
protected Boolean	secure Secure link?
protected javax.portlet.WindowState	state The new window state

Constructor Summary

PortletURLProviderImpl(org.apache.pluto.om.window.PortletWindow portletWindow, ServiceManager manager)
Constructor

Method Summary

String	asString() Return the URL as a String
void	clearParameters()
Map	getParameters() Return the parameters
javax.portlet.PortletMode	getPortletMode() Return the portlet mode
org.apache.pluto.om.window.PortletWindow	getPortletWindow() Return the window
String	getRequestParameterName() The request parameter to be used for this event (if events are not hidden)
Object	getTarget()
javax.portlet.WindowState	getWindowState() Return the portlet mode
boolean	isAction() Is this an action?
void	setAction()
void	setParameters(Map parameters)
void	setPortletMode(javax.portlet.PortletMode mode)
void	setSecure()
void	setWindowState(javax.portlet.WindowState state)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

portletWindow

protected final org.apache.pluto.om.window.PortletWindow portletWindow

The portlet window (target)

mode

protected javax.portlet.PortletMode mode

The new portlet mode

state

protected javax.portlet.WindowState state

The new window state

action

protected boolean action

Is this an action

secure

protected Boolean secure

Secure link?

clearParameters

protected boolean clearParameters

Clear parameters

parameters

protected Map parameters

Parameters

generatedURL

protected String generatedURL

The generated url

Constructor Detail

PortletURLProviderImpl

public PortletURLProviderImpl(org.apache.pluto.om.window.PortletWindow portletWindow,
                              ServiceManager manager)

Constructor

Method Detail

getPortletWindow

public org.apache.pluto.om.window.PortletWindow getPortletWindow()

Return the window

setPortletMode

public void setPortletMode(javax.portlet.PortletMode mode)

Specified by:

setPortletMode in interface org.apache.pluto.services.information.PortletURLProvider

See Also:

PortletURLProvider.setPortletMode(javax.portlet.PortletMode)

getPortletMode

public javax.portlet.PortletMode getPortletMode()

Return the portlet mode

setWindowState

public void setWindowState(javax.portlet.WindowState state)

Specified by:

setWindowState in interface org.apache.pluto.services.information.PortletURLProvider

See Also:

PortletURLProvider.setWindowState(javax.portlet.WindowState)

getWindowState

public javax.portlet.WindowState getWindowState()

Return the portlet mode

setAction

public void setAction()

Specified by:

setAction in interface org.apache.pluto.services.information.PortletURLProvider

See Also:

PortletURLProvider.setAction()

isAction

public boolean isAction()

Is this an action?

setSecure

public void setSecure()

Specified by:

setSecure in interface org.apache.pluto.services.information.PortletURLProvider

See Also:

PortletURLProvider.setSecure()

clearParameters

public void clearParameters()

Specified by:

clearParameters in interface org.apache.pluto.services.information.PortletURLProvider

See Also:

PortletURLProvider.clearParameters()

setParameters

public void setParameters(Map parameters)

Specified by:

setParameters in interface org.apache.pluto.services.information.PortletURLProvider

See Also:

PortletURLProvider.setParameters(java.util.Map)

getParameters

public Map getParameters()

Return the parameters

toString

public String toString()

Specified by:

toString in interface org.apache.pluto.services.information.PortletURLProvider

Overrides:

toString in class Object

See Also:

Object.toString()

getTarget

public Object getTarget()

Specified by:

getTarget in interface ActionEvent

See Also:

ActionEvent.getTarget()

asString

public String asString()

Return the URL as a String

Specified by:

asString in interface ConvertableEvent

Returns:

The URL as a String

getRequestParameterName

public String getRequestParameterName()

The request parameter to be used for this event (if events are not hidden)

Specified by:

getRequestParameterName in interface ConvertableEvent

Returns:

The request parameter name for this event.