|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.container.state.impl.AbstractNavigationalState
public abstract class AbstractNavigationalState
BaseNavigationalState
Field Summary | |
---|---|
protected JetspeedContentCache |
cache
|
protected JetspeedContentCache |
decorationCache
|
Fields inherited from interface org.apache.jetspeed.container.state.NavigationalState |
---|
NAVSTATE_SESSION_KEY |
Constructor Summary | |
---|---|
AbstractNavigationalState(NavigationalStateCodec codec,
JetspeedContentCache cache)
|
|
AbstractNavigationalState(NavigationalStateCodec codec,
JetspeedContentCache cache,
JetspeedContentCache decorationCache)
|
Method Summary | |
---|---|
void |
clearParameters(org.apache.pluto.om.window.PortletWindow window)
Clear the request parameters to emulate an action reset |
java.lang.String |
encode()
Encodes the current navigational State into a string to be embedded within a PortalURL. |
java.lang.String |
encode(org.apache.pluto.om.window.PortletWindow window,
java.util.Map parameters,
javax.portlet.PortletMode mode,
javax.portlet.WindowState state,
boolean action)
Encodes the Navigational State with overrides for a specific PortletWindow into a string to be embedded within a PortalURL. |
java.lang.String |
encode(org.apache.pluto.om.window.PortletWindow window,
javax.portlet.PortletMode mode,
javax.portlet.WindowState state)
Encodes the Navigational State with overrides for a specific PortletWindow while retaining its (request) parameters into a string to be embedded within a renderURL. |
javax.portlet.PortletMode |
getMappedMode(org.apache.pluto.om.window.PortletWindow window)
Gets the internal (portal) portlet mode for the given portlet window. |
javax.portlet.PortletMode |
getMappedMode(java.lang.String windowId)
Gets the internal (portal) portlet mode for the given portlet window id. |
javax.portlet.WindowState |
getMappedState(org.apache.pluto.om.window.PortletWindow window)
Gets the internal (portal) window state for given portlet window. |
javax.portlet.WindowState |
getMappedState(java.lang.String windowId)
Gets the internal (portal) window state for given portlet window id. |
org.apache.pluto.om.window.PortletWindow |
getMaximizedWindow()
For the current request return the (first) maximized window or return null if no windows are maximized. |
javax.portlet.PortletMode |
getMode(org.apache.pluto.om.window.PortletWindow window)
Gets the portlet mode for the given portlet window. |
javax.portlet.PortletMode |
getMode(java.lang.String windowId)
Deprecated. |
java.util.Iterator |
getParameterNames(org.apache.pluto.om.window.PortletWindow window)
|
java.lang.String[] |
getParameterValues(org.apache.pluto.om.window.PortletWindow window,
java.lang.String parameterName)
|
org.apache.pluto.om.window.PortletWindow |
getPortletWindowOfAction()
|
org.apache.pluto.om.window.PortletWindow |
getPortletWindowOfResource()
|
protected PortletWindowRequestNavigationalStates |
getPortletWindowRequestNavigationalStates()
|
javax.portlet.WindowState |
getState(org.apache.pluto.om.window.PortletWindow window)
Gets the window state for given portlet window. |
javax.portlet.WindowState |
getState(java.lang.String windowId)
Deprecated. |
java.util.Iterator |
getWindowIdIterator()
Returns an iterator of Portlet Window ids of all the Portlet Windows within the NavigationalState. |
void |
init(java.lang.String encodedState,
java.lang.String characterEncoding)
|
void |
removeState(org.apache.pluto.om.window.PortletWindow window)
Remove state for the given (possibly invalid) portlet window |
void |
setMode(org.apache.pluto.om.window.PortletWindow window,
javax.portlet.PortletMode portletMode)
Sets the portlet mode for the given portlet window. |
void |
setState(org.apache.pluto.om.window.PortletWindow window,
javax.portlet.WindowState windowState)
Sets the window state for the given portlet window. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.jetspeed.container.state.NavigationalState |
---|
isNavigationalParameterStateFull, isRenderParameterStateFull, sync |
Field Detail |
---|
protected JetspeedContentCache cache
protected JetspeedContentCache decorationCache
Constructor Detail |
---|
public AbstractNavigationalState(NavigationalStateCodec codec, JetspeedContentCache cache)
public AbstractNavigationalState(NavigationalStateCodec codec, JetspeedContentCache cache, JetspeedContentCache decorationCache)
Method Detail |
---|
public void init(java.lang.String encodedState, java.lang.String characterEncoding) throws java.io.UnsupportedEncodingException
init
in interface NavigationalState
java.io.UnsupportedEncodingException
protected PortletWindowRequestNavigationalStates getPortletWindowRequestNavigationalStates()
public void setState(org.apache.pluto.om.window.PortletWindow window, javax.portlet.WindowState windowState)
MutableNavigationalState
setState
in interface MutableNavigationalState
public void setMode(org.apache.pluto.om.window.PortletWindow window, javax.portlet.PortletMode portletMode)
MutableNavigationalState
setMode
in interface MutableNavigationalState
public javax.portlet.WindowState getMappedState(java.lang.String windowId)
NavigationalState
getMappedState
in interface NavigationalState
public javax.portlet.WindowState getState(java.lang.String windowId)
NavigationalState
getState
in interface NavigationalState
public javax.portlet.WindowState getState(org.apache.pluto.om.window.PortletWindow window)
NavigationalState
getState
in interface NavigationalState
public javax.portlet.WindowState getMappedState(org.apache.pluto.om.window.PortletWindow window)
NavigationalState
getMappedState
in interface NavigationalState
public javax.portlet.PortletMode getMappedMode(java.lang.String windowId)
NavigationalState
getMappedMode
in interface NavigationalState
public javax.portlet.PortletMode getMode(java.lang.String windowId)
NavigationalState
getMode
in interface NavigationalState
public javax.portlet.PortletMode getMode(org.apache.pluto.om.window.PortletWindow window)
NavigationalState
getMode
in interface NavigationalState
public javax.portlet.PortletMode getMappedMode(org.apache.pluto.om.window.PortletWindow window)
NavigationalState
getMappedMode
in interface NavigationalState
public org.apache.pluto.om.window.PortletWindow getMaximizedWindow()
NavigationalState
getMaximizedWindow
in interface NavigationalState
public java.util.Iterator getParameterNames(org.apache.pluto.om.window.PortletWindow window)
getParameterNames
in interface NavigationalState
public java.lang.String[] getParameterValues(org.apache.pluto.om.window.PortletWindow window, java.lang.String parameterName)
getParameterValues
in interface NavigationalState
public org.apache.pluto.om.window.PortletWindow getPortletWindowOfAction()
getPortletWindowOfAction
in interface NavigationalState
public org.apache.pluto.om.window.PortletWindow getPortletWindowOfResource()
getPortletWindowOfResource
in interface NavigationalState
public java.lang.String encode(org.apache.pluto.om.window.PortletWindow window, java.util.Map parameters, javax.portlet.PortletMode mode, javax.portlet.WindowState state, boolean action) throws java.io.UnsupportedEncodingException
NavigationalState
encode
in interface NavigationalState
window
- the PortalWindowparameters
- the new request or action parameters for the PortalWindowmode
- the new PortletMode for the PortalWindowstate
- the new WindowState for the PortalWindowaction
- indicates if to be used in an actionURL or renderURL
java.io.UnsupportedEncodingException
public java.lang.String encode(org.apache.pluto.om.window.PortletWindow window, javax.portlet.PortletMode mode, javax.portlet.WindowState state) throws java.io.UnsupportedEncodingException
NavigationalState
encode
in interface NavigationalState
window
- the PortalWindowmode
- the new PortletMode for the PortalWindowstate
- the new WindowState for the PortalWindow
java.io.UnsupportedEncodingException
public java.lang.String encode() throws java.io.UnsupportedEncodingException
NavigationalState
encode
in interface NavigationalState
java.io.UnsupportedEncodingException
public java.util.Iterator getWindowIdIterator()
NavigationalState
getWindowIdIterator
in interface NavigationalState
public void clearParameters(org.apache.pluto.om.window.PortletWindow window)
MutableNavigationalState
clearParameters
in interface MutableNavigationalState
public void removeState(org.apache.pluto.om.window.PortletWindow window)
MutableNavigationalState
removeState
in interface MutableNavigationalState
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |