org.jivesoftware.spark
Interface Alerter


public interface Alerter

Implementations of this interface define alert mechanisms based on the Operating System Spark is running on.

Author:
Derek DeMoro

Method Summary
 void flashWindow(java.awt.Window window)
          Flash the window.
 void flashWindowStopWhenFocused(java.awt.Window window)
          Start the flashing of the given window, but stop flashing when the window takes focus.
 boolean handleNotification()
          Return true if this Alerter should handle the alert request.
 void stopFlashing(java.awt.Window window)
          Stop the flashing of the given window.
 

Method Detail

flashWindow

void flashWindow(java.awt.Window window)
Flash the window.

Parameters:
window - the window to flash.

flashWindowStopWhenFocused

void flashWindowStopWhenFocused(java.awt.Window window)
Start the flashing of the given window, but stop flashing when the window takes focus.

Parameters:
window - the window to start flashing.

stopFlashing

void stopFlashing(java.awt.Window window)
Stop the flashing of the given window.

Parameters:
window - the window to stop flashing.

handleNotification

boolean handleNotification()
Return true if this Alerter should handle the alert request.

Returns:
true to handle.