|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NavigationalState
NavigationalState gives readonly access to the state of the Portal URL and all navigational state context
as well as encoding a new State for usage in a Portal URL.
Note: Support for changing the PortletMode and/or WindowState of a PortletWindow, other than for encoding a new State
is moved down to the MutableNavigationState
interface to cleanly define the immutable contract of this
interface.
Field Summary | |
---|---|
static java.lang.String |
NAVSTATE_SESSION_KEY
|
Method Summary | |
---|---|
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()
|
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)
|
boolean |
isNavigationalParameterStateFull()
|
boolean |
isRenderParameterStateFull()
|
void |
sync(RequestContext context)
Synchronize the Navigational State with saved state (if used). |
Field Detail |
---|
static final java.lang.String NAVSTATE_SESSION_KEY
Method Detail |
---|
void init(java.lang.String encodedState, java.lang.String characterEncoding) throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
void sync(RequestContext context)
#init(String)
context
- The RequestContext for this Navigational Statejavax.portlet.WindowState getState(org.apache.pluto.om.window.PortletWindow window)
window
-
javax.portlet.WindowState getMappedState(org.apache.pluto.om.window.PortletWindow window)
window
-
javax.portlet.WindowState getState(java.lang.String windowId)
windowId
-
javax.portlet.WindowState getMappedState(java.lang.String windowId)
windowId
-
javax.portlet.PortletMode getMode(org.apache.pluto.om.window.PortletWindow window)
window
-
javax.portlet.PortletMode getMappedMode(org.apache.pluto.om.window.PortletWindow window)
window
-
javax.portlet.PortletMode getMode(java.lang.String windowId)
windowId
-
javax.portlet.PortletMode getMappedMode(java.lang.String windowId)
windowId
-
org.apache.pluto.om.window.PortletWindow getMaximizedWindow()
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()
java.util.Iterator getWindowIdIterator()
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
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
java.lang.String encode(org.apache.pluto.om.window.PortletWindow window, javax.portlet.PortletMode mode, javax.portlet.WindowState state) throws java.io.UnsupportedEncodingException
window
- the PortalWindowmode
- the new PortletMode for the PortalWindowstate
- the new WindowState for the PortalWindow
java.io.UnsupportedEncodingException
java.lang.String encode() throws java.io.UnsupportedEncodingException
java.io.UnsupportedEncodingException
boolean isNavigationalParameterStateFull()
boolean isRenderParameterStateFull()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |