Class NotificationBuilder

java.lang.Object

ch.swingfx.twinkle.NotificationBuilder

public class NotificationBuilder
extends Object

This class lets you build a notification window.

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	ANIMATION_FADE_IN_DURATION	Duration of the fade in animation in milliseconds
private static final int	ANIMATION_FADE_IN_START_DELAY	delay before we start the fade in animation because of flickering on some systems/jres.
private static final int	ANIMATION_FADE_OUT_DURATION	Duration of the fade out animation in milliseconds
private static final int	DEFAULT_DISPLAY_TIME_IN_MILLIS	The default display time for a notification in milliseconds
private int	fDisplayTime	Time in millis we want to display the notification
private boolean	fFadeIn	Flag that tells us if we should fade in the notification
private boolean	fFadeOut	Flag that tells us if we should fade out the notification
private Icon	fIcon	The Icon we want to display
private final UUID	fId	id of this NotificationBuilder.
private INotificationManager	fManager	The manager that shows the notifications
private String	fMessage	The message we want to display
private INotificationEventListener	fNotificationListener	Listener that receives notification events
private IPosition	fPosition	Position of the notification
private INotificationStyle	fStyle	styling for our window
private String	fTitle	The title we want to display
private boolean	fWindowClosed	Flag that tells us if the window is closed or not
private static final GraphicsDevice	sMainScreen
private static final GraphicsConfiguration	sMainScreenGraphicsConfiguration
private static Insets	sMainScreenInsets	Insets of menu/task bars
private static final Dimension	sMainScreenSize	The size of the main screen including all the menu/task bars
private static final Toolkit	sToolkit
private static final ch.swingfx.window.translucentandshaped.ITranslucentAndShapedWindowApi	sWindowApi	api for Translucent and Shaped Windows
private static final int	version	version of the library

Constructor Summary

Constructors

Constructor	Description
NotificationBuilder()

Method Summary

Modifier and Type	Method	Description
private void	closeWindow(JWindow window)	Closes the window
INotificationStyle	getStyle()	Get the INotificationStyle of this notification
UUID	showNotification()	shows the notification
private void	showNotificationEDT()
NotificationBuilder	withDisplayTime(int timeInMillis)	set the time the notification should be displayed
NotificationBuilder	withFadeInAnimation(boolean animate)	set true if you want to fade in the notification. Note fade in is not supported on all platform.
NotificationBuilder	withFadeOutAnimation(boolean animate)	set true if you want to fade out the notification. Note fade out is not supported on all platform.
NotificationBuilder	withIcon(String iconPath)	set the icon of the notification
NotificationBuilder	withIcon(Icon icon)	set the icon of the notification
NotificationBuilder	withListener(INotificationEventListener listener)	Sets a INotificationEventListener for receiving events from the notification
NotificationBuilder	withMessage(String message)	set the message of the notification
NotificationBuilder	withNotificationManager(INotificationManager manager)	Set the INotificationManager that handles how the notification are displayed
NotificationBuilder	withPosition(IPosition position)	Set the position of the notification
NotificationBuilder	withStyle(INotificationStyle style)	set the style of the notification
NotificationBuilder	withTitle(String title)	set the title of the notification

Methods inherited from class Object

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

Field Details

version

private static final int version

version of the library

See Also:

• Constant Field Values

ANIMATION_FADE_IN_DURATION

private static final int ANIMATION_FADE_IN_DURATION

Duration of the fade in animation in milliseconds

See Also:

• Constant Field Values

ANIMATION_FADE_OUT_DURATION

private static final int ANIMATION_FADE_OUT_DURATION

Duration of the fade out animation in milliseconds

See Also:

• Constant Field Values

ANIMATION_FADE_IN_START_DELAY

private static final int ANIMATION_FADE_IN_START_DELAY

delay before we start the fade in animation because of flickering on some systems/jres.

See Also:

• Constant Field Values

DEFAULT_DISPLAY_TIME_IN_MILLIS

private static final int DEFAULT_DISPLAY_TIME_IN_MILLIS

The default display time for a notification in milliseconds

See Also:

• Constant Field Values

fId

private final UUID fId

