|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.growl.Growl
public class Growl
A class that encapsulates the "work" of talking to growl
Field Summary | |
---|---|
static java.lang.String |
GROWL_APP_ICON
Ticket key for the application icon. |
static java.lang.String |
GROWL_APP_NAME
Ticket key for the application name. |
static java.lang.String |
GROWL_APP_REGISTRATION
The name of the growl registration notification for DNC. |
static java.lang.String |
GROWL_NOTIFICATION
The name of the growl notification for DNC. |
static java.lang.String |
GROWL_NOTIFICATION_APP_ICON
Notification key for the application icon. |
static java.lang.String |
GROWL_NOTIFICATION_DESCRIPTION
Notification key for the description. |
static java.lang.String |
GROWL_NOTIFICATION_ICON
Notification key for the icon. |
static java.lang.String |
GROWL_NOTIFICATION_NAME
Notification key for the name. |
static java.lang.String |
GROWL_NOTIFICATION_STICKY
Notification key for the sticky flag. |
static java.lang.String |
GROWL_NOTIFICATION_TITLE
Notification key for the title. |
static java.lang.String |
GROWL_NOTIFICATIONS_ALL
Ticket key for all notifactions. |
static java.lang.String |
GROWL_NOTIFICATIONS_DEFAULT
Ticket key for the default notifactions. |
Constructor Summary | |
---|---|
Growl(java.lang.String inAppName,
com.apple.cocoa.foundation.NSData inImageData)
Convenience method to contruct a growl instance, defers to Growl(String inAppName, NSData inImageData, NSArray inAllNotes, NSArray inDefNotes, boolean registerNow) with empty arrays for your notifications. |
|
Growl(java.lang.String inAppName,
com.apple.cocoa.foundation.NSData inImageData,
com.apple.cocoa.foundation.NSArray inAllNotes,
com.apple.cocoa.foundation.NSArray inDefNotes,
boolean registerNow)
Convenience method to contruct a growl instance, defers to Growl(String inAppName, NSData inImageData, NSArray inAllNotes, NSArray inDefNotes, boolean registerNow) with empty arrays for your notifications. |
|
Growl(java.lang.String inAppName,
com.apple.cocoa.application.NSImage inImage)
Convenience method to contruct a growl instance, defers to Growl(String inAppName, NSData inImageData, NSArray inAllNotes, NSArray inDefNotes, boolean registerNow) with empty arrays for your notifications. |
|
Growl(java.lang.String inAppName,
java.lang.String inImagePath)
Convenience method to contruct a growl instance, defers to Growl(String inAppName, NSData inImageData, NSArray inAllNotes, NSArray inDefNotes, boolean registerNow) with empty arrays for your notifications. |
|
Growl(java.lang.String inAppName,
java.lang.String[] inAllNotes,
java.lang.String[] inDefNotes)
Convenience method to contruct a growl instance, defers to Growl(String inAppName, NSData inImageData, NSArray inAllNotes, NSArray inDefNotes, boolean registerNow) with the arrays passed here and empty Data for the icon. |
Method Summary | |
---|---|
com.apple.cocoa.foundation.NSArray |
allowedNotifications()
Accessor for the Array of allowed Notifications returned an NSArray |
java.lang.String |
applicationName()
Accessor for The currently set "Application" Name |
com.apple.cocoa.foundation.NSArray |
defaultNotifications()
Accessor for the Array of default Notifications returned as an NSArray |
void |
notifyGrowlOf(java.lang.String inNotificationName,
com.apple.cocoa.foundation.NSData inIconData,
java.lang.String inTitle,
java.lang.String inDescription,
com.apple.cocoa.foundation.NSDictionary inExtraInfo)
Convenience method that defers to notifyGrowlOf(String inNotificationName, NSData inIconData, String inTitle, String inDescription, NSDictionary inExtraInfo, boolean inSticky) This is primarily for compatibility with older code |
void |
notifyGrowlOf(java.lang.String inNotificationName,
com.apple.cocoa.foundation.NSData inIconData,
java.lang.String inTitle,
java.lang.String inDescription,
com.apple.cocoa.foundation.NSDictionary inExtraInfo,
boolean inSticky)
The fun part is actually sending those notifications we worked so hard for so here we let growl know about things we think the user would like, and growl decides if that is the case. |
void |
notifyGrowlOf(java.lang.String inNotificationName,
com.apple.cocoa.application.NSImage inImage,
java.lang.String inTitle,
java.lang.String inDescription,
com.apple.cocoa.foundation.NSDictionary inExtraInfo)
Defers to notifyGrowlOf(String inNotificationName, NSData inIconData, String inTitle, String inDescription, NSDictionary inExtraInfo) with null passed for icon and extraInfo arguments |
void |
notifyGrowlOf(java.lang.String inNotificationName,
java.lang.String inTitle,
java.lang.String inDescription)
Convenienve method that defers to notifyGrowlOf(String inNotificationName, NSData inIconData, String inTitle, String inDescription, NSDictionary inExtraInfo) with null passed for icon and extraInfo arguments |
void |
notifyGrowlOf(java.lang.String inNotificationName,
java.lang.String inTitle,
java.lang.String inDescription,
boolean inSticky)
Convenience method that defers to notifyGrowlOf(String inNotificationName, NSData inIconData, String inTitle, String inDescription, NSDictionary inExtraInfo, boolean inSticky) with null passed for icon and extraInfo arguments |
void |
notifyGrowlOf(java.lang.String inNotificationName,
java.lang.String inImagePath,
java.lang.String inTitle,
java.lang.String inDescription)
Convenienve method that defers to notifyGrowlOf(String inNotificationName, NSData inIconData, String inTitle, String inDescription, NSDictionary inExtraInfo) with null passed for extraInfo |
boolean |
register()
Register all our notifications with Growl, this should only be called once. |
void |
setAllowedNotifications(com.apple.cocoa.foundation.NSArray inAllNotes)
Set the list of allowed Notifications |
void |
setAllowedNotifications(java.lang.String[] inAllNotes)
Set the list of allowed Notifications |
void |
setApplicationName(java.lang.String inAppName)
Sets The name of the Application talking to growl |
void |
setDefaultNotifications(com.apple.cocoa.foundation.NSArray inDefNotes)
Set the list of Default Notfiications |
void |
setDefaultNotifications(java.lang.String[] inDefNotes)
Set the list of Default Notfiications |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String GROWL_APP_REGISTRATION
public static final java.lang.String GROWL_APP_NAME
public static final java.lang.String GROWL_APP_ICON
public static final java.lang.String GROWL_NOTIFICATIONS_DEFAULT
public static final java.lang.String GROWL_NOTIFICATIONS_ALL
public static final java.lang.String GROWL_NOTIFICATION
public static final java.lang.String GROWL_NOTIFICATION_NAME
public static final java.lang.String GROWL_NOTIFICATION_TITLE
public static final java.lang.String GROWL_NOTIFICATION_DESCRIPTION
public static final java.lang.String GROWL_NOTIFICATION_ICON
public static final java.lang.String GROWL_NOTIFICATION_APP_ICON
public static final java.lang.String GROWL_NOTIFICATION_STICKY
Constructor Detail |
---|
public Growl(java.lang.String inAppName, com.apple.cocoa.application.NSImage inImage)
inAppName
- - The Name of your "application"inImage
- - The NSImage Icon for your Applicationpublic Growl(java.lang.String inAppName, com.apple.cocoa.foundation.NSData inImageData)
inAppName
- - The Name of your "Application"inImageData
- - The NSData for your NSImagepublic Growl(java.lang.String inAppName, java.lang.String inImagePath)
inAppName
- - The Name of your "Application"inImagePath
- - The path to your iconpublic Growl(java.lang.String inAppName, java.lang.String[] inAllNotes, java.lang.String[] inDefNotes)
inAppName
- - The Name of your "Application"inAllNotes
- - A String Array with the name of all your notificationsinDefNotes
- - A String Array with the na,es of the Notifications on
by defaultpublic Growl(java.lang.String inAppName, com.apple.cocoa.foundation.NSData inImageData, com.apple.cocoa.foundation.NSArray inAllNotes, com.apple.cocoa.foundation.NSArray inDefNotes, boolean registerNow)
inAppName
- - The Name of your "Application"inImageData
- - The Data of your "Application"'s iconinAllNotes
- - The NSArray of Strings of all your NotificationsinDefNotes
- - The NSArray of Strings of your default NotificationsregisterNow
- - Since we have all the necessary info we can go ahead
and registerMethod Detail |
---|
public boolean register()
true
.public void notifyGrowlOf(java.lang.String inNotificationName, com.apple.cocoa.foundation.NSData inIconData, java.lang.String inTitle, java.lang.String inDescription, com.apple.cocoa.foundation.NSDictionary inExtraInfo, boolean inSticky) throws java.lang.Exception
inNotificationName
- - The name of one of the notifications we told growl
about.inIconData
- - The NSData for the icon for this notification, can be nullinTitle
- - The Title of our Notification as Growl will show itinDescription
- - The Description of our Notification as Growl will
display itinExtraInfo
- - Growl is flexible and allows Display Plugins to do as they
please with thier own special keys and values, you may use
them here. These may be ignored by either the user's
preferences or the current Display Plugin. This can be nullinSticky
- - Whether the Growl notification should be sticky
java.lang.Exception
- When a notification is not knownpublic void notifyGrowlOf(java.lang.String inNotificationName, com.apple.cocoa.foundation.NSData inIconData, java.lang.String inTitle, java.lang.String inDescription, com.apple.cocoa.foundation.NSDictionary inExtraInfo) throws java.lang.Exception
inNotificationName
- - The name of one of the notifications we told growl
about.inIconData
- - The NSData for the icon for this notification, can be nullinTitle
- - The Title of our Notification as Growl will show itinDescription
- - The Description of our Notification as Growl will
display itinExtraInfo
- - Growl is flexible and allows Display Plugins to do as
they please with their own special keys and values, you
may use them here. These may be ignored by either the
user's preferences or the current Display Plugin. This
can be null.
java.lang.Exception
- When a notification is not knownpublic void notifyGrowlOf(java.lang.String inNotificationName, java.lang.String inTitle, java.lang.String inDescription) throws java.lang.Exception
inNotificationName
- - The name of one of the notifications we told growl
about.inTitle
- - The Title of our Notification as Growl will show itinDescription
- - The Description of our Notification as Growl will
display it
java.lang.Exception
- When a notification is not knownpublic void notifyGrowlOf(java.lang.String inNotificationName, java.lang.String inTitle, java.lang.String inDescription, boolean inSticky) throws java.lang.Exception
inNotificationName
- - The name of one of the notifications we told growl
about.inTitle
- - The Title of our Notification as Growl will show itinDescription
- - The Description of our Notification as Growl will
display itinSticky
- - Whether our notification should be sticky
java.lang.Exception
- When a notification is not knownpublic void notifyGrowlOf(java.lang.String inNotificationName, com.apple.cocoa.application.NSImage inImage, java.lang.String inTitle, java.lang.String inDescription, com.apple.cocoa.foundation.NSDictionary inExtraInfo) throws java.lang.Exception
inNotificationName
- - The name of one of the notifications we told growl
about.inImage
- - The notification image.inTitle
- - The Title of our Notification as Growl will show itinDescription
- - The Description of our Notification as Growl will
display itinExtraInfo
- - Look above for info
java.lang.Exception
- When a notification is not knownpublic void notifyGrowlOf(java.lang.String inNotificationName, java.lang.String inImagePath, java.lang.String inTitle, java.lang.String inDescription) throws java.lang.Exception
inNotificationName
- - The name of one of the notifications we told growl
about.inImagePath
- - Path to the image for this notificationinTitle
- - The Title of our Notification as Growl will show itinDescription
- - The Description of our Notification as Growl will
display it
java.lang.Exception
- When a notification is not knownpublic java.lang.String applicationName()
public com.apple.cocoa.foundation.NSArray allowedNotifications()
public com.apple.cocoa.foundation.NSArray defaultNotifications()
public void setApplicationName(java.lang.String inAppName)
inAppName
- - The Application Namepublic void setAllowedNotifications(com.apple.cocoa.foundation.NSArray inAllNotes)
inAllNotes
- - The array of allowed Notificationspublic void setAllowedNotifications(java.lang.String[] inAllNotes)
inAllNotes
- - The array of allowed Notificationspublic void setDefaultNotifications(com.apple.cocoa.foundation.NSArray inDefNotes) throws java.lang.Exception
inDefNotes
- - The default Notifications
java.lang.Exception
- when an element of the array is not in the
allowedNotificationspublic void setDefaultNotifications(java.lang.String[] inDefNotes) throws java.lang.Exception
inDefNotes
- - The default Notifications
java.lang.Exception
- when an element of the array is not in the
allowedNotifications
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |