me.muizers.Notifications

Class Notification

java.lang.Object

me.muizers.Notifications.Notification

public class Notification
extends java.lang.Object

Represents a notification that can be sent to the desktop.

Since:

API 1.0

Version:

API 1.1

Author:

Muizers

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Color	defaultBackgroundColor The default background color
static java.awt.Color	defaultFirstLineColor The default color for the first line of notifications
static int	defaultHeight The default height of notifications
static java.awt.Color	defaultMouseOverBackgroundColor The default mouse-over background color
static java.awt.Color	defaultSecondLineColor The default color for the second line of notifications
static java.awt.Color	defaultTitleColor The default color for the title of notifications
static int	defaultWidth The default width of notifications

Constructor Summary

Constructors

Constructor and Description
Notification() Constructs a Notification
Notification(java.lang.String firstLine) Constructs a Notification
Notification(java.lang.String firstLine, java.lang.String secondLine) Constructs a Notification
Notification(java.lang.String title, java.lang.String firstLine, java.lang.String secondLine) Constructs a Notification
Notification(java.lang.String title, java.lang.String firstLine, java.lang.String secondLine, java.awt.Color titleColor, java.awt.Color firstLineColor, java.awt.Color secondLineColor) Constructs a Notification
Notification(java.lang.String title, java.lang.String firstLine, java.lang.String secondLine, java.awt.Color titleColor, java.awt.Color firstLineColor, java.awt.Color secondLineColor, int width) Constructs a Notification
Notification(java.lang.String title, java.lang.String firstLine, java.lang.String secondLine, java.awt.Color titleColor, java.awt.Color firstLineColor, java.awt.Color secondLineColor, int width, java.awt.Color backgroundColor, java.awt.Color mouseOverBackgroundColor) Constructs a Notification

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Color	getBackgroundColor() Gets the background color
java.lang.String	getFirstLine() Gets the text in the first line
java.awt.Color	getFirstLineColor() Gets the color of the first line
int	getHeight() Gets the height
java.awt.Color	getMouseOverBackgroundColor() Gets the mouse-over background color
java.lang.String	getSecondLine() Gets the text in the second line
java.awt.Color	getSecondLineColor() Gets the color of the second line
java.lang.String	getTitle() Gets the text in the title
java.awt.Color	getTitleColor() Gets the color of the title
int	getWidth() Gets the width
void	setBackgroundColor(java.awt.Color color) Sets the background color
void	setFirstLine(java.lang.String text) Sets the text in the first line
void	setFirstLine(java.lang.String text, java.awt.Color color) Sets the text and color of the first line
void	setFirstLineColor(java.awt.Color color) Sets the color of the first line
void	setMouseOverBackgroundColor(java.awt.Color color) Sets the mouse-over background color
void	setSecondLine(java.lang.String text) Sets the text in the second line
void	setSecondLine(java.lang.String text, java.awt.Color color) Sets the text and color of the second line
void	setSecondLineColor(java.awt.Color color) Sets the color of the second line
void	setTitle(java.lang.String text) Sets the text in the title
void	setTitle(java.lang.String text, java.awt.Color color) Sets the text and color of the title
void	setTitleColor(java.awt.Color color) Sets the color of the title
void	setWidth(int width) Sets the width
boolean	show() Shows this notification on the desktop

Methods inherited from class java.lang.Object

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

Field Detail

defaultTitleColor

public static java.awt.Color defaultTitleColor

The default color for the title of notifications

Since:

API 1.0

defaultFirstLineColor

public static java.awt.Color defaultFirstLineColor

The default color for the first line of notifications

Since:

API 1.0

defaultSecondLineColor

public static java.awt.Color defaultSecondLineColor

The default color for the second line of notifications

Since:

API 1.0

defaultWidth

public static int defaultWidth

The default width of notifications

Since:

API 1.1

defaultHeight

public static int defaultHeight

The default height of notifications

Since:

API 1.1

defaultBackgroundColor

public static java.awt.Color defaultBackgroundColor

The default background color

Since:

API 1.1

defaultMouseOverBackgroundColor

public static java.awt.Color defaultMouseOverBackgroundColor

The default mouse-over background color

Since:

API 1.1

Constructor Detail

Notification

public Notification()

Constructs a Notification

Since:

API 1.1

Notification

public Notification(java.lang.String firstLine)

Constructs a Notification

Parameters:

firstLine - The text in the first line

Since:

API 1.0

Notification

public Notification(java.lang.String firstLine,
            java.lang.String secondLine)

Constructs a Notification

Parameters:

firstLine - The text in the first line

secondLine - The text in the second line

Since:

API 1.0

Notification

public Notification(java.lang.String title,
            java.lang.String firstLine,
            java.lang.String secondLine)

Constructs a Notification

Parameters:

title - The text in the title

firstLine - The text in the first line

secondLine - The text in the second line

Since:

API 1.0

