当前页面: 在线文档首页 > JBOSS Portal 2.4 API 英文版文档

PageNavigationalState - JBOSS Portal 2.4 API 英文版文档

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.jboss.portal.theme.navigation
Class PageNavigationalState

java.lang.Object
  org.jboss.portal.theme.navigation.PageNavigationalState

All Implemented Interfaces:

java.io.Serializable

---

public final class PageNavigationalState

extends java.lang.Object

implements java.io.Serializable

A state provider for all the navigational state of the windows of one page.

See Also:

Serialized Form

---

Constructor Summary

PageNavigationalState()

 

Method Summary
java.lang.String	getLayoutState()
java.lang.String	getLayoutURI()
WindowContext	getPreviousWindowContext(java.lang.String windowID, boolean remove)
WindowContext	getWindowContext(java.lang.String windowId)
java.util.Map	getWindowContextMap()
java.util.Collection	getWindowContexts()
void	initialize(java.util.Map windowContexts)           Initialize the navigational state of all the windows on this page.
boolean	isWindowVisible(java.lang.String windowId)
void	setLayoutState(java.lang.String state)
void	setLayoutURI(java.lang.String uri)
void	setWindowOrder(java.lang.String windowId, int order, boolean rememberPrevious)
void	setWindowRegion(java.lang.String windowId, java.lang.String regionName, boolean rememberPrevious)
void	setWindowVisible(java.lang.String windowId, boolean visible)

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

PageNavigationalState

public PageNavigationalState()

Method Detail

initialize

public void initialize(java.util.Map windowContexts)

Initialize the navigational state of all the windows on this page.

The page navigational state also carries a list of all the available regions on the page (as defined in the layout of the page

Parameters:

windowContexts - a Map (keyed by windowId) of WindowContext instances, one for each window on the page

---

getWindowContext

public WindowContext getWindowContext(java.lang.String windowId)

---

getWindowContexts

public java.util.Collection getWindowContexts()

---

getWindowContextMap

public java.util.Map getWindowContextMap()

---

getPreviousWindowContext

public WindowContext getPreviousWindowContext(java.lang.String windowID,
                                              boolean remove)

---

setWindowVisible

public void setWindowVisible(java.lang.String windowId,
                             boolean visible)

---

isWindowVisible

public boolean isWindowVisible(java.lang.String windowId)

---

setWindowRegion

public void setWindowRegion(java.lang.String windowId,
                            java.lang.String regionName,
                            boolean rememberPrevious)

---

setWindowOrder

public void setWindowOrder(java.lang.String windowId,
                           int order,
                           boolean rememberPrevious)

---

setLayoutState

public void setLayoutState(java.lang.String state)

---

setLayoutURI

public void setLayoutURI(java.lang.String uri)

---

getLayoutState

public java.lang.String getLayoutState()

---

getLayoutURI

public java.lang.String getLayoutURI()

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---