ds.desktop.notify

Class NotificationBuilder

java.lang.Object

ds.desktop.notify.NotificationBuilder

public class NotificationBuilder
extends java.lang.Object

Utilitary object that allows easy and flexible build of notifications that fit any of your evil interests. For those who want to keep more control on what their notifications show or didn't find any static method that did the trick.

HOW-TO:

1. Instance an object of this class.
   NotificationBuilder builder = new NotificationBuilder();
2. Append all the stuff you want into the builder. For instace:
   builder.setTitle("My title").setMessage("Random message").setIcon(myIcon);
   Just look at how easy is to chain calls with this thing.
3. Build your notification by calling build().
   DesktopNotify notification = builder.build();
4. When you're ready to show the notification, call DesktopNotify.show().
   notification.show();
   You may prefer to chain the calls if you want to show it right now.
   builder.build().show();
   Before you ask, yeah, you can spawn as many notifications as you please at this point, and they'll all look the same.
5. Once you're done, call reset() to begin from scratch if you need to.
   builder.reset();
   There's the method buildAndReset(), if you want to fetch your new notification and erase all the contents set in the builder.
   DesktopNotify notification = builder.buildAndReset();
   It works just like build(), you can even chain calls with this.
   builder.buildAndReset().show();

This class is reusable and not thread-safe.

Since:

05/21/2016 (0.8)

Constructor Summary

Constructors

Constructor and Description
NotificationBuilder() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
DesktopNotify	build() Builds a new DesktopNotify object.
DesktopNotify	buildAndReset() Builds a new DesktopNotify object, and then resets this builder for you to begin bilding the next one from scratch.
void	reset() Clears all saved data and sets this builder in blank, so you can start from scratch again.
NotificationBuilder	setAction(java.awt.event.ActionListener action) Sets the ActionListener to use in the notification to build.
NotificationBuilder	setIcon(java.awt.Image icon) Sets the icon for the notification to build.
NotificationBuilder	setMessage(java.lang.String message) Sets the message for the notification to build.
NotificationBuilder	setTextOrientation(int orientation) Sets the prefered orientation of the text to be displayed, this determines the default text alignment.
NotificationBuilder	setTheme(NotifyTheme theme) Sets the theme to use in the notification to build.
NotificationBuilder	setTimeOut(long timeOut) Sets the timeout for the notification to build.
NotificationBuilder	setTitle(java.lang.String title) Sets the title for the notification to build.
NotificationBuilder	setType(int type) Sets the type of notification to build.

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationBuilder

public NotificationBuilder()

Default constructor.

Method Detail

setTitle

public NotificationBuilder setTitle(java.lang.String title)

Sets the title for the notification to build.

Parameters:

title - The title.

Returns:

This builder, just to chain calls.

setMessage

public NotificationBuilder setMessage(java.lang.String message)

Sets the message for the notification to build.

Parameters:

message - The message.

Returns:

This builder, just to chain calls.

setIcon

public NotificationBuilder setIcon(java.awt.Image icon)

Sets the icon for the notification to build.

Parameters:

icon - The icon.

Returns:

This builder, just to chain calls.

setType

public NotificationBuilder setType(int type)

Sets the type of notification to build.

Parameters:

type - The type of notification.

Returns:

This builder, just to chain calls.

setTextOrientation

public NotificationBuilder setTextOrientation(int orientation)

Sets the prefered orientation of the text to be displayed, this determines the default text alignment.

Parameters:

orientation - The text orientation, either DesktopNotify.LEFT_TO_RIGHT or DesktopNotify.RIGHT_TO_LEFT.

Returns:

This builder, just to chain calls.

setTimeOut

public NotificationBuilder setTimeOut(long timeOut)

Sets the timeout for the notification to build. Setting 0 will make the built notification to stay on screen until the user clicks it.

Parameters:

timeOut - The maximum time in milliseconds this notification will stay on screen.

Returns:

This builder, just to chain calls.

setAction

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

Sets the ActionListener to use in the notification to build.

Parameters:

action - The ActionListener to use in the notification.

Returns:

This builder, just to chain calls.

setTheme

public NotificationBuilder setTheme(NotifyTheme theme)

Sets the theme to use in the notification to build.

Parameters:

theme - The theme to use in the notification.

Returns:

This builder, just to chain calls.

build

public DesktopNotify build()

Builds a new DesktopNotify object. Once you've got to this point, apend a call to DesktopNotify.show() to make it appear inmmediately or just hold onto it until you need to show it. You may continue from the current state in order to customize and build a new notification.

Returns:

A brand new and fully customized DesktopNotify object for it to be used in any of your evil interests.

reset

public void reset()

Clears all saved data and sets this builder in blank, so you can start from scratch again.

buildAndReset

public DesktopNotify buildAndReset()

Builds a new DesktopNotify object, and then resets this builder for you to begin bilding the next one from scratch. Once you've got to this point, apend a call to DesktopNotify.show() to make it appear inmmediately or just hold onto it until you need to show it.

Returns:

A brand new and fully customized DesktopNotify object for it to be used in any of your evil interests.