Notification

public Notification(java.lang.String title,
            java.lang.String firstLine,
            java.lang.String secondLine,
            java.awt.Color titleColor,
            java.awt.Color firstLineColor,
            java.awt.Color secondLineColor)

Constructs a Notification

Parameters:

title - The text in the title

firstLine - The text in the first line

secondLine - The text in the second line

titleColor - The color of the title

firstLineColor - The color of the first line

secondLineColor - The color of the second line

Since:

API 1.0

Notification

public Notification(java.lang.String title,
            java.lang.String firstLine,
            java.lang.String secondLine,
            java.awt.Color titleColor,
            java.awt.Color firstLineColor,
            java.awt.Color secondLineColor,
            int width)

Constructs a Notification

Parameters:

title - The text in the title

firstLine - The text in the first line

secondLine - The text in the second line

titleColor - The color of the title

firstLineColor - The color of the first line

secondLineColor - The color of the second line

width - The width

Since:

API 1.1

Notification

public Notification(java.lang.String title,
            java.lang.String firstLine,
            java.lang.String secondLine,
            java.awt.Color titleColor,
            java.awt.Color firstLineColor,
            java.awt.Color secondLineColor,
            int width,
            java.awt.Color backgroundColor,
            java.awt.Color mouseOverBackgroundColor)

Constructs a Notification

Parameters:

title - The text in the title

firstLine - The text in the first line

secondLine - The text in the second line

titleColor - The color of the title

firstLineColor - The color of the first line

secondLineColor - The color of the second line

width - The width

backgroundColor - The background color of the notification

mouseOverBackgroundColor - The mouse-over background color of the notificiation

Since:

API 1.1

Method Detail

getTitle

public java.lang.String getTitle()

Gets the text in the title

Returns:

The text

Since:

API 1.0

getFirstLine

public java.lang.String getFirstLine()

Gets the text in the first line

Returns:

The text

Since:

API 1.0

getSecondLine

public java.lang.String getSecondLine()

Gets the text in the second line

Returns:

The text

Since:

API 1.0

getTitleColor

public java.awt.Color getTitleColor()

Gets the color of the title

Returns:

The color

Since:

API 1.0

getFirstLineColor

public java.awt.Color getFirstLineColor()

Gets the color of the first line

Returns:

The color

Since:

API 1.0

getSecondLineColor

public java.awt.Color getSecondLineColor()

Gets the color of the second line

Returns:

The color

Since:

API 1.0

getWidth

public int getWidth()

Gets the width

Returns:

The width

Since:

API 1.1

getHeight

public int getHeight()

Gets the height

Returns:

The height

Since:

API 1.1

getBackgroundColor

public java.awt.Color getBackgroundColor()

Gets the background color

Returns:

The color

Since:

API 1.1

getMouseOverBackgroundColor

public java.awt.Color getMouseOverBackgroundColor()

Gets the mouse-over background color

Returns:

The color

Since:

API 1.1

setTitle

public void setTitle(java.lang.String text,
            java.awt.Color color)

Sets the text and color of the title

Parameters:

text - The text

color - The color

Since:

API 1.0

setFirstLine

public void setFirstLine(java.lang.String text,
                java.awt.Color color)

Sets the text and color of the first line

Parameters:

text - The text

color - The color

Since:

API 1.0

setSecondLine

public void setSecondLine(java.lang.String text,
                 java.awt.Color color)

Sets the text and color of the second line

Parameters:

text - The text

color - The color

Since:

API 1.0

setTitle

public void setTitle(java.lang.String text)

Sets the text in the title

Parameters:

text - The text

Since:

API 1.0

setFirstLine

public void setFirstLine(java.lang.String text)

Sets the text in the first line

Parameters:

text - The text

Since:

API 1.0

setSecondLine

public void setSecondLine(java.lang.String text)

Sets the text in the second line

Parameters:

text - The text

Since:

API 1.0

setTitleColor

public void setTitleColor(java.awt.Color color)

Sets the color of the title

Parameters:

color - The color

Since:

API 1.0

setFirstLineColor

public void setFirstLineColor(java.awt.Color color)

Sets the color of the first line

Parameters:

color - The color

Since:

API 1.0

setSecondLineColor

public void setSecondLineColor(java.awt.Color color)

Sets the color of the second line

Parameters:

color - The color

Since:

API 1.0

setWidth

public void setWidth(int width)

Sets the width

Parameters:

width - The width

Since:

API 1.1

setBackgroundColor

public void setBackgroundColor(java.awt.Color color)

Sets the background color

Parameters:

color - The color

Since:

API 1.1

setMouseOverBackgroundColor

public void setMouseOverBackgroundColor(java.awt.Color color)

Sets the mouse-over background color

Parameters:

color - The color

Since:

API 1.1

show

public boolean show()

Shows this notification on the desktop

Returns:

Whether the notification was shown

Since:

API 1.1