Package io.guise.framework.event

Class AbstractNavigateActionListener

java.lang.Object
io.guise.framework.event.AbstractNavigateActionListener
All Implemented Interfaces:
ActionListener, GuiseEventListener, EventListener
Direct Known Subclasses:
AbstractNavigateModalActionListener, NavigateActionListener
public abstract class AbstractNavigateActionListener extends Object implements ActionListener
An abstract that listens for action events and keeps information for navigating in response.
Author:
Garret Wilson

  • Constructor Details

    • AbstractNavigateActionListener

      public AbstractNavigateActionListener(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 AbstractNavigateActionListener(URI) should be used instead).

    • AbstractNavigateActionListener

      public AbstractNavigateActionListener(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.

    • AbstractNavigateActionListener

      public AbstractNavigateActionListener(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.

  • Method Details

    • getNavigationURI

      public URI getNavigationURI()
      Returns:
      The requested navigation URI.

    • getViewportID

      public String getViewportID()
      Returns:
      The ID of the viewport in which navigation should occur, or null if navigation should occur in the current viewport..

    • actionPerformed

      public void actionPerformed(ActionEvent actionEvent)
      Called when an action is initiated.

      This implementation requests navigation from the session.

      Specified by:
      actionPerformed in interface ActionListener
      Parameters:
      actionEvent - The event indicating the source of the action.