Package io.guise.framework.event
Class NavigateActionListener
- java.lang.Object
-
- io.guise.framework.event.AbstractNavigateActionListener
-
- io.guise.framework.event.NavigateActionListener
-
- All Implemented Interfaces:
ActionListener
,GuiseEventListener
,java.util.EventListener
public final class NavigateActionListener extends AbstractNavigateActionListener
An object that listens for action events and in response changes the navigation. This class if declared final because it encapsulates a set of known, bounded functionality that may be deferred to the client if possible.- Author:
- Garret Wilson
-
-
Constructor Summary
Constructors Constructor Description NavigateActionListener(com.globalmentor.net.URIPath navigationPath)
Constructs a listener to navigate to the provided path.NavigateActionListener(java.net.URI navigationURI)
Constructs a listener to navigate to the provided URI.NavigateActionListener(java.net.URI navigationURI, java.lang.String viewportID)
Constructs a listener to navigate to the provided URI in the identified viewport.
-
Method Summary
-
Methods inherited from class io.guise.framework.event.AbstractNavigateActionListener
actionPerformed, getNavigationURI, getViewportID
-
-
-
-
Constructor Detail
-
NavigateActionListener
public NavigateActionListener(com.globalmentor.net.URIPath navigationPath)
Constructs a listener to navigate to the provided path.- Parameters:
navigationPath
- A path that is either relative to the application context path or is absolute.- Throws:
java.lang.NullPointerException
- if the given path isnull
.java.lang.IllegalArgumentException
- if the provided path specifies a URI scheme (i.e. the URI is absolute) and/or authority (in which caseNavigateActionListener(URI)
should be used instead).
-
NavigateActionListener
public NavigateActionListener(java.net.URI navigationURI)
Constructs a listener to navigate to the provided URI.- Parameters:
navigationURI
- The URI for navigation when the action occurs.- Throws:
java.lang.NullPointerException
- if the given navigation URI isnull
.
-
NavigateActionListener
public NavigateActionListener(java.net.URI navigationURI, java.lang.String viewportID)
Constructs a listener to navigate to the provided URI in the identified viewport.- Parameters:
navigationURI
- The URI for navigation when the action occurs.viewportID
- The ID of the viewport in which navigation should occur, ornull
if navigation should occur in the current viewport.- Throws:
java.lang.NullPointerException
- if the given navigation URI isnull
.
-
-