org.jaffa.components.maint
Class UpdateComponent

java.lang.Object
  org.jaffa.presentation.portlet.component.Component
      org.jaffa.components.maint.UpdateComponent

All Implemented Interfaces:

IComponent, IUpdateComponent

public abstract class UpdateComponent

extends Component

implements IUpdateComponent

This is an abstract implementation of the IUpdateComponent interface. All the Update components should extend this component.

Author:

GautamJ

Constructor Summary

UpdateComponent()

Method Summary

void	addUpdateListener(IUpdateListener listener) Adds a listener.
protected Collection	getUpdateListeners() Returns a Collection of IUpdateListener objects.
protected void	invokeUpdateListeners() Invokes the updateDone() method of the registered IUpdateListener objects in the same thread.
protected void	invokeUpdateListeners(EventObject eventObject) Invokes the updateDone() method of the registered IUpdateListener objects in the same thread.
void	quit() This clears the internal collection of listeners.
boolean	removeUpdateListener(IUpdateListener listener) Removes a listener.

Methods inherited from class org.jaffa.presentation.portlet.component.Component

addChildComponent, addFormKeyChangeListener, display, getComponentDefinition, getComponentId, getContainerFormKey, getFormKeyChangeListeners, getReturnToFormKey, getToken, getUserSession, isActive, quitAndReturnToCallingScreen, reflectAndSetParms, removeFormKeyChangeListener, returnChildComponents, returnLastActivityDate, run, setContainerFormKey, setReturnToFormKey, setToken, updateLastActivityDate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jaffa.presentation.portlet.component.IComponent

addFormKeyChangeListener, display, getComponentDefinition, getComponentId, getContainerFormKey, getFormKeyChangeListeners, getReturnToFormKey, getToken, getUserSession, isActive, quitAndReturnToCallingScreen, removeFormKeyChangeListener, setContainerFormKey, setReturnToFormKey, setToken

Constructor Detail

UpdateComponent

public UpdateComponent()

Method Detail

addUpdateListener

public void addUpdateListener(IUpdateListener listener)

Adds a listener.

Specified by:

addUpdateListener in interface IUpdateComponent

Parameters:

listener - the listener.

removeUpdateListener

public boolean removeUpdateListener(IUpdateListener listener)

Removes a listener.

Specified by:

removeUpdateListener in interface IUpdateComponent

Parameters:

listener - the listener.

Returns:

true if the listener was removed.

quit

public void quit()

This clears the internal collection of listeners. It then invokes the quit() method of the base class.

Specified by:

quit in interface IComponent

Overrides:

quit in class Component

getUpdateListeners

protected Collection getUpdateListeners()

Returns a Collection of IUpdateListener objects.

Returns:

a Collection of IUpdateListener objects.

invokeUpdateListeners

protected void invokeUpdateListeners()

Invokes the updateDone() method of the registered IUpdateListener objects in the same thread.

invokeUpdateListeners

protected void invokeUpdateListeners(EventObject eventObject)

Invokes the updateDone() method of the registered IUpdateListener objects in the same thread.

Parameters:

eventObject - The EventObject which will probably contain the component itself.