ilog.views.appframe.event
Class IlvApplicationListenerList

java.lang.Object
  ilog.views.appframe.event.IlvApplicationListenerList

All Implemented Interfaces:

ApplicationListener, EventListener

public class IlvApplicationListenerList
extends Object
implements ApplicationListener

A class that holds a list of application listeners.

Constructor Summary

IlvApplicationListenerList()
Constructs an IlvApplicationListenerList.

Method Summary

void	addApplicationListener(ApplicationListener listener) Adds an application listener for receiving application events.
void	addApplicationListener(String templateName, ApplicationListener listener) Adds an application listener for a specific document template.
void	applicationEventReceived(ApplicationEvent event) Invoked when an application event occurs.
void	fireApplicationEvent(ApplicationEvent event) Fires the specified application event to the application listeners added to this listener list.
ApplicationListener[]	getApplicationListeners() Returns a new constructed array of all the application listeners owned by this object.
boolean	removeApplicationListener(ApplicationListener listener) Removes the specified listener, so that it no longer receives application events.
boolean	removeApplicationListener(String templateName, ApplicationListener listener) Removes the specified listener, so that it no longer receives application events.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvApplicationListenerList

public IlvApplicationListenerList()

Constructs an IlvApplicationListenerList.

Method Detail

applicationEventReceived

public void applicationEventReceived(ApplicationEvent event)

Invoked when an application event occurs.

Specified by:

applicationEventReceived in interface ApplicationListener

Parameters:

event - The application event.

getApplicationListeners

public ApplicationListener[] getApplicationListeners()

Returns a new constructed array of all the application listeners owned by this object.

addApplicationListener

public void addApplicationListener(ApplicationListener listener)

Adds an application listener for receiving application events.

Parameters:

listener - The application listener to add.

See Also:

removeApplicationListener(ilog.views.appframe.event.ApplicationListener)

addApplicationListener

public void addApplicationListener(String templateName,
                                   ApplicationListener listener)

Adds an application listener for a specific document template. The listener will be invoked only when an application event is triggered for a document or a document view belonging to the specified document template.

Parameters:

templateName - The name of the document template for which application events will be fired to the listener.

listener - The application listener to add.

See Also:

removeApplicationListener(String, ilog.views.appframe.event.ApplicationListener)

removeApplicationListener

public boolean removeApplicationListener(ApplicationListener listener)

Removes the specified listener, so that it no longer receives application events.

Parameters:

listener - The application listener to remove.

Returns:

true if the listener has previously been added to the listener list; false otherwise.

See Also:

addApplicationListener(ilog.views.appframe.event.ApplicationListener)

removeApplicationListener

public boolean removeApplicationListener(String templateName,
                                         ApplicationListener listener)

Removes the specified listener, so that it no longer receives application events.

Parameters:

templateName - The name of the document template for which application events were fired to the listener.

listener - The application listener to remove.

Returns:

true if the listener has previously been added to the listener list; false otherwise.

See Also:

addApplicationListener(String, ilog.views.appframe.event.ApplicationListener)

fireApplicationEvent

public void fireApplicationEvent(ApplicationEvent event)

Fires the specified application event to the application listeners added to this listener list.

Parameters:

event - The event to fire.