|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.container.services.information.PortletStateManager
The PortletStateManager implementation. Analyzes the incoming request parameters for the given PortletWindow, changes the window states/portlet modes, stores them in the static hash maps, builds a portlet URL based on the changed modes/states and portlet render parameters for the current PortletWindow.
Field Summary | |
static java.lang.String |
ACTION
|
static java.lang.String |
MIN_CHAN_ID
|
static java.lang.String |
MODE
|
static java.lang.String |
MULTI
|
static java.lang.String |
PREV_MODE
|
static java.lang.String |
PREV_STATE
|
static java.lang.String |
STATE
|
static java.lang.String |
UP_EDIT_TARGET
|
static java.lang.String |
UP_HELP_TARGET
|
static java.lang.String |
UP_ROOT
|
static java.lang.String |
UP_TCATTR
|
static java.lang.String |
UP_VIEW_TARGET
|
Constructor Summary | |
PortletStateManager(org.apache.pluto.om.window.PortletWindow window)
|
Method Summary | |
void |
clearParameters()
Clears the render parameters for the current PortletWindow |
static void |
clearState(javax.servlet.http.HttpServletRequest request)
Clears the states/modes for the porlet windows associated with the given HttpSession |
static void |
clearState(org.apache.pluto.om.window.PortletWindow portletWindow)
Clears the states/modes of the given PortletWindow. |
static java.util.Hashtable |
decodeURLParameters(java.lang.String encodedParameters)
|
static java.lang.String |
encodeURLParameters(java.lang.String urlParameters)
|
java.lang.String |
getActionURL()
|
static java.lang.String |
getKey(org.apache.pluto.om.window.PortletWindow window)
Generates the hash key for the given PortletWindow based on the user session ID and portlet window ID |
static javax.portlet.PortletMode |
getMode(org.apache.pluto.om.window.PortletWindow window)
Returns the current portlet mode for the given PortletWindow |
static javax.portlet.PortletMode |
getPrevMode(org.apache.pluto.om.window.PortletWindow window)
Returns the previous portlet mode for the given PortletWindow |
static javax.portlet.WindowState |
getPrevState(org.apache.pluto.om.window.PortletWindow window)
Returns the previous portlet state for the given PortletWindow |
static javax.portlet.WindowState |
getState(org.apache.pluto.om.window.PortletWindow window)
Returns the current portlet state for the given PortletWindow |
static java.util.Hashtable |
getURLDecodedParameters(javax.servlet.http.HttpServletRequest request)
|
boolean |
isAction()
Returns true if the current PortletRequest is ActionRequest, false - otherwise |
void |
setAction()
Setting the portlet action parameter for the next request |
static void |
setMode(org.apache.pluto.om.window.PortletWindow window,
javax.portlet.PortletMode mode)
Sets the portlet mode for the given PortletWindow |
void |
setNextMode(javax.portlet.PortletMode mode)
Sets the next portlet mode for the current PortletWindow |
void |
setNextState(javax.portlet.WindowState state)
Sets the next window state for the current PortletWindow |
void |
setParameters(java.util.Map parameters)
Adds the render parameters to the portlet URL |
static void |
setState(org.apache.pluto.om.window.PortletWindow window,
javax.portlet.WindowState state)
Sets the window state for the given PortletWindow |
java.lang.String |
toString()
Generates the string representation of the portlet URL based on the next/current portlet modes/states and render parameters for the current PortletWindow |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, 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 MULTI
public static final java.lang.String PREV_MODE
public static java.lang.String PREV_STATE
public static final java.lang.String STATE
public static final java.lang.String UP_ROOT
public static final java.lang.String UP_TCATTR
public static final java.lang.String UP_HELP_TARGET
public static final java.lang.String UP_EDIT_TARGET
public static final java.lang.String UP_VIEW_TARGET
public static final java.lang.String MIN_CHAN_ID
Constructor Detail |
public PortletStateManager(org.apache.pluto.om.window.PortletWindow window)
Method Detail |
public static java.util.Hashtable getURLDecodedParameters(javax.servlet.http.HttpServletRequest request)
public void setNextMode(javax.portlet.PortletMode mode)
mode
- a portlet modepublic void setNextState(javax.portlet.WindowState state)
state
- a window statepublic void setAction()
public void setParameters(java.util.Map parameters)
parameters
- a Map
containing the render parameterspublic boolean isAction()
public static java.util.Hashtable decodeURLParameters(java.lang.String encodedParameters)
public static java.lang.String encodeURLParameters(java.lang.String urlParameters)
public static java.lang.String getKey(org.apache.pluto.om.window.PortletWindow window)
window
- a portlet window
public static void clearState(org.apache.pluto.om.window.PortletWindow portletWindow)
portletWindow
- a portlet windowpublic static void clearState(javax.servlet.http.HttpServletRequest request)
request
- a HttpServletRequest
instancepublic void clearParameters()
public static javax.portlet.PortletMode getMode(org.apache.pluto.om.window.PortletWindow window)
window
- a portlet window
public static javax.portlet.PortletMode getPrevMode(org.apache.pluto.om.window.PortletWindow window)
window
- a portlet window
public static javax.portlet.WindowState getState(org.apache.pluto.om.window.PortletWindow window)
window
- a portlet window
public static javax.portlet.WindowState getPrevState(org.apache.pluto.om.window.PortletWindow window)
window
- a portlet window
public static void setMode(org.apache.pluto.om.window.PortletWindow window, javax.portlet.PortletMode mode)
window
- a portlet windowmode
- a portlet modepublic static void setState(org.apache.pluto.om.window.PortletWindow window, javax.portlet.WindowState state)
window
- a portlet windowstate
- a window statepublic java.lang.String toString()
public java.lang.String getActionURL()
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |