Package io.guise.framework

Class Navigation

java.lang.Object

io.guise.framework.Navigation

Direct Known Subclasses:

ModalNavigation

public class Navigation
extends java.lang.Object

The encapsulation of a point of navigation.

Author:

Garret Wilson

Constructor Summary

Constructors

Constructor	Description
Navigation(java.net.URI oldNavigationURI, java.net.URI newNavigationURI)	Creates an object encapsulating a point of navigation.
Navigation(java.net.URI oldNavigationURI, java.net.URI newNavigationURI, java.lang.String viewportID)	Creates an object encapsulating a point of navigation.

Method Summary

Modifier and Type	Method	Description
java.net.URI	getNewNavigationURI()
java.net.URI	getOldNavigationURI()
java.lang.String	getViewportID()

Methods inherited from class java.lang.Object

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

Constructor Detail

Navigation

public Navigation(java.net.URI oldNavigationURI,
                  java.net.URI newNavigationURI)

Creates an object encapsulating a point of navigation.

Parameters:

oldNavigationURI - The old point of navigation, either absolute or application-relative.

newNavigationURI - The new point of navigation, either absolute or application-relative.

Throws:

java.lang.NullPointerException - if one of the navigation URIs is null, or does not contain a path.

Navigation

public Navigation(java.net.URI oldNavigationURI,
                  java.net.URI newNavigationURI,
                  java.lang.String viewportID)

Creates an object encapsulating a point of navigation.

Parameters:

oldNavigationURI - The old point of navigation, either absolute or application-relative.

newNavigationURI - The new point of navigation, either absolute or application-relative.

viewportID - The ID of the viewport in which navigation should occur, or null if navigation should occur in the current viewport.

Throws:

java.lang.NullPointerException - if one of the navigation URIs is null, or does not contain a path.

Method Detail

getOldNavigationURI

public java.net.URI getOldNavigationURI()

Returns:

The old point of navigation, either absolute or application-relative.

getNewNavigationURI

public java.net.URI getNewNavigationURI()

Returns:

The new point of navigation, either absolute or application-relative.

getViewportID

public java.lang.String getViewportID()

Returns:

The ID of the viewport in which navigation should occur, or null if navigation should occur in the current viewport..