|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface que les plugins de PIM doivent implémenter.
Cette interface définis les méthodes auxquelles un plugin doit répondre afin d'être utlisable par PIM.
La classe pim
définit les méthodes de PIM accessibles aux plugins.
Voici quelques points à respecter pour développer un plugin :
yb.p2pim
,
pim
Field Summary | |
static int |
EVENTS_BOTH
mode moitié/moitié : le plugin reçois une annonce d'événement et l'événement est signalé "à cliquer" à l'utilisateur. |
static int |
EVENTS_DIRECT
mode direct : le plugin reçois l'événement sans que l'utilisateur en soit informé au préalable |
static int |
EVENTS_USER
mode utilisateur : l'utilisateur doit 'cliquer' l'événement avant que le plugin ne le recoive |
static int |
TYPE_BOTH
mode contact et système (liste des contacts et menu des plugins) |
static int |
TYPE_CONTACT
mode contact : le plugin est accessible depuis le menu contextuel de la liste des contacts |
static int |
TYPE_SYSTEM
mode système : le plugin est accessible depuis le menu des plugins |
Method Summary | |
void |
action()
événement local système, càd que l'utilisateur a activé ce plugin seul (pas de contact associé) |
void |
action(contact c)
événement local, càd que l'utilisateur a activé ce plugin sur le contact c |
void |
action(contact c,
java.lang.String cat,
java.lang.String msg,
boolean user)
événement distant, càd que pim à reçu un message destiné à ce plugin |
void |
actionConfigure()
affiche l'écran de configuration de ce plugin (si applicable) |
void |
alert(contact c,
java.lang.String cat)
signale l'arrivée d'un événement (cas des plugins inscrits en mode EVENTS_BOTH) |
void |
end()
l'application se termine, le plugin à l'occasion d'enregistrer des valeurs etc |
javax.swing.ImageIcon |
getIcon()
le plugin doit retourner l'icone à utiliser pour signaler un événement lui étant associé remarque : peut retourner 'null', auquel cas l'icone par défaut de pim est utilisée |
java.lang.String |
getNameConfigure()
le plugin doit retourner son nom. |
java.lang.String |
getNameContact()
le plugin doit retourner son nom. |
java.lang.String |
getNameSystem()
le plugin doit retourner son nom. |
java.applet.AudioClip |
getSound()
le plugin doit retourner un objet son qui sera utilisé pour signaler les événements liés. |
int |
getType()
le plugin doit indiquer son type. une des options plugin.TYPE_XXX |
boolean |
init(pim p,
java.lang.String path)
initialisation (typiquement le plugin enregistre ses abonnements auprès de pim lors de l'initialisation) |
void |
result(int id,
boolean ok,
java.lang.String msg)
code de retour suite à l'envoi d'un message par pim pour le compte de ce plugin |
Field Detail |
public static final int TYPE_CONTACT
public static final int TYPE_SYSTEM
public static final int TYPE_BOTH
public static final int EVENTS_USER
public static final int EVENTS_DIRECT
public static final int EVENTS_BOTH
Method Detail |
public boolean init(pim p, java.lang.String path)
p
- objet parent de type pimpath
- chemin d'accès jusque au répértoire où se trouve le plugin
public void end()
public void actionConfigure()
public void action()
public void action(contact c)
c
- objet contact sur lequel appliquer l'action du pluginpublic void action(contact c, java.lang.String cat, java.lang.String msg, boolean user)
c
- le contact source de cet événementcat
- la catégorie du message reçumsg
- le message reçuuser
- indique si c'est l'utilisateur qui a activé cet événementpublic void alert(contact c, java.lang.String cat)
c
- le contact source de cet événementcat
- la catégorie du message reçupublic void result(int id, boolean ok, java.lang.String msg)
id
- identifiant associé à la demande d'envoi de messageok
- indique si le message a été transmis avec succès ou nonmsg
- éventuel message d'erreurpublic javax.swing.ImageIcon getIcon()
public java.lang.String getNameContact()
public java.lang.String getNameSystem()
public java.lang.String getNameConfigure()
public java.applet.AudioClip getSound()
null
, auquel cas le son par défaut de pim est utilisée
public int getType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |