Java Doc for NavigationalState.java in » Portal » jetspeed-2.1.3 » org » apache » jetspeed » container » state » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Portal » jetspeed 2.1.3 » org.apache.jetspeed.container.state

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.apache.jetspeed.container.state .NavigationalState

NavigationalState
public interface NavigationalState (Code)
	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. author: David Sean Taylor version: $Id: NavigationalState.java 554926 2007-07-10 13:12:26Z ate $

Field Summary
final public static String	NAVSTATE_SESSION_KEY

Method Summary
String	encode(PortletWindow window, Map parameters, PortletMode mode, WindowState state, boolean action) Encodes the Navigational State with overrides for a specific PortletWindow into a string to be embedded within a PortalURL.
String	encode(PortletWindow window, PortletMode mode, 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.
String	encode() Encodes the current navigational State into a string to be embedded within a PortalURL.
PortletMode	getMappedMode(PortletWindow window) Gets the internal (portal) portlet mode for the given portlet window.
PortletMode	getMappedMode(String windowId) Gets the internal (portal) portlet mode for the given portlet window id.
WindowState	getMappedState(PortletWindow window) Gets the internal (portal) window state for given portlet window.
WindowState	getMappedState(String windowId) Gets the internal (portal) window state for given portlet window id.
PortletWindow	getMaximizedWindow() For the current request return the (first) maximized window or return null if no windows are maximized.
PortletMode	getMode(PortletWindow window) Gets the portlet mode for the given portlet window.
PortletMode	getMode(String windowId) Gets the portlet mode for the given portlet window id.
Iterator	getParameterNames(PortletWindow window)
String[]	getParameterValues(PortletWindow window, String parameterName)
PortletWindow	getPortletWindowOfAction()
PortletWindow	getPortletWindowOfResource()
WindowState	getState(PortletWindow window) Gets the window state for given portlet window.
WindowState	getState(String windowId) Gets the window state for given portlet window id.
Iterator	getWindowIdIterator() Returns an iterator of Portlet Window ids of all the Portlet Windows within the NavigationalState.
void	init(String encodedState, String characterEncoding)
boolean	isNavigationalParameterStateFull()
boolean	isRenderParameterStateFull()
void	sync(RequestContext context) Synchronize the Navigational State with saved state (if used).

Field Detail

NAVSTATE_SESSION_KEY
final public static String NAVSTATE_SESSION_KEY(Code)

Method Detail

encode
String encode(PortletWindow window, Map parameters, PortletMode mode, WindowState state, boolean action) throws UnsupportedEncodingException(Code)
	Encodes the Navigational State with overrides for a specific PortletWindow into a string to be embedded within a PortalURL. Parameters: window - the PortalWindow Parameters: parameters - the new request or action parameters for the PortalWindow Parameters: mode - the new PortletMode for the PortalWindow Parameters: state - the new WindowState for the PortalWindow Parameters: action - indicates if to be used in an actionURL or renderURL encoded new Navigational State

encode
String encode(PortletWindow window, PortletMode mode, WindowState state) throws UnsupportedEncodingException(Code)
	Encodes the Navigational State with overrides for a specific PortletWindow while retaining its (request) parameters into a string to be embedded within a renderURL. Parameters: window - the PortalWindow Parameters: mode - the new PortletMode for the PortalWindow Parameters: state - the new WindowState for the PortalWindow encoded new Navigational State

encode
String encode() throws UnsupportedEncodingException(Code)
	Encodes the current navigational State into a string to be embedded within a PortalURL. encoded new Navigational State

getMappedMode
PortletMode getMappedMode(PortletWindow window)(Code)
	Gets the internal (portal) portlet mode for the given portlet window. Parameters: window -

getMappedMode
PortletMode getMappedMode(String windowId)(Code)
	Gets the internal (portal) portlet mode for the given portlet window id. Parameters: windowId -

getMappedState
WindowState getMappedState(PortletWindow window)(Code)
	Gets the internal (portal) window state for given portlet window. Parameters: window -

getMappedState
WindowState getMappedState(String windowId)(Code)
	Gets the internal (portal) window state for given portlet window id. Parameters: windowId -

getMaximizedWindow
PortletWindow getMaximizedWindow()(Code)
	For the current request return the (first) maximized window or return null if no windows are maximized. The maximized window or null

getMode
PortletMode getMode(PortletWindow window)(Code)
	Gets the portlet mode for the given portlet window. Parameters: window -

getMode
PortletMode getMode(String windowId)(Code)
	Gets the portlet mode for the given portlet window id. Parameters: windowId -

getParameterNames
Iterator getParameterNames(PortletWindow window)(Code)

getParameterValues
String[] getParameterValues(PortletWindow window, String parameterName)(Code)

getPortletWindowOfAction
PortletWindow getPortletWindowOfAction()(Code)

getPortletWindowOfResource
PortletWindow getPortletWindowOfResource()(Code)

getState
WindowState getState(PortletWindow window)(Code)
	Gets the window state for given portlet window. Parameters: window -

getState
WindowState getState(String windowId)(Code)
	Gets the window state for given portlet window id. Parameters: windowId -

getWindowIdIterator
Iterator getWindowIdIterator()(Code)
	Returns an iterator of Portlet Window ids of all the Portlet Windows within the NavigationalState. Note: for an ActionRequest, this will include the window id of the PortletWindowOfAction. iterator of portletWindow ids (String)

init
void init(String encodedState, String characterEncoding) throws UnsupportedEncodingException(Code)

isNavigationalParameterStateFull
boolean isNavigationalParameterStateFull()(Code)
	true if WindowStates and PortletModes will be saved in the Session

isRenderParameterStateFull
boolean isRenderParameterStateFull()(Code)
	true if render parameters will be saved in the Session

sync
void sync(RequestContext context)(Code)
	Synchronize the Navigational State with saved state (if used). Should be called by the PortalURL impl right after calling NavigationalState.init(String) Parameters: context - The RequestContext for this Navigational State

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.