com.guiseframework.event
Class AbstractNavigateModalActionListener

java.lang.Object
  com.guiseframework.event.AbstractNavigateActionListener
      com.guiseframework.event.AbstractNavigateModalActionListener

All Implemented Interfaces:

ActionListener, GuiseEventListener, java.util.EventListener

Direct Known Subclasses:

NavigateModalActionListener

public class AbstractNavigateModalActionListener
extends AbstractNavigateActionListener

A abstract object that listens for action events and keeps information for modally navigating in response.

Author:

Garret Wilson

Constructor Summary

AbstractNavigateModalActionListener(java.lang.String navigationPath, ModalNavigationListener modalListener)
Constructs a listener to navigate modally to the provided path.

AbstractNavigateModalActionListener(java.net.URI navigationURI, ModalNavigationListener modalListener)
Constructs a listener to navigate modally to the provided URI.

Method Summary

ModalNavigationListener

getModelListener()

Methods inherited from class com.guiseframework.event.AbstractNavigateActionListener

actionPerformed, getNavigationURI, getViewportID

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNavigateModalActionListener

public AbstractNavigateModalActionListener(java.lang.String navigationPath,
                                           ModalNavigationListener modalListener)

Constructs a listener to navigate modally to the provided path.

Parameters:

navigationPath - A path that is either relative to the application context path or is absolute.

modalListener - The listener to respond to the end of modal interaction.

Throws:

java.lang.NullPointerException - if the given path and/or modal listener is null.

java.lang.IllegalArgumentException - if the provided path specifies a URI scheme (i.e. the URI is absolute) and/or authority (in which case AbstractNavigateModalActionListener(URI, ModalNavigationListener) should be used instead).

AbstractNavigateModalActionListener

public AbstractNavigateModalActionListener(java.net.URI navigationURI,
                                           ModalNavigationListener modalListener)

Constructs a listener to navigate modally to the provided URI.

Parameters:

navigationURI - The URI for navigation when the action occurs.

modalListener - The listener to respond to the end of modal interaction.

Throws:

java.lang.NullPointerException - if the given navigation URI and/or modal listener is null.

Method Detail

getModelListener

public final ModalNavigationListener getModelListener()

Returns:

The listener to respond to the end of modal interaction.