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, 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 Details

    • 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:
      NullPointerException - if the given path is null.
      IllegalArgumentException - if the provided path specifies a URI scheme (i.e. the URI is absolute) and/or authority (in which case NavigateActionListener(URI) should be used instead).

    • NavigateActionListener

      public NavigateActionListener(URI navigationURI)
      Constructs a listener to navigate to the provided URI.
      Parameters:
      navigationURI - The URI for navigation when the action occurs.
      Throws:
      NullPointerException - if the given navigation URI is null.

    • NavigateActionListener

      public NavigateActionListener(URI navigationURI, 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, or null if navigation should occur in the current viewport.
      Throws:
      NullPointerException - if the given navigation URI is null.