ds.desktop.notify

Class DesktopNotify

java.lang.Object

ds.desktop.notify.DesktopNotify

public class DesktopNotify
extends java.lang.Object

Main class of DS Desktop Notify. Use it to create and show notifications on the Desktop.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEBUG
static int	DEFAULT
protected static int	defTextOrientation
static int	ERROR
static int	FAIL
static int	HELP
static int	INFORMATION
static int	INPUT_REQUEST
static int	LEFT_TO_RIGHT
static int	NONE
static int	RIGHT_TO_LEFT
static int	SUCCESS
static int	TIP
static int	WARNING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DesktopNotify(java.lang.String title, java.lang.String message, int type, int orientation, java.awt.Image icon) A protected constructor for a DesktopNotify object, called internally.

Method Summary

Methods

Modifier and Type	Method and Description
protected long	expTime()
java.awt.event.ActionListener	getAction()
static int	getDefaultTextOrientation() Gets the current default text orientation.
static NotifyTheme	getDefaultTheme() Gets the theme currently in use when creating notifications.
static int	getLogLevel() Returns the level allowed for logging messages.
NotifyTheme	getTheme()
void	hide() Hides this notification immediately if it is already being displayed.
boolean	isVisible()
static void	logDebug(java.lang.String tag, java.lang.String message) Logs a debug message.
static void	logError(java.lang.String tag, java.lang.String message, java.lang.Throwable tr) Logs an error message.
static void	logInfo(java.lang.String tag, java.lang.String message) Logs an information message.
static void	logWarning(java.lang.String tag, java.lang.String message) Logs a warning message.
void	render(int x, int y, boolean hover, java.awt.Graphics2D rd, long l) The painting routine for the notification goes here.
void	setAction(java.awt.event.ActionListener action) Allows to bind an action to this notification.
static void	setDefaultTextOrientation(int defTextOrientation) Sets the default text orientation to use for new notifications.
static void	setDefaultTheme(NotifyTheme theme) Sets the theme to use by default when creating notifications.
static void	setLogLevel(int level) Allows to specify the level allowed for logging messages.
static void	setLogOutput(java.io.OutputStream outStream)
void	setTheme(NotifyTheme theme) Allows to set a NotifyTheme for this notification.
void	setTimeout(long millis) Allows to set a timeout for this notification, in milliseconds.
protected void	setVisible(boolean visible) Used by he driver to mark this notification as visible or not.
protected void	setWidth(int w)
void	show() Polls the Driver in order to show this notification, so you don't have to do it yourself.
static void	showDesktopMessage(java.lang.String title, java.lang.String message) Creates and shows a new notification.
static void	showDesktopMessage(java.lang.String title, java.lang.String message, int type) Creates and shows a new notification.
static void	showDesktopMessage(java.lang.String title, java.lang.String message, int type, java.awt.event.ActionListener action) Creates and shows a new notification.
static void	showDesktopMessage(java.lang.String title, java.lang.String message, int type, java.awt.Image icon) Creates and shows a new notification.
static void	showDesktopMessage(java.lang.String title, java.lang.String message, int type, java.awt.Image icon, java.awt.event.ActionListener action) Creates and shows a new notification.
static void	showDesktopMessage(java.lang.String title, java.lang.String message, int type, java.awt.Image icon, java.awt.event.ActionListener action, long maxTimeMillis) Creates and shows a new notification.
static void	showDesktopMessage(java.lang.String title, java.lang.String message, int type, long maxTimeMillis) Creates and shows a new notification.
static void	showDesktopMessage(java.lang.String title, java.lang.String message, int type, long maxTimeMillis, java.awt.event.ActionListener action) Creates and shows a new notification.
protected void	sortMessage() Splits the words of the text across lines that fit inside the notification.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final int DEFAULT

See Also:

Constant Field Values

INFORMATION

public static final int INFORMATION

See Also:

Constant Field Values

WARNING

public static final int WARNING

See Also:

Constant Field Values

ERROR

public static final int ERROR

See Also:

Constant Field Values

HELP

public static final int HELP

See Also:

Constant Field Values

TIP

public static final int TIP

See Also:

Constant Field Values

INPUT_REQUEST

public static final int INPUT_REQUEST

See Also:

Constant Field Values

SUCCESS

public static final int SUCCESS

See Also:

Constant Field Values

FAIL

public static final int FAIL

See Also:

Constant Field Values

LEFT_TO_RIGHT

public static final int LEFT_TO_RIGHT

See Also:

Constant Field Values

RIGHT_TO_LEFT

public static final int RIGHT_TO_LEFT

See Also:

Constant Field Values

defTextOrientation

protected static int defTextOrientation

DEBUG

public static final int DEBUG

See Also:

Constant Field Values

NONE

public static final int NONE

See Also:

Constant Field Values

Constructor Detail

DesktopNotify

protected DesktopNotify(java.lang.String title,
             java.lang.String message,
             int type,
             int orientation,
             java.awt.Image icon)