id of this NotificationBuilder. Sent in NotificationEvent

fIcon

private Icon fIcon

The Icon we want to display

fTitle

private String fTitle

The title we want to display

fMessage

private String fMessage

The message we want to display

fDisplayTime

private int fDisplayTime

Time in millis we want to display the notification

fNotificationListener

private INotificationEventListener fNotificationListener

Listener that receives notification events

fStyle

private INotificationStyle fStyle

styling for our window

fPosition

private IPosition fPosition

Position of the notification

fFadeIn

private boolean fFadeIn

Flag that tells us if we should fade in the notification

fFadeOut

private boolean fFadeOut

Flag that tells us if we should fade out the notification

fWindowClosed

private boolean fWindowClosed

Flag that tells us if the window is closed or not

fManager

private INotificationManager fManager

The manager that shows the notifications

sWindowApi

private static final ch.swingfx.window.translucentandshaped.ITranslucentAndShapedWindowApi sWindowApi

api for Translucent and Shaped Windows

sMainScreen

private static final GraphicsDevice sMainScreen

sMainScreenGraphicsConfiguration

private static final GraphicsConfiguration sMainScreenGraphicsConfiguration

sMainScreenSize

private static final Dimension sMainScreenSize

The size of the main screen including all the menu/task bars

sMainScreenInsets

private static Insets sMainScreenInsets

Insets of menu/task bars

sToolkit

private static final Toolkit sToolkit

Constructor Details

NotificationBuilder

public NotificationBuilder()

Method Details

withStyle

public NotificationBuilder withStyle(INotificationStyle style)

set the style of the notification

Parameters:

style - the style of the notification

Returns:

this NotificationBuilder

withIcon

public NotificationBuilder withIcon(String iconPath)

set the icon of the notification

Parameters:

iconPath - path to the icon

Returns:

this NotificationBuilder

withIcon

public NotificationBuilder withIcon(Icon icon)

set the icon of the notification

Parameters:

icon - the icon

Returns:

this NotificationBuilder

withTitle

public NotificationBuilder withTitle(String title)

set the title of the notification

Parameters:

title - the title

Returns:

this NotificationBuilder

withMessage

public NotificationBuilder withMessage(String message)

set the message of the notification

Parameters:

message - the message

Returns:

this NotificationBuilder

withDisplayTime

public NotificationBuilder withDisplayTime(int timeInMillis)

set the time the notification should be displayed

Parameters:

timeInMillis - time in milliseconds. minimum 1000

Returns:

this NotificationBuilder

withPosition

public NotificationBuilder withPosition(IPosition position)

Set the position of the notification

Parameters:

position - position of the notification

Returns:

this NotificationBuilder

withFadeInAnimation

public NotificationBuilder withFadeInAnimation(boolean animate)

set true if you want to fade in the notification.
Note fade in is not supported on all platform. If it doesn't work on a platform it will use no animation.

Parameters:

animate - true if you want to fade in the notification

Returns:

this NotificationBuilder

withFadeOutAnimation

public NotificationBuilder withFadeOutAnimation(boolean animate)

set true if you want to fade out the notification.
Note fade out is not supported on all platform. If it doesn't work on a platform it will use no animation.

Parameters:

animate - true if you want to fade in the notification

Returns:

this NotificationBuilder

withListener

public NotificationBuilder withListener(INotificationEventListener listener)

Sets a INotificationEventListener for receiving events from the notification

Parameters:

listener - listener to add

Returns:

this NotificationBuilder

withNotificationManager

public NotificationBuilder withNotificationManager(INotificationManager manager)

Set the INotificationManager that handles how the notification are displayed

Parameters:

manager - INotificationManager to use

Returns:

this NotificationBuilder

getStyle

public INotificationStyle getStyle()

Get the INotificationStyle of this notification

Returns:

the INotificationStyle of this notification

showNotification

public UUID showNotification()

shows the notification

Returns:

Unique identifier for this notification. Call NotificationEvent.getId() to retrieve this id

showNotificationEDT

private void showNotificationEDT()

closeWindow

private void closeWindow(JWindow window)

Closes the window

Parameters:

window - the window to close