org.exoplatform.services.portletcontainer.pci
Class Input

java.lang.Object
  org.exoplatform.services.portletcontainer.pci.Input

Direct Known Subclasses:

ActionInput, EventInput, RenderInput

public class Input
extends Object

This objects must be created by the Portal that access this portlet container. The windowID is a unique id that references a portlet window in the user scope. Author : Mestrallet Benjamin benjmestrallet@users.sourceforge.net Date: Jul 27, 2003 Time: 9:17:39 PM

Constructor Summary

Input()

Method Summary

String	getBaseURL()
boolean	getEscapeXml()
WindowID	getInternalWindowID()
List<Locale>	getLocales()
String	getMarkup()
javax.portlet.PortletMode	getPortletMode()
PortletPreferencesPersister	getPortletPreferencesPersister()
byte[]	getPortletState()
PortletURLFactory	getPortletURLFactory()
HashMap	getPropertyParams()
Map<String,String[]>	getPublicParameterMap()
List<String>	getPublicParamNames()
Map<String,String[]>	getRenderParameters()
Map<String,String>	getUserAttributes()
javax.portlet.WindowState	getWindowState()
boolean	isStateSaveOnClient()
void	setBaseURL(String baseURL)
void	setEscapeXml(boolean escapeXml)
void	setInternalWindowID(WindowID windowID1)
void	setLocales(List<Locale> locales)
void	setMarkup(String markup)
void	setPortletMode(javax.portlet.PortletMode portletMode)
void	setPortletPreferencesPersister(PortletPreferencesPersister portletPreferencesPersister)
void	setPortletState(byte[] portletState)
void	setPortletURLFactory(PortletURLFactory portletURLFactory)
void	setPropertyParams(HashMap<String,String[]> propertyParams)
void	setPublicParamNames(List<String> pubNames1)
void	setRenderParameters(Map<String,String[]> renderParameters1)
void	setStateSaveOnClient(boolean stateSaveOnClient)
void	setUserAttributes(Map<String,String> userAttributes)
void	setWindowState(javax.portlet.WindowState windowState)

Methods inherited from class java.lang.Object

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

Constructor Detail

Input

public Input()

Method Detail

isStateSaveOnClient

public final boolean isStateSaveOnClient()

Returns:

either state is being saved on client side

setStateSaveOnClient

public final void setStateSaveOnClient(boolean stateSaveOnClient)

Parameters:

stateSaveOnClient - either state is being saved on client side

getInternalWindowID

public final WindowID getInternalWindowID()

Returns:

window id object

setInternalWindowID

public final void setInternalWindowID(WindowID windowID1)

Parameters:

windowID1 - window id object

getPortletMode

public final javax.portlet.PortletMode getPortletMode()

Returns:

portlet mode

setPortletMode

public final void setPortletMode(javax.portlet.PortletMode portletMode)

Parameters:

portletMode - portlet mode

getWindowState

public final javax.portlet.WindowState getWindowState()

Returns:

window state

setWindowState

public final void setWindowState(javax.portlet.WindowState windowState)

Parameters:

windowState - window state

getMarkup

public final String getMarkup()

Returns:

markup

setMarkup

public final void setMarkup(String markup)

Parameters:

markup - markup

getUserAttributes

public final Map<String,String> getUserAttributes()

Returns:

user attributes

setUserAttributes

public final void setUserAttributes(Map<String,String> userAttributes)

Parameters:

userAttributes - user attributes

getPortletState

public final byte[] getPortletState()

Returns:

portlet state

setPortletState

public final void setPortletState(byte[] portletState)

Parameters:

portletState - portlet state

getPortletPreferencesPersister

public final PortletPreferencesPersister getPortletPreferencesPersister()

Returns:

preferences persister

setPortletPreferencesPersister

public final void setPortletPreferencesPersister(PortletPreferencesPersister portletPreferencesPersister)

Parameters:

portletPreferencesPersister - preferences persister

getLocales

public final List<Locale> getLocales()

Returns:

locale list

setLocales

public final void setLocales(List<Locale> locales)

Parameters:

locales - locale list

getRenderParameters

public final Map<String,String[]> getRenderParameters()

Returns:

render params

setRenderParameters

public final void setRenderParameters(Map<String,String[]> renderParameters1)

Parameters:

renderParameters1 - render params

getPortletURLFactory

public final PortletURLFactory getPortletURLFactory()

Returns:

portlet url factory

setPortletURLFactory

public final void setPortletURLFactory(PortletURLFactory portletURLFactory)

Parameters:

portletURLFactory - portlet url factory

getBaseURL

public final String getBaseURL()

Returns:

base url

setBaseURL

public final void setBaseURL(String baseURL)

Parameters:

baseURL - base url

getEscapeXml

public final boolean getEscapeXml()

Returns:

escapeXml

setEscapeXml

public final void setEscapeXml(boolean escapeXml)

Parameters:

escapeXml - escapeXml

setPublicParamNames

public final void setPublicParamNames(List<String> pubNames1)

Parameters:

pubNames1 - public param name list

setPropertyParams

public final void setPropertyParams(HashMap<String,String[]> propertyParams)

Parameters:

propertyParams - hash map

getPropertyParams

public final HashMap getPropertyParams()

Returns:

property params

getPublicParamNames

public final List<String> getPublicParamNames()

Returns:

public param name list

getPublicParameterMap

public final Map<String,String[]> getPublicParameterMap()

Returns:

public param map