Package io.guise.framework.event
Class NavigationEvent
java.lang.Object
java.util.EventObject
com.globalmentor.event.AbstractEvent
io.guise.framework.event.AbstractGuiseEvent
io.guise.framework.event.NavigationEvent
- All Implemented Interfaces:
com.globalmentor.event.Event
,GuiseEvent
,Serializable
An event indicating that navigation has occurred. The source of this event is the Guise session in which navigation occurred.
- Author:
- Garret Wilson
- See Also:
-
Field Summary
Fields inherited from class java.util.EventObject
source
-
Constructor Summary
ConstructorDescriptionNavigationEvent
(Object source, com.globalmentor.net.URIPath navigationPath, Bookmark bookmark, URI referrerURI) Source constructor. -
Method Summary
Modifier and TypeMethodDescriptioncom.globalmentor.net.URIPath
Methods inherited from class io.guise.framework.event.AbstractGuiseEvent
getSession
Methods inherited from class java.util.EventObject
getSource, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.globalmentor.event.Event
getSource
-
Constructor Details
-
NavigationEvent
public NavigationEvent(Object source, com.globalmentor.net.URIPath navigationPath, Bookmark bookmark, URI referrerURI) Source constructor.- Parameters:
source
- The object on which the event initially occurred.navigationPath
- The navigation path relative to the application context path.bookmark
- The bookmark for which navigation should occur at this navigation path, ornull
if there is no bookmark involved in navigation.referrerURI
- The URI of the referring navigation panel or other entity with no query or fragment, ornull
if no referring URI is known.- Throws:
NullPointerException
- if the given source, and/or navigation path isnull
.
-
-
Method Details
-
getBookmark
- Returns:
- The bookmark for which navigation should occur at the navigation path, or
null
if there is no bookmark involved in navigation.
-
getReferrerURI
- Returns:
- The URI of the referring navigation panel or other entity with no query or fragment, or
null
if no referring URI is known.