com.taursys.xml.event
Class RecycleDispatcher

java.lang.Object
  com.taursys.xml.event.Dispatcher
      com.taursys.xml.event.RecycleDispatcher

public class RecycleDispatcher

extends Dispatcher

RecycleDispatcher is a subcomponent responsible for receiving and dispatching RecycleEvents. Components should register with this component to be notified whenever a recycle event occurs.

Version:

1.0

Author:

Marty Phelan

Field Summary

Fields inherited from class com.taursys.xml.event.Dispatcher

components, map

Constructor Summary

RecycleDispatcher(Container c)
Constructs a new RecycleDispatcher with given Container as parent.

Method Summary

void	dispatch() Dispatches a RecycleEvent to all registered components.
void	dispatchToComponent(Component c) Dispatches a ParameterEvent to the given component.

Methods inherited from class com.taursys.xml.event.Dispatcher

addNotify, dispatch, dispatch, getIndex, getParameter, getParentDispatcher, getParentIndex, incrementIndex, removeNotify, resetIndex, setParentDispatcher

Methods inherited from class java.lang.Object

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

Constructor Detail

RecycleDispatcher

public RecycleDispatcher(Container c)

Constructs a new RecycleDispatcher with given Container as parent.

Method Detail

dispatchToComponent

public void dispatchToComponent(Component c)
                         throws java.lang.Exception

Dispatches a ParameterEvent to the given component. The components will only be dispatched its own input as specified by its parameter property. If the component's parameter is present, then the event will contain that value. If the parameter is NOT present, AND the component's defaultValue is set, then the event will contain the defaultValue. If the parameter is NOT present and defaultValue is NULL, no event will be dispatched.

Specified by:

dispatchToComponent in class Dispatcher

Parameters:

c - the Component to dispatch the event to.

Throws:

java.lang.Exception - from the components dispatchEvent method if occurs.

dispatch

public void dispatch()
              throws RecycleException

Dispatches a RecycleEvent to all registered components.

Overrides:

dispatch in class Dispatcher

Throws:

RecycleException