org.apache.pluto.portalImpl.core
Class PortalControlParameter

java.lang.Object
  extended byorg.apache.pluto.portalImpl.core.PortalControlParameter

public class PortalControlParameter
extends java.lang.Object


Field Summary
static java.lang.String ACTION
           
static java.lang.String MODE
           
static java.lang.String PORTLET_ID
           
static java.lang.String PREFIX
           
static java.lang.String PREV_MODE
           
static java.lang.String PREV_STATE
           
static java.lang.String RENDER_PARAM
           
static java.lang.String STATE
           
 
Constructor Summary
PortalControlParameter(PortalURL url)
           
 
Method Summary
 void clearRenderParameters(org.apache.pluto.om.window.PortletWindow portletWindow)
          Deletes all render parameter that belong to the given window.
static java.lang.String decodeParameterName(java.lang.String param)
          Decodes a parameter by deleting the prefix, if the parameter was prefixed.
static java.lang.String decodeParameterValue(java.lang.String paramName, java.lang.String paramValue)
          Dummy method.
static java.lang.String decodeRenderParamName(org.apache.pluto.om.window.PortletWindow window, java.lang.String encodedRenderParamName)
          Reverse method for method {encodeRenderParamName(PortletWindow, String)}.
static java.lang.String encodeParameterName(java.lang.String param)
          Each parameter is encoded by prefixing it with the String PREFIX.
static java.lang.String encodeRenderParamName(org.apache.pluto.om.window.PortletWindow window, java.lang.String paramName)
          Encodes the given render parameter name.
static java.lang.String encodeRenderParamValues(java.lang.String[] paramValues)
          Encodes the given render parameter values.
 java.lang.String[] getActionParameter(org.apache.pluto.om.window.PortletWindow window, java.lang.String paramName)
           
 java.util.Map getEncodedStateFullControlParameter()
           
 javax.portlet.PortletMode getMode(org.apache.pluto.om.window.PortletWindow window)
           
 java.lang.String getPIDValue()
           
 org.apache.pluto.om.window.PortletWindow getPortletWindowOfAction()
           
 javax.portlet.PortletMode getPrevMode(org.apache.pluto.om.window.PortletWindow window)
           
 javax.portlet.WindowState getPrevState(org.apache.pluto.om.window.PortletWindow window)
           
static java.lang.String getRenderParamKey(org.apache.pluto.om.window.PortletWindow window)
          Retrieve the key to use to prefix render parameters of the given portlet window.
 java.util.Iterator getRenderParamNames(org.apache.pluto.om.window.PortletWindow window)
           
 java.lang.String[] getRenderParamValues(org.apache.pluto.om.window.PortletWindow window, java.lang.String paramName)
           
 java.util.Map getRequestParameter()
           
 javax.portlet.WindowState getState(org.apache.pluto.om.window.PortletWindow window)
           
 java.util.Map getStateLessControlParameter()
           
static boolean isControlParameter(java.lang.String param)
          Check whether the given string encodes a control parameter.
 boolean isOnePortletWindowMaximized()
           
static boolean isStateFullParameter(java.lang.String param)
          Check whether the given string encodes a stateful parameter, i.e.
 void setAction(org.apache.pluto.om.window.PortletWindow window)
           
 void setMode(org.apache.pluto.om.window.PortletWindow window, javax.portlet.PortletMode mode)
           
 void setPortletId(org.apache.pluto.om.window.PortletWindow window)
           
 void setRenderParam(org.apache.pluto.om.window.PortletWindow window, java.lang.String name, java.lang.String[] values)
          Sets the given render parameter.
 void setRequestParam(java.lang.String name, java.lang.String[] values)
           
 void setState(org.apache.pluto.om.window.PortletWindow window, javax.portlet.WindowState state)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACTION

public static final java.lang.String ACTION
See Also:
Constant Field Values

MODE

public static final java.lang.String MODE
See Also:
Constant Field Values

PORTLET_ID

public static final java.lang.String PORTLET_ID
See Also:
Constant Field Values

PREFIX

public static final java.lang.String PREFIX
See Also:
Constant Field Values

PREV_MODE

public static final java.lang.String PREV_MODE
See Also:
Constant Field Values

PREV_STATE

public static final java.lang.String PREV_STATE
See Also:
Constant Field Values

RENDER_PARAM

public static final java.lang.String RENDER_PARAM
See Also:
Constant Field Values

STATE

public static final java.lang.String STATE
See Also:
Constant Field Values
Constructor Detail

PortalControlParameter

public PortalControlParameter(PortalURL url)
Method Detail

encodeParameterName

public static java.lang.String encodeParameterName(java.lang.String param)
Each parameter is encoded by prefixing it with the String PREFIX. The reverse method is {decodeParameterName(String)}. Don't mistake this method for {encodeRenderParamName(PortletWindow, String)} or {encodeRenderParamValues(String[])}.

Parameters:
param - The parameter to be encoded / prefixed.
Returns:
The encoded parameter.

decodeParameterName

public static java.lang.String decodeParameterName(java.lang.String param)
Decodes a parameter by deleting the prefix, if the parameter was prefixed. Reverse method to {encodeParameterName(String)}. Don't mistake this method for {#decodeRenderParameterName(String)} or {#decodeRenderParamValues(String)}.

Parameters:
param - The parameter to be decoded.
Returns:
The decoded parameter.

decodeParameterValue

public static java.lang.String decodeParameterValue(java.lang.String paramName,
                                                    java.lang.String paramValue)
Dummy method. Does nothing!


encodeRenderParamName

public static java.lang.String encodeRenderParamName(org.apache.pluto.om.window.PortletWindow window,
                                                     java.lang.String paramName)
Encodes the given render parameter name. The name will be encoded using the {#encodeValue(String)} method, meaning that characters that will interfere with plutos internal url encoding and decoding mechanisms, like "/" or "_" will be encoded. The parameter name will then be prefixed with a string that encodes the portlet window the parameter belongs to. This prefix contains the characters ("/", "_", ...) that had to be encoded in the parameter name to later allow for a safe parsing of the prefix.

Returns:
A string encoding the given render parameter name to be used in portal urls.

decodeRenderParamName

public static java.lang.String decodeRenderParamName(org.apache.pluto.om.window.PortletWindow window,
                                                     java.lang.String encodedRenderParamName)
Reverse method for method {encodeRenderParamName(PortletWindow, String)}.


encodeRenderParamValues

public static java.lang.String encodeRenderParamValues(java.lang.String[] paramValues)
Encodes the given render parameter values. The values are encoded in one single string that will be used in portal urls.

Parameters:
paramValues - The render parameter values to be encoded.
Returns:
A string containing the encoded render parameter values.

getRenderParamKey

public static java.lang.String getRenderParamKey(org.apache.pluto.om.window.PortletWindow window)
Retrieve the key to use to prefix render parameters of the given portlet window.

Parameters:
window -
Returns:

isControlParameter

public static boolean isControlParameter(java.lang.String param)
Check whether the given string encodes a control parameter.


isStateFullParameter

public static boolean isStateFullParameter(java.lang.String param)
Check whether the given string encodes a stateful parameter, i.e. mode, previous mode, window state, previous window state or render parameter.


clearRenderParameters

public void clearRenderParameters(org.apache.pluto.om.window.PortletWindow portletWindow)
Deletes all render parameter that belong to the given window.


getActionParameter

public java.lang.String[] getActionParameter(org.apache.pluto.om.window.PortletWindow window,
                                             java.lang.String paramName)

getMode

public javax.portlet.PortletMode getMode(org.apache.pluto.om.window.PortletWindow window)

getPIDValue

public java.lang.String getPIDValue()

getPortletWindowOfAction

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

getPrevMode

public javax.portlet.PortletMode getPrevMode(org.apache.pluto.om.window.PortletWindow window)

getPrevState

public javax.portlet.WindowState getPrevState(org.apache.pluto.om.window.PortletWindow window)

getRenderParamNames

public java.util.Iterator getRenderParamNames(org.apache.pluto.om.window.PortletWindow window)

getRenderParamValues

public java.lang.String[] getRenderParamValues(org.apache.pluto.om.window.PortletWindow window,
                                               java.lang.String paramName)

getRequestParameter

public java.util.Map getRequestParameter()

getState

public javax.portlet.WindowState getState(org.apache.pluto.om.window.PortletWindow window)

getEncodedStateFullControlParameter

public java.util.Map getEncodedStateFullControlParameter()

getStateLessControlParameter

public java.util.Map getStateLessControlParameter()

isOnePortletWindowMaximized

public boolean isOnePortletWindowMaximized()

setAction

public void setAction(org.apache.pluto.om.window.PortletWindow window)

setMode

public void setMode(org.apache.pluto.om.window.PortletWindow window,
                    javax.portlet.PortletMode mode)

setPortletId

public void setPortletId(org.apache.pluto.om.window.PortletWindow window)

setRenderParam

public void setRenderParam(org.apache.pluto.om.window.PortletWindow window,
                           java.lang.String name,
                           java.lang.String[] values)
Sets the given render parameter. Note that its name as well as its values will be encoded for storage using {encodeRenderParamName(PortletWindow, String)} and {encodeRenderParamValues(String[]).


setRequestParam

public void setRequestParam(java.lang.String name,
                            java.lang.String[] values)

setState

public void setState(org.apache.pluto.om.window.PortletWindow window,
                     javax.portlet.WindowState state)


Copyright © 2003-2007 . All Rights Reserved.