org.walluck.oscar.tools
Class PopupTool

java.lang.Object
  extended by org.walluck.oscar.tools.Tool
      extended by org.walluck.oscar.tools.PopupTool
All Implemented Interfaces:
Listener, PopupListener

public class PopupTool
extends Tool
implements PopupListener

Popup tool.

Since:
1.0
Version:
1.0
Author:
David Walluck

Field Summary
 
Fields inherited from class org.walluck.oscar.tools.Tool
listeners
 
Constructor Summary
PopupTool()
          Creates a new Popup tool.
 
Method Summary
 void bosConnectionAvailable()
          Method called by the LoginTool once the BOS connection is available.
 void parsePopup(AIMSession sess, AIMFrame frame, AIMPopup popup)
          Describe parsePopup method here.
 void shutdown(AIMSession sess)
          Called when the tool is shutting down.
 
Methods inherited from class org.walluck.oscar.tools.Tool
getFamily, getId, getSession, getToolData, getVersion, setFamily, setId, setSession, setToolData, setVersion
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PopupTool

public PopupTool()
Creates a new Popup tool. Family 0x0008.

Method Detail

shutdown

public void shutdown(AIMSession sess)
Called when the tool is shutting down.

Specified by:
shutdown in class Tool
Parameters:
sess - the oscar session

bosConnectionAvailable

public void bosConnectionAvailable()
Method called by the LoginTool once the BOS connection is available. This allows the other tools to get registered and get involved in the process.

Specified by:
bosConnectionAvailable in class Tool

parsePopup

public void parsePopup(AIMSession sess,
                       AIMFrame frame,
                       AIMPopup popup)
Describe parsePopup method here.

Specified by:
parsePopup in interface PopupListener
Parameters:
sess - an AIMSession value
frame - an AIMFrame value
popup - an AIMPopup value