org.jivesoftware.spark.ui
Interface ChatRoomPlugin

public interface ChatRoomPlugin

Provides a mechanism for users to register themselves as ChatRoomPlugin objects. This allows users to initialize their own UI's and attach themselves to all ChatRooms for added feature sets.

Method Summary

javax.swing.JComponent	getGUI() Return's the GUI for the ChatRoomPlugin.
javax.swing.Icon	getTabIcon() Return the Icon to use on the tab containing the ChatRoomPlugin.
java.lang.String	getTabTitle() Return the name of the title you wish to identify this ChatRoomPlugin by.
java.lang.String	getTabToolTip() Return the tooltip to use on a mouseover of the tab.
void	setChatRoom(ChatRoom room) Sets the ChatRoom to attach to.
void	tabSelected() Called whenever the tab containing the ChatRoomPlugin is clicked.

Method Detail

setChatRoom

void setChatRoom(ChatRoom room)

Sets the ChatRoom to attach to.

Parameters:

room - the ChatRoom that the ChatRoomPlugin will be attaching to.

tabSelected

void tabSelected()

Called whenever the tab containing the ChatRoomPlugin is clicked.

getTabTitle

java.lang.String getTabTitle()

Return the name of the title you wish to identify this ChatRoomPlugin by.

Returns:

the title of the tab panel containing the

getTabIcon

javax.swing.Icon getTabIcon()

Return the Icon to use on the tab containing the ChatRoomPlugin.

Returns:

the icon to show on the ChatRoomPlugin tab.

getTabToolTip

java.lang.String getTabToolTip()

Return the tooltip to use on a mouseover of the tab.

Returns:

the tooltip to use on a mouseover of the tab.

getGUI

javax.swing.JComponent getGUI()

Return's the GUI for the ChatRoomPlugin.

Returns:

the GUI of the ChatRoomPlugin.