|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.pluto.portalImpl.core.PortalControlParameter
public class PortalControlParameter
Field Summary | |
---|---|
static java.lang.String |
ACTION
|
private java.util.Map |
encodedStateFullControlParameter
The map containing the encoded statefull control parameters. |
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
|
private java.util.Map |
requestParameter
|
static java.lang.String |
STATE
|
private java.util.Map |
stateLessControlParameter
|
private PortalURL |
url
|
Constructor Summary | |
---|---|
PortalControlParameter(PortalURL url)
|
Method Summary | |
---|---|
void |
clearRenderParameters(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(PortletWindow window,
java.lang.String encodedRenderParamName)
Reverse method for method { encodeRenderParamName(PortletWindow, String) }. |
private static java.lang.String[] |
decodeRenderParamValues(java.lang.String encodedParamValues)
Reverse method for the method { encodeRenderParamValues(String[]) }. |
private static java.lang.String |
decodeString(java.lang.String value)
Decodes the given 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(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. |
private static java.lang.String |
encodeString(java.lang.String value)
Encodes the given String. |
private java.lang.String |
getActionKey(PortletWindow window)
|
java.lang.String[] |
getActionParameter(PortletWindow window,
java.lang.String paramName)
|
java.util.Map |
getEncodedStateFullControlParameter()
|
PortletMode |
getMode(PortletWindow window)
|
private java.lang.String |
getModeKey(PortletWindow window)
|
java.lang.String |
getPIDValue()
|
private java.lang.String |
getPortletIdKey()
|
PortletWindow |
getPortletWindowOfAction()
|
PortletMode |
getPrevMode(PortletWindow window)
|
private java.lang.String |
getPrevModeKey(PortletWindow window)
|
WindowState |
getPrevState(PortletWindow window)
|
private java.lang.String |
getPrevStateKey(PortletWindow window)
|
static java.lang.String |
getRenderParamKey(PortletWindow window)
Retrieve the key to use to prefix render parameters of the given portlet window. |
java.util.Iterator |
getRenderParamNames(PortletWindow window)
|
java.lang.String[] |
getRenderParamValues(PortletWindow window,
java.lang.String paramName)
|
java.util.Map |
getRequestParameter()
|
WindowState |
getState(PortletWindow window)
|
private java.lang.String |
getStateKey(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(PortletWindow window)
|
void |
setMode(PortletWindow window,
PortletMode mode)
|
void |
setPortletId(PortletWindow window)
|
void |
setRenderParam(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(PortletWindow window,
WindowState state)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
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
private java.util.Map requestParameter
private java.util.Map encodedStateFullControlParameter
encodeRenderParamName(PortletWindow, String)
}
and {encodeRenderParamValues(String[])
}.
private java.util.Map stateLessControlParameter
private PortalURL url
Constructor Detail |
---|
public PortalControlParameter(PortalURL url)
Method Detail |
---|
private static java.lang.String encodeString(java.lang.String value)
decodeString(String)
}.
value
- The String to be encoded.
decodeParameterName(String)
private static java.lang.String decodeString(java.lang.String value)
encodeString(String)
}.
value
- The string to be decoded.
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(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(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.
private static java.lang.String[] decodeRenderParamValues(java.lang.String encodedParamValues)
encodeRenderParamValues(String[])
}.
public static java.lang.String getRenderParamKey(PortletWindow window)
window
-
public static boolean isControlParameter(java.lang.String param)
public static boolean isStateFullParameter(java.lang.String param)
public void clearRenderParameters(PortletWindow portletWindow)
private java.lang.String getActionKey(PortletWindow window)
public java.lang.String[] getActionParameter(PortletWindow window, java.lang.String paramName)
public PortletMode getMode(PortletWindow window)
private java.lang.String getModeKey(PortletWindow window)
public java.lang.String getPIDValue()
private java.lang.String getPortletIdKey()
public PortletWindow getPortletWindowOfAction()
public PortletMode getPrevMode(PortletWindow window)
private java.lang.String getPrevModeKey(PortletWindow window)
public WindowState getPrevState(PortletWindow window)
private java.lang.String getPrevStateKey(PortletWindow window)
public java.util.Iterator getRenderParamNames(PortletWindow window)
public java.lang.String[] getRenderParamValues(PortletWindow window, java.lang.String paramName)
public java.util.Map getRequestParameter()
public WindowState getState(PortletWindow window)
public java.util.Map getEncodedStateFullControlParameter()
private java.lang.String getStateKey(PortletWindow window)
public java.util.Map getStateLessControlParameter()
public boolean isOnePortletWindowMaximized()
public void setAction(PortletWindow window)
public void setMode(PortletWindow window, PortletMode mode)
public void setPortletId(PortletWindow window)
public void setRenderParam(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(PortletWindow window, WindowState state)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |