wt.clients.util
Class RefreshService

java.lang.Object
  wt.clients.util.RefreshService

public class RefreshService

extends Object

Class RefreshService is a utility class used by clients to keep views of objects refreshed (in sync). Classes implementing the RefreshListener interface can subscribe as listeners to RefreshEvents via the RefreshService. This class dispatches RefreshEvents to the registered listeners.

    obj = (Object) MyTaskLogic.updateObject( obj );
    RefreshEvent evt = new RefreshEvent( this, RefreshEvent.UPDATE, obj );
    RefreshService.getRefreshService().dispatchRefresh( evt );
  

See Also:

RefreshEvent,

Supported API: true

Extendable: false

Field Summary

private static Vector	listeners
private static RefreshService	serv
private static String	versionID

Constructor Summary

RefreshService()

Method Summary

void	addRefreshListener(RefreshListener refresh_listener) Adds a RefreshListener to the list of listeners subscribed to be notified of RefreshEvents.
void	dispatchRefresh(Object source, int action, Object target) Method used to broadcast the given RefreshEvent to registered RefreshListeners.
void	dispatchRefresh(RefreshEvent evt) Method used to broadcast the given RefreshEvent to registered RefreshListeners.
static RefreshService	getRefreshService() Return a static instance of the RefreshService.
void	removeRefreshListener(RefreshListener refresh_listener) Removes the given RefreshListener from the list of listeners to RefreshEvents.

Methods inherited from class java.lang.Object

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

Field Detail

versionID

private static final String versionID

See Also:

Constant Field Values

serv

private static final RefreshService serv

listeners

private static Vector listeners

Constructor Detail

RefreshService

public RefreshService()

Method Detail

getRefreshService

public static RefreshService getRefreshService()

Return a static instance of the RefreshService.

Returns:

static instance of RefreshService

addRefreshListener

public void addRefreshListener(RefreshListener refresh_listener)

Adds a RefreshListener to the list of listeners subscribed to be notified of RefreshEvents. The added listener will be notified when RefreshEvents are dispatched by this RefreshService. If the given listener is already in the list of listeners, the listener is not added and no changes occur.

Parameters:

refresh_listener - Listener to be notified when refresh events are dispatched.

See Also:

RefreshEvent, RefreshListener

removeRefreshListener

public void removeRefreshListener(RefreshListener refresh_listener)

Removes the given RefreshListener from the list of listeners to RefreshEvents. If the given RefreshListener currently exists in the list of listeners, the given listener will be removed from the list. It the given listener is not currently a member of the list of listeners, no modifications to the list of listeners is made.

Parameters:

refresh_listener - Listener to be removed from the list of RefreshListeners.

See Also:

RefreshListener

dispatchRefresh

public void dispatchRefresh(Object source,
                            int action,
                            Object target)

Method used to broadcast the given RefreshEvent to registered RefreshListeners.

Parameters:

source - The source Object which generates the RefreshEvent.

action - The integer indicating the action which has occurred (i.e. CREATE, UPDATE, DELETE, UNKNOWN )

target - The Object which is the target of the action corresponding to the RefreshEvent (i.e. the object which has been created, updated, deleted).

dispatchRefresh

public void dispatchRefresh(RefreshEvent evt)

Method used to broadcast the given RefreshEvent to registered RefreshListeners.

Parameters:

evt - The RefreshEvent which is broadcast to the RefreshListeners.