org.xnap.plugin.festival
Class FestivalPlugin

java.lang.Object
  org.xnap.plugin.AbstractPlugin
      org.xnap.plugin.festival.FestivalPlugin

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener, ChannelListener, ListListener, Plugin

public class FestivalPlugin
extends AbstractPlugin
implements ListListener, ChannelListener, java.beans.PropertyChangeListener

Provides a simple text-to-speech plugin using festival. For now it reads incoming chat messages aloud.

Field Summary

static java.lang.String

ICON_FILENAME

Constructor Summary

FestivalPlugin()

Method Summary

void	channelJoined(ChannelEvent event) Invoked when the channel has been joined.
void	channelParted(ChannelEvent event) Invoked when the channel has been parted.
java.lang.String	getName()
void	itemAdded(ListEvent event) Invoked when an item has beed added.
void	itemRemoved(ListEvent event) Invoked when an item has been removed.
void	messageReceived(ChannelEvent event) Invoked when a message has been received.
void	peerAdded(ChannelEvent event) Invoked when a peer has joined the channel.
void	peerChanged(ChannelEvent event) Invoked when a peer has changed and need to be updated on screen.
void	peerRemoved(ChannelEvent event) Invoked when a peer has left the channel.
void	propertyChange(java.beans.PropertyChangeEvent e)
void	start() Called each time the plugin is enabled.
void	startGUI() Called each time the gui part of the plugin is enabled.
void	stop() Called each time the plugin is disabled.
void	stopGUI() Called each time the gui part of the plugin is disabled.
void	topicChanged(ChannelEvent event) Invoked when a the topic has changed.

Methods inherited from class org.xnap.plugin.AbstractPlugin

getInfo, setInfo, toString

Methods inherited from class java.lang.Object

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

Field Detail

ICON_FILENAME

public static java.lang.String ICON_FILENAME

Constructor Detail

FestivalPlugin

public FestivalPlugin()

Method Detail

start

public void start()
           throws java.lang.Exception

Description copied from interface: Plugin

Called each time the plugin is enabled.

Specified by:

start in interface Plugin

Throws:

java.lang.Exception

See Also:

xnap.plugin.Plugin#start()

getName

public java.lang.String getName()

startGUI

public void startGUI()

Description copied from interface: Plugin

Called each time the gui part of the plugin is enabled.

Specified by:

startGUI in interface Plugin

See Also:

xnap.plugin.Plugin#startGUI()

stop

public void stop()

Description copied from interface: Plugin

Called each time the plugin is disabled.

Specified by:

stop in interface Plugin

See Also:

xnap.plugin.Plugin#stop()

stopGUI

public void stopGUI()

Description copied from interface: Plugin

Called each time the gui part of the plugin is disabled.

Specified by:

stopGUI in interface Plugin

See Also:

xnap.plugin.Plugin#stopGUI()

itemAdded

public void itemAdded(ListEvent event)

Description copied from interface: ListListener

Invoked when an item has beed added.

Specified by:

itemAdded in interface ListListener

See Also:

xnap.event.ListListener#itemAdded(xnap.event.ListEvent)

itemRemoved

public void itemRemoved(ListEvent event)

Description copied from interface: ListListener

Invoked when an item has been removed.

Specified by:

itemRemoved in interface ListListener

See Also:

xnap.event.ListListener#itemRemoved(xnap.event.ListEvent)

channelJoined

public void channelJoined(ChannelEvent event)

Description copied from interface: ChannelListener

Invoked when the channel has been joined.

Specified by:

channelJoined in interface ChannelListener

See Also:

xnap.chat.ChannelListener#channelJoined(xnap.chat.ChannelEvent)

channelParted

public void channelParted(ChannelEvent event)

Description copied from interface: ChannelListener

Invoked when the channel has been parted.

Specified by:

channelParted in interface ChannelListener

See Also:

xnap.chat.ChannelListener#channelParted(xnap.chat.ChannelEvent)

messageReceived

public void messageReceived(ChannelEvent event)

Description copied from interface: ChannelListener

Invoked when a message has been received.

Specified by:

messageReceived in interface ChannelListener

See Also:

xnap.chat.ChannelListener#messageReceived(xnap.chat.ChannelEvent)

peerAdded

public void peerAdded(ChannelEvent event)

Description copied from interface: ChannelListener

Invoked when a peer has joined the channel.

Specified by:

peerAdded in interface ChannelListener

See Also:

xnap.chat.ChannelListener#peerAdded(xnap.chat.ChannelEvent)

peerChanged

public void peerChanged(ChannelEvent event)

Description copied from interface: ChannelListener

Invoked when a peer has changed and need to be updated on screen.

Specified by:

peerChanged in interface ChannelListener

See Also:

xnap.chat.ChannelListener#peerChanged(xnap.chat.ChannelEvent)

peerRemoved

public void peerRemoved(ChannelEvent event)

Description copied from interface: ChannelListener

Invoked when a peer has left the channel.

Specified by:

peerRemoved in interface ChannelListener

See Also:

xnap.chat.ChannelListener#peerRemoved(xnap.chat.ChannelEvent)

topicChanged

public void topicChanged(ChannelEvent event)

Description copied from interface: ChannelListener

Invoked when a the topic has changed.

Specified by:

topicChanged in interface ChannelListener

See Also:

xnap.chat.ChannelListener#topicChanged(xnap.chat.ChannelEvent)

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener