Overview  Package   Class  Use  Deprecated  Index
Home >> All >> plugins >> [ Messenger overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

plugins.Messenger
Class AbstractMessengerPlugin  

java.lang.Object
  plugins.Messenger.AbstractMessengerPlugin

All Implemented Interfaces:

MessengerPlugin

---

public abstract class AbstractMessengerPlugin

extends java.lang.Object

implements MessengerPlugin

---

Field Summary
protected  Conversation	conversation
private  boolean	enabled
protected  MessengerPluginProtocol	protocol
private  java.util.List	stateListeners

 

Constructor Summary

AbstractMessengerPlugin()           Creates a new instance of AbstractMessengerPlugin

 

Method Summary
void	addStateListener(plugins.Messenger.event.StateListener listener)
abstract  java.lang.Object	clone()           Is called by PluginManager to generate an new Instance of MessengerPlugin for every new PluginChain (PluginChains are constructed for Conversations)
abstract  MessengerPluginProtocol	createProtocol()
abstract  void	disable(boolean remote)           State switches from enabled to disabled.
abstract  void	enable(boolean remote)
protected  void	fireStateChanged(MessengerPlugin source)
Conversation	getConversation()           Getter for property conversation.
MessengerPluginProtocol	getProtocol()           Returns an instance of the used Protocol.
void	init(Conversation conversation)           The init method is called after a new Plugin Instance is created.
boolean	isEnabled()           Getter for property enabled.
plugins.Messenger.event.StateListener	removeStateListener(plugins.Messenger.event.StateListener listener)
void	setEnabled(boolean enabled, boolean remote)           Is called if the user decides to enable/disable a Plugin for a Conversation

 

Methods inherited from class java.lang.Object

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

 

Methods inherited from interface plugins.Messenger.MessengerPlugin

destroy, getIcon, getMnemonic, getName, getToolTip

 

Field Detail

enabled

private boolean enabled

---

stateListeners

private java.util.List stateListeners

---

protocol

protected MessengerPluginProtocol protocol

---

conversation

protected Conversation conversation

Constructor Detail

AbstractMessengerPlugin

public AbstractMessengerPlugin()

Creates a new instance of AbstractMessengerPlugin

Method Detail

disable

public abstract void disable(boolean remote)

State switches from enabled to disabled. This methode is just called if the prior state was enabled!

---

enable

public abstract void enable(boolean remote)

---

createProtocol

public abstract MessengerPluginProtocol createProtocol()

---

getProtocol

public MessengerPluginProtocol getProtocol()

Returns an instance of the used Protocol. Be sure to return the same instance on subsequent calls to this method!

Specified by:

getProtocol in interface MessengerPlugin

---

setEnabled

public void setEnabled(boolean enabled,
                       boolean remote)

Is called if the user decides to enable/disable a Plugin for a Conversation

Specified by:

setEnabled in interface MessengerPlugin

---

isEnabled

public boolean isEnabled()

Getter for property enabled.

Specified by:

isEnabled in interface MessengerPlugin

---

addStateListener

public void addStateListener(plugins.Messenger.event.StateListener listener)

Specified by:

addStateListener in interface MessengerPlugin

---

removeStateListener

public plugins.Messenger.event.StateListener removeStateListener(plugins.Messenger.event.StateListener listener)

Specified by:

removeStateListener in interface MessengerPlugin

---

fireStateChanged

protected void fireStateChanged(MessengerPlugin source)

---

clone

public abstract java.lang.Object clone()

Description copied from interface: MessengerPlugin

Is called by PluginManager to generate an new Instance of MessengerPlugin for every new PluginChain (PluginChains are constructed for Conversations)

Specified by:

clone in interface MessengerPlugin

---

init

public void init(Conversation conversation)

The init method is called after a new Plugin Instance is created. All code that is needed to create the initial state of the object should go here!

Specified by:

init in interface MessengerPlugin

---

getConversation

public Conversation getConversation()

Getter for property conversation.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> plugins >> [ Messenger overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---