public class PortalControlParameter
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
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 and Description |
---|
PortalControlParameter(PortalURL url) |
Modifier and Type | Method and Description |
---|---|
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) |
public static final java.lang.String ACTION
public static final java.lang.String MODE
public static final java.lang.String PORTLET_ID
public static final java.lang.String PREFIX
public static final java.lang.String PREV_MODE
public static final java.lang.String PREV_STATE
public static final java.lang.String RENDER_PARAM
public static final java.lang.String STATE
public PortalControlParameter(PortalURL url)
public static java.lang.String encodeParameterName(java.lang.String param)
PREFIX
. The reverse method is {decodeParameterName(String)
}.
Don't mistake this method for {encodeRenderParamName(PortletWindow, String)
}
or {encodeRenderParamValues(String[])
}.param
- The parameter to be encoded / prefixed.public static java.lang.String decodeParameterName(java.lang.String param)
encodeParameterName(String)
}.
Don't mistake this method for {#decodeRenderParameterName(String)
}
or {decodeRenderParamValues(String)
}.param
- The parameter to be decoded.public static java.lang.String decodeParameterValue(java.lang.String paramName, java.lang.String paramValue)
public static java.lang.String encodeRenderParamName(org.apache.pluto.om.window.PortletWindow window, java.lang.String paramName)
#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.public static java.lang.String decodeRenderParamName(org.apache.pluto.om.window.PortletWindow window, java.lang.String encodedRenderParamName)
encodeRenderParamName(PortletWindow, String)
}.public static java.lang.String encodeRenderParamValues(java.lang.String[] paramValues)
paramValues
- The render parameter values to be encoded.public static java.lang.String getRenderParamKey(org.apache.pluto.om.window.PortletWindow window)
window
- public static boolean isControlParameter(java.lang.String param)
public static boolean isStateFullParameter(java.lang.String param)
public void clearRenderParameters(org.apache.pluto.om.window.PortletWindow portletWindow)
public java.lang.String[] getActionParameter(org.apache.pluto.om.window.PortletWindow window, java.lang.String paramName)
public javax.portlet.PortletMode getMode(org.apache.pluto.om.window.PortletWindow window)
public java.lang.String getPIDValue()
public org.apache.pluto.om.window.PortletWindow getPortletWindowOfAction()
public javax.portlet.PortletMode getPrevMode(org.apache.pluto.om.window.PortletWindow window)
public javax.portlet.WindowState getPrevState(org.apache.pluto.om.window.PortletWindow window)
public java.util.Iterator getRenderParamNames(org.apache.pluto.om.window.PortletWindow window)
public java.lang.String[] getRenderParamValues(org.apache.pluto.om.window.PortletWindow window, java.lang.String paramName)
public java.util.Map getRequestParameter()
public javax.portlet.WindowState getState(org.apache.pluto.om.window.PortletWindow window)
public java.util.Map getEncodedStateFullControlParameter()
public java.util.Map getStateLessControlParameter()
public boolean isOnePortletWindowMaximized()
public void setAction(org.apache.pluto.om.window.PortletWindow window)
public void setMode(org.apache.pluto.om.window.PortletWindow window, javax.portlet.PortletMode mode)
public void setPortletId(org.apache.pluto.om.window.PortletWindow window)
public void setRenderParam(org.apache.pluto.om.window.PortletWindow window, java.lang.String name, java.lang.String[] values)
encodeRenderParamName(PortletWindow, String)
}
and {encodeRenderParamValues(String[])
.public void setRequestParam(java.lang.String name, java.lang.String[] values)
public void setState(org.apache.pluto.om.window.PortletWindow window, javax.portlet.WindowState state)
Copyright © 2003-2013 . All Rights Reserved.