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
,java.io.Serializable
public class NavigationEvent extends AbstractGuiseEvent
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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description NavigationEvent(java.lang.Object source, com.globalmentor.net.URIPath navigationPath, Bookmark bookmark, java.net.URI referrerURI)
Source constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Bookmark
getBookmark()
com.globalmentor.net.URIPath
getNavigationPath()
java.net.URI
getReferrerURI()
-
Methods inherited from class io.guise.framework.event.AbstractGuiseEvent
getSession
-
-
-
-
Constructor Detail
-
NavigationEvent
public NavigationEvent(java.lang.Object source, com.globalmentor.net.URIPath navigationPath, Bookmark bookmark, java.net.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:
java.lang.NullPointerException
- if the given source, and/or navigation path isnull
.
-
-
Method Detail
-
getNavigationPath
public com.globalmentor.net.URIPath getNavigationPath()
- Returns:
- The navigation path relative to the application context path.
-
getBookmark
public Bookmark getBookmark()
- Returns:
- The bookmark for which navigation should occur at the navigation path, or
null
if there is no bookmark involved in navigation.
-
getReferrerURI
public java.net.URI 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.
-
-