net.java.sip.communicator.service.systray
Interface SystrayService

All Known Implementing Classes:

SystrayServiceJdicImpl

public interface SystrayService

The SystrayService manages the system tray icon, menu and messages. It is meant to be used by all bundles that want to show a system tray message.

Author:

Yana Stamcheva

Field Summary

static int	ENVELOPE_IMG_TYPE Image type corresponding to the envelope icon
static int	ERROR_MESSAGE_TYPE Message type corresponding to an error message.
static int	INFORMATION_MESSAGE_TYPE Message type corresponding to an information message.
static int	NONE_MESSAGE_TYPE Message type is not accessible.
static int	SC_IMG_AWAY_TYPE Image type corresponding to the sip-communicator away icon
static int	SC_IMG_DND_TYPE Image type corresponding to the sip-communicator do not disturb icon
static int	SC_IMG_FFC_TYPE Image type corresponding to the sip-communicator free for chat icon
static int	SC_IMG_OFFLINE_TYPE Image type corresponding to the sip-communicator offline icon
static int	SC_IMG_TYPE Image type corresponding to the sip-communicator icon
static int	WARNING_MESSAGE_TYPE Message type corresponding to a warning message.

Method Summary

void	addPopupMessageListener(SystrayPopupMessageListener listener) Adds a listener for SystrayPopupMessageEvents posted when user clicks on the system tray popup message.
PopupMessageHandler	getActivePopupMessageHandler() Get the handler currently used by the systray service for popup message
void	removePopupMessageListener(SystrayPopupMessageListener listener) Removes a listener previously added with addPopupMessageListener.
void	selectBestPopupMessageHandler() Selects the best available popup message handler
PopupMessageHandler	setActivePopupMessageHandler(PopupMessageHandler popupHandler) Set the handler which will be used for popup message
void	setSystrayIcon(int imageType) Sets a new icon to the systray.
void	showPopupMessage(PopupMessage popupMessage) Shows the given PopupMessage

Field Detail

ERROR_MESSAGE_TYPE

static final int ERROR_MESSAGE_TYPE

Message type corresponding to an error message.

See Also:

Constant Field Values

INFORMATION_MESSAGE_TYPE

static final int INFORMATION_MESSAGE_TYPE

Message type corresponding to an information message.

See Also:

Constant Field Values

WARNING_MESSAGE_TYPE

static final int WARNING_MESSAGE_TYPE

Message type corresponding to a warning message.

See Also:

Constant Field Values

NONE_MESSAGE_TYPE

static final int NONE_MESSAGE_TYPE

Message type is not accessible.

See Also:

Constant Field Values

SC_IMG_TYPE

static final int SC_IMG_TYPE

Image type corresponding to the sip-communicator icon

See Also:

Constant Field Values

SC_IMG_OFFLINE_TYPE

static final int SC_IMG_OFFLINE_TYPE

Image type corresponding to the sip-communicator offline icon

See Also:

Constant Field Values

SC_IMG_AWAY_TYPE

static final int SC_IMG_AWAY_TYPE

Image type corresponding to the sip-communicator away icon

See Also:

Constant Field Values

SC_IMG_FFC_TYPE

static final int SC_IMG_FFC_TYPE

Image type corresponding to the sip-communicator free for chat icon

See Also:

Constant Field Values

SC_IMG_DND_TYPE

static final int SC_IMG_DND_TYPE

Image type corresponding to the sip-communicator do not disturb icon

See Also:

Constant Field Values

ENVELOPE_IMG_TYPE

static final int ENVELOPE_IMG_TYPE

Image type corresponding to the envelope icon

See Also:

Constant Field Values

Method Detail

showPopupMessage

void showPopupMessage(PopupMessage popupMessage)

Shows the given PopupMessage

Parameters:

popupMessage - the message to show

addPopupMessageListener

void addPopupMessageListener(SystrayPopupMessageListener listener)

Adds a listener for SystrayPopupMessageEvents posted when user clicks on the system tray popup message.

Parameters:

listener - the listener to add

removePopupMessageListener

void removePopupMessageListener(SystrayPopupMessageListener listener)

Removes a listener previously added with addPopupMessageListener.

Parameters:

listener - the listener to remove

setActivePopupMessageHandler

PopupMessageHandler setActivePopupMessageHandler(PopupMessageHandler popupHandler)

Set the handler which will be used for popup message

Parameters:

popupHandler - the handler to use

Returns:

the previously used popup handler

getActivePopupMessageHandler

PopupMessageHandler getActivePopupMessageHandler()

Get the handler currently used by the systray service for popup message

Returns:

the handler used by the systray service

setSystrayIcon

void setSystrayIcon(int imageType)

Sets a new icon to the systray.

Parameters:

imageType - the type of the image to set

selectBestPopupMessageHandler

void selectBestPopupMessageHandler()

Selects the best available popup message handler