ds.desktop.notify

Class NotifyTheme

java.lang.Object

ds.desktop.notify.NotifyTheme

Direct Known Subclasses:

NotifyTheme.DarkTheme, NotifyTheme.LightTheme

public class NotifyTheme
extends java.lang.Object

A NotifyTheme defines the aspect of a desktop notification. You can specify custom colors, icons and fonts to use instead of the two default themes. By the way, the default themes included are NotifyTheme.Dark and NotifyTheme.Light.

Since:

0.8

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NotifyTheme.DarkTheme The default Dark theme.
static class	NotifyTheme.LightTheme The default Light theme.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Color[]	bgGrad The colors to use to paint the background
protected java.awt.Color	borderColor The color to use to paint the notification border
protected java.awt.Color	contentColor The color to use to paint the description text
protected java.awt.Font	contentFont The font to use in the description text
static NotifyTheme	Dark The default Dark theme
static java.awt.Image[]	defaultIconSet The default set of icons
protected java.awt.Image[]	iconSet The set of icons to use for each notification type
static NotifyTheme	Light The default Light theme
protected java.awt.Color	titleColor The color to use to paint the title
protected java.awt.Font	titleFont The font to use in titles

Constructor Summary

Constructors

Constructor and Description
NotifyTheme()

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Color[]	getBgGrad()
java.awt.Color	getBorderColor()
java.awt.Font	getContentFont()
java.awt.Image[]	getIconSet()
java.awt.Font	getTitleFont()
void	setBgGrad(java.awt.Color base, java.awt.Color highlight) Allows to define the background color in a notification.
void	setBorderColor(java.awt.Color notifBorder) Allows to set a color for the borders of the notification.
void	setContentFont(java.awt.Font contentFont) Allows to set a font to be used for texts.
void	setIconSet(java.awt.Image[] iconSet) Allows to set a collection of icons to be used in this theme.
void	setTitleFont(java.awt.Font titleFont) Allows to set a font to be used for texts.

Methods inherited from class java.lang.Object

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

Field Detail

titleFont

protected java.awt.Font titleFont

The font to use in titles

contentFont

protected java.awt.Font contentFont

The font to use in the description text

borderColor

protected java.awt.Color borderColor

The color to use to paint the notification border

titleColor

protected java.awt.Color titleColor

The color to use to paint the title

contentColor

protected java.awt.Color contentColor

The color to use to paint the description text

bgGrad

protected java.awt.Color[] bgGrad

The colors to use to paint the background

iconSet

protected java.awt.Image[] iconSet

The set of icons to use for each notification type

Dark

public static final NotifyTheme Dark

The default Dark theme

Light

public static final NotifyTheme Light

The default Light theme

defaultIconSet

public static final java.awt.Image[] defaultIconSet

The default set of icons

Constructor Detail

NotifyTheme

public NotifyTheme()

Method Detail

getBgGrad

public java.awt.Color[] getBgGrad()

Returns:

The background colors to use in the theme (regular background and highlighted gradient), stored in an array.

setBgGrad

public void setBgGrad(java.awt.Color base,
             java.awt.Color highlight)

Allows to define the background color in a notification. The gradient colors are precalculated to save CPU later.

Parameters:

base - The regular background color.

highlight - The color to apply a gradient with when the mouse pointer is on the notification.

getContentFont

public java.awt.Font getContentFont()

Returns:

The font being used for texts.

setContentFont

public void setContentFont(java.awt.Font contentFont)

Allows to set a font to be used for texts.

Parameters:

contentFont - the font which will be used for texts.

getIconSet

public java.awt.Image[] getIconSet()

Returns:

An array containing the set of icons being used in this theme.

setIconSet

public void setIconSet(java.awt.Image[] iconSet)

Allows to set a collection of icons to be used in this theme. The icons should have a resolution of 32x32 pixels. Images that don't comply with this will be scaled during the painting.

Parameters:

iconSet - An array containing the set of icons which will be used in this theme.

getBorderColor

public java.awt.Color getBorderColor()

Returns:

The color of the border for this theme.

setBorderColor

public void setBorderColor(java.awt.Color notifBorder)

Allows to set a color for the borders of the notification.

Parameters:

notifBorder - The color of the border to be used in this theme.

getTitleFont

public java.awt.Font getTitleFont()

Returns:

The font being used for titles.

setTitleFont

public void setTitleFont(java.awt.Font titleFont)

Allows to set a font to be used for texts.

Parameters:

titleFont - the font which will be used for titles.