palio.modules
Class EventBus

java.lang.Object
  palio.modules.core.Module
      palio.modules.EventBus

All Implemented Interfaces:

palio.modules.core.CurrentModuleDataKeys

public class EventBus
extends Module

Module EventBus implements publish and subscribe pattern. Useful for internal communication between application modules.

Version:

1.0.1

Author:

Krzysztof Madyniak

Field Summary

Fields inherited from interface palio.modules.core.CurrentModuleDataKeys

DESIGNER_ACTIONS_BUFFER, HTML_FORM_BUILDER, HTML_MAP_BUILDER, HTML_MENU_BUILDER, HTML_TOOLTIPS_BUFFER, ITEXT_DOCUMENT, MAIL_MESSAGE, XLS_DOCUMENT, XML_DOCUMENT

Constructor Summary

EventBus(Instance instance, java.util.Properties parameters)

Method Summary

java.lang.String	getVersion() Returns the module version
void	publish(java.lang.Object event) Publishes given event
<T> void	subscribe(java.lang.Class<? extends EventListener<T>> listenerClass, java.lang.Class<T> eventClass) Subscribes given listener for events of given type.
void	subscribe(java.lang.String listenerClassName, java.lang.String eventClassName) Subscribes given listener for events of given type

Methods inherited from class palio.modules.core.Module

getConfigParam, getDescription, getModuleTranslation

Methods inherited from class java.lang.Object

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

Constructor Detail

EventBus

public EventBus(Instance instance,
                java.util.Properties parameters)

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from class: Module

Returns the module version

Specified by:

getVersion in class Module

subscribe

public <T> void subscribe(java.lang.Class<? extends EventListener<T>> listenerClass,
                          java.lang.Class<T> eventClass)

Subscribes given listener for events of given type. This method should be used in one of initialization objects.

Parameters:

listenerClass - Listener class

eventClass - Event class

See Also:

for jpalio classic

subscribe

public void subscribe(java.lang.String listenerClassName,
                      java.lang.String eventClassName)
               throws palio.PalioException

Subscribes given listener for events of given type

Parameters:

listenerClassName - Listener class qualified name

eventClassName - Event class qualified name

Throws:

palio.PalioException

See Also:

for groovy/java

publish

public void publish(java.lang.Object event)
             throws palio.PalioException

Publishes given event

Parameters:

event - Event to publish

Throws:

palio.PalioException