com.guiseframework.event
Class NavigationEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.globalmentor.event.AbstractEvent
          extended by com.guiseframework.event.AbstractGuiseEvent
              extended by com.guiseframework.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

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
NavigationEvent(java.lang.Object source, com.globalmentor.net.URIPath navigationPath, Bookmark bookmark, java.net.URI referrerURI)
          Source constructor.
 
Method Summary
 Bookmark getBookmark()
           
 com.globalmentor.net.URIPath getNavigationPath()
           
 java.net.URI getReferrerURI()
           
 
Methods inherited from class com.guiseframework.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 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, or null if there is no bookmark involved in navigation.
referrerURI - The URI of the referring navigation panel or other entity with no query or fragment, or null if no referring URI is known.
Throws:
java.lang.NullPointerException - if the given source, and/or navigation path is null.
Method Detail

getNavigationPath

public com.globalmentor.net.URIPath getNavigationPath()

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.


Copyright © 2005-2010 GlobalMentor, Inc. All Rights Reserved.