A protected constructor for a DesktopNotify object, called internally. You can use any of the showDesktopMessage() static methods or a NotificationBuilder in order to create and display a notification instead.

Parameters:

title - The notification title. Can be null when the notification isn't meant to have one.

message - The notification message. Can be null when the notification isn't meant to have one.

orientation - The text orientation, either LEFT_TO_RIGHT or RIGHT_TO_LEFT.

type - The notification type. Check the type contans in the class for the ones you can use.

icon - The icon to display. Can be null when the notification isn't meant to have one.

Method Detail

setDefaultTheme

public static void setDefaultTheme(NotifyTheme theme)

Sets the theme to use by default when creating notifications.

Parameters:

theme - The theme to use.

getDefaultTheme

public static NotifyTheme getDefaultTheme()

Gets the theme currently in use when creating notifications.

Returns:

The theme in use.

getDefaultTextOrientation

public static int getDefaultTextOrientation()

Gets the current default text orientation.

Returns:

The text orientation.

See Also:

RIGHT_TO_LEFT, LEFT_TO_RIGHT

setDefaultTextOrientation

public static void setDefaultTextOrientation(int defTextOrientation)

Sets the default text orientation to use for new notifications. Useful for displaying languages that aren't read left-to-right.

Parameters:

defTextOrientation - The new text orientation.

See Also:

RIGHT_TO_LEFT, LEFT_TO_RIGHT

showDesktopMessage

public static void showDesktopMessage(java.lang.String title,
                      java.lang.String message)

Creates and shows a new notification. If there isn't an instance of the DesktopNotifyDriver thread running, it will be created and started to show your notification window. This notification does not bring any icon. Notifications created from this method will stay on screen until the user clicks it. No actions can be specified from this method.

Parameters:

title - The title, if any.

message - The message, if any.

showDesktopMessage

public static void showDesktopMessage(java.lang.String title,
                      java.lang.String message,
                      int type)

Creates and shows a new notification. If there isn't an instance of the DesktopNotifyDriver thread running, it will be created and started to show your notification window. A default icon will be used, depending of the type, unless it is DEFAULT. A DEFAULT type notification does not bring an icon by default, no matter how ironic this sounds. Notifications created from this method will stay on screen until the user clicks it. No actions can be specified from this method.

Parameters:

title - The title, if any.

message - The message, if any.

type - An int that denotes a valid message type. Invalid values will be treated as DEFAULT.

showDesktopMessage

public static void showDesktopMessage(java.lang.String title,
                      java.lang.String message,
                      int type,
                      java.awt.event.ActionListener action)

Creates and shows a new notification. If there isn't an instance of the DesktopNotifyDriver thread running, it will be created and started to show your notification window. A default icon will be used, depending of the type, unless it is DEFAULT. A DEFAULT type notification does not bring an icon by default, no matter how ironic this sounds. Notifications created from this method will stay on screen until the user clicks it, firing the action specified (if any).

Parameters:

title - The title, if any.

message - The message, if any.

type - An int that denotes a valid message type. Invalid values will be treated as DEFAULT.

action - An ActionListener with the action to execute when the user clicks the notification.

showDesktopMessage

public static void showDesktopMessage(java.lang.String title,
                      java.lang.String message,
                      int type,
                      java.awt.Image icon,
                      java.awt.event.ActionListener action)

Creates and shows a new notification. If there isn't an instance of the DesktopNotifyDriver thread running, it will be created and started to show your notification window. Notifications created from this method will stay on screen until the user clicks it, firing the action specified (if any).

Parameters:

title - The title, if any.

message - The message, if any.

type - An int that denotes a valid message type. Invalid values will be treated as DEFAULT.

icon - A custom Image to use instead of the default icon assigned by type.

action - An ActionListener with the action to execute when the user clicks the notification.

showDesktopMessage

public static void showDesktopMessage(java.lang.String title,
                      java.lang.String message,
                      int type,
                      long maxTimeMillis)

Creates and shows a new notification. If there isn't an instance of the DesktopNotifyDriver thread running, it will be created and started to show your notification window. A default icon will be used, depending of the type, unless it is DEFAULT. A DEFAULT type notification does not bring an icon by default, no matter how ironic this sounds. No actions can be specified from this method.

Parameters:

title - The title, if any.

message - The message, if any.

type - An int that denotes a valid message type. Invalid values will be treated as DEFAULT.

maxTimeMillis - The maximum time in milliseconds that this notification will stay on the screen. If set to 0, the user will have to close it manually by clicking it.

showDesktopMessage

public static void showDesktopMessage(java.lang.String title,
                      java.lang.String message,
                      int type,
                      long maxTimeMillis,
                      java.awt.event.ActionListener action)

Creates and shows a new notification. If there isn't an instance of the DesktopNotifyDriver thread running, it will be created and started to show your notification window. A default icon will be used, depending of the type, unless it is DEFAULT. A DEFAULT type notification does not bring an icon by default, no matter how ironic this sounds.

Parameters:

title - The title, if any.

message - The message, if any.

type - An int that denotes a valid message type. Invalid values will be treated as DEFAULT.

maxTimeMillis - The maximum time in milliseconds that this notification will stay on the screen. If set to 0, the user will have to close it manually by clicking it. Such value is recommended if you want to add an action for it.

action - An ActionListener with the action to execute when the user clicks the notification.

showDesktopMessage

public static void showDesktopMessage(java.lang.String title,
                      java.lang.String message,
                      int type,
                      java.awt.Image icon)

Creates and shows a new notification. If there isn't an instance of the DesktopNotifyDriver thread running, it will be created and started to show your notification window. Notifications created from this method will stay on screen until the user clicks it. No actions can be specified from this method.

Parameters:

title - The title, if any.

message - The message, if any.

type - An int that denotes a valid message type. Invalid values will be treated as DEFAULT.

icon - A custom Image to use instead of the default icon assigned by type.

showDesktopMessage

public static void showDesktopMessage(java.lang.String title,
                      java.lang.String message,
                      int type,
                      java.awt.Image icon,
                      java.awt.event.ActionListener action,
                      long maxTimeMillis)

Creates and shows a new notification. If there isn't an instance of the DesktopNotifyDriver thread running, it will be created and started to show your notification window.

Parameters:

title - The title, if any.

message - The message, if any.

type - An int that denotes a valid message type. Invalid values will be treated as DEFAULT.

icon - A custom Image to use instead of the default icon assigned by type.

maxTimeMillis - The maximum time in milliseconds that this notification will stay on the screen. If set to 0, the user will have to close it manually by clicking it. Such value recommended if you want to add an action for it.

action - An ActionListener with the action to execute if the user clicks the notification.

getTheme

public NotifyTheme getTheme()

Returns:

The NotifyTheme in use for this notification.

setTheme

public void setTheme(NotifyTheme theme)

Allows to set a NotifyTheme for this notification. One of these defines stuff as the colors for text and background, the fonts and even images for the default icons.

Parameters:

theme - The NotifyTheme to use for this notification.

getAction

public java.awt.event.ActionListener getAction()

Returns:

the ActionListener binded to this notification.

setAction

public void setAction(java.awt.event.ActionListener action)

Allows to bind an action to this notification. It will be executed when the notification gets clicked. Notifications with an action set will wait for the user to click them.

Parameters:

action - he ActionListener to bind to this notification.

setTimeout

public void setTimeout(long millis)

Allows to set a timeout for this notification, in milliseconds. After the time is 'out', and if there isn't an action set, the notification will just fade away.

Parameters:

millis - the timeout.

expTime

protected long expTime()

show

public void show()

Polls the Driver in order to show this notification, so you don't have to do it yourself.

hide

public void hide()

Hides this notification immediately if it is already being displayed. The action itself is handled by the Driver, this method only marks this notification for hiding.

setWidth

protected void setWidth(int w)

isVisible

public boolean isVisible()

Returns:

true if this notification is currently being shown.

setVisible

protected void setVisible(boolean visible)

Used by he driver to mark this notification as visible or not.

Parameters:

visible - true if the notification is currently visible.

render

public void render(int x,
          int y,
          boolean hover,
          java.awt.Graphics2D rd,
          long l)

The painting routine for the notification goes here.

Parameters:

x - Where to start painting (X)

y - Where to start painting (Y)

hover - A boolean that is true if the user is hovering this notification with the mouse pointer.

rd - The Graphics2D object to use for painting.

l - The current time.

sortMessage

protected void sortMessage()

Splits the words of the text across lines that fit inside the notification. It is called by the DesktopNotifyDriver.

setLogLevel

public static void setLogLevel(int level)

Allows to specify the level allowed for logging messages. Attempts to log messages with a priority level below what's been set will be ignored.

Parameters:

level - The logging priority level to allow as minimum.

getLogLevel

public static int getLogLevel()

Returns the level allowed for logging messages. Attempts to log messages with a priority level below what's been set will be ignored.

Returns:

The logging priority level curently allowed as minimum.

setLogOutput

public static void setLogOutput(java.io.OutputStream outStream)

logDebug

public static void logDebug(java.lang.String tag,
            java.lang.String message)

Logs a debug message. Parameters can't be null.

Parameters:

tag - The tag associated to this message.

message - The message to include.

logInfo

public static void logInfo(java.lang.String tag,
           java.lang.String message)

Logs an information message. Parameters can't be null.

Parameters:

tag - The tag associated to this message.

message - The message to include.

logWarning

public static void logWarning(java.lang.String tag,
              java.lang.String message)

Logs a warning message. Parameters can't be null.

Parameters:

tag - The tag associated to this message.

message - The message to include.

logError

public static void logError(java.lang.String tag,
            java.lang.String message,
            java.lang.Throwable tr)

Logs an error message. Parameters other than the caught throwable can't be null.

Parameters:

tag - The tag associated to this message.

message - The message to include.

tr - A Throable object (an Exception, for example), whose message and stack trace should be logged too.