org.agentgui.gui.swing.systemtray

Class AgentGUITrayIcon

java.lang.Object

org.agentgui.gui.swing.systemtray.AgentGUITrayIcon

All Implemented Interfaces:

java.awt.event.ActionListener, java.util.EventListener, AwbTrayIcon

public class AgentGUITrayIcon
extends java.lang.Object
implements java.awt.event.ActionListener, AwbTrayIcon

This class will show the tray icon and will prepare its context menu, if it is supported by the OS. If not a simple dialog will be shown.

See Also:

AgentGUITrayDialog

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentGUITrayIcon.TrayUsage

Constructor Summary

Constructors

Constructor and Description
AgentGUITrayIcon() Constructor of this class.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
AgentGUITrayDialog	getAgentGUITrayDialog() Returns the AgentGUITrayDialog.
AgentGUITrayDialog	getAgentGUITrayDialog(boolean createIfNotAvailable) Returns the AgentGUITrayDialog.
AgentGUITrayPopUp	getAgentGUITrayPopUp() Returns the AgentGUITrayPopUp.
java.awt.Image	getImageGreen() Gets the green image of the Agent.GUI TrayIcon.
javax.swing.ImageIcon	getImageIconGreen() Gets the green image icon of the Agent.GUI TrayIcon.
javax.swing.ImageIcon	getImageIconRed() Gets the red image icon of the Agent.GUI TrayIcon
java.awt.Image	getImageRed() Gets the red image of the Agent.GUI TrayIcon.
java.awt.TrayIcon	getTrayIcon() Returns the current TrayIcon.
java.awt.TrayIcon	getTrayIcon(boolean createIfNotAvailable) Returns or creates the TrayIcon.
AgentGUITrayIcon.TrayUsage	getTrayIconUsage() Gets the tray icon usage.
void	refreshView() Refreshes the appearance of the tray icon.
void	remove() Removes the tray icon out off the system tray.

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentGUITrayIcon

public AgentGUITrayIcon()

Constructor of this class.

Method Detail

getTrayIconUsage

public AgentGUITrayIcon.TrayUsage getTrayIconUsage()

Gets the tray icon usage.

Returns:

the tray icon usage

getAgentGUITrayPopUp

public AgentGUITrayPopUp getAgentGUITrayPopUp()

Returns the AgentGUITrayPopUp.

Returns:

the AgentGUITrayPopUp

refreshView

public void refreshView()

Description copied from interface: AwbTrayIcon

Refreshes the appearance of the tray icon.

Specified by:

refreshView in interface AwbTrayIcon

getAgentGUITrayDialog

public AgentGUITrayDialog getAgentGUITrayDialog()

Returns the AgentGUITrayDialog.

Returns:

the AgentGUITrayDialog

getAgentGUITrayDialog

public AgentGUITrayDialog getAgentGUITrayDialog(boolean createIfNotAvailable)

Returns the AgentGUITrayDialog.

Parameters:

createIfNotAvailable - set true, if you want that an instance should automatically be created

Returns:

the AgentGUITrayDialog

getTrayIcon

public java.awt.TrayIcon getTrayIcon()

Returns the current TrayIcon.

Returns:

the TrayIcon

getTrayIcon

public java.awt.TrayIcon getTrayIcon(boolean createIfNotAvailable)

Returns or creates the TrayIcon.

Parameters:

createIfNotAvailable - the create if not available

Returns:

the TrayIcon

getImageIconRed

public javax.swing.ImageIcon getImageIconRed()

Gets the red image icon of the Agent.GUI TrayIcon

Returns:

the red image icon

getImageRed

public java.awt.Image getImageRed()

Gets the red image of the Agent.GUI TrayIcon.

Returns:

the red image

getImageIconGreen

public javax.swing.ImageIcon getImageIconGreen()

Gets the green image icon of the Agent.GUI TrayIcon.

Returns:

the image icon green

getImageGreen

public java.awt.Image getImageGreen()

Gets the green image of the Agent.GUI TrayIcon.

Returns:

the image green

remove

public void remove()

Removes the tray icon out off the system tray.

Specified by:

remove in interface AwbTrayIcon

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener