Skip to content

API Structure

Jump to bottom Edit New page
Samuel Pfrommer edited this page May 6, 2017 · 2 revisions

JCommunique has a very easy to use API. Detailed javadocs are available in the JCommunique jar. The general breakdown is as follows:

Notification

A Notification is a notification that appears on the Desktop. This class is extendable, but to create custom Notifications it is more desirable to extend WindowNotification or IconNotification. More information on this is available on the wiki section for creating custom Notifications. The complete list of Notification types is available here.

NotificationFactory

A NotificationFactory builds Notifications using the theme package provided. This class should not be extended, but it is possible to add more NotificationBuilders if custom Notifications are added. The NotificationFactory comes with a number of methods for making the default Notifications.

NotificationManager

A NotificationManager manages Notifications built by the NotificationFactory. The jobs of the NotificationManager include handling fading, popup location, and movement. It is possible to create your own manager by extending NotificationManager. The complete list of NotificationManagers is available here.

Additional Features

JCommunique also offers the following:

  1. IconUtils for reading and scaling icons from files

  2. Easy automatic Notification adjustment based on platform

Add a custom footer

Home

How to Use

  1. API Structure

  2. Default Notifications and NotificationManagers

  3. Custom Notifications

  4. Custom Managers

  5. Examples

Clone this wiki locally