blob: fdea1201e594b6fcd525ac9daa94484d5f9b49aa (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
/*
* Jitsi, the OpenSource Java VoIP and Instant Messaging client.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.java.sip.communicator.service.systray;
import net.java.sip.communicator.service.systray.event.*;
/**
* The <tt>PopupMessageHandler</tt> role is to give different methods to display
* <tt>PopupMessage</tt> and listen for events (user click) coming from that
* popup.
*
* @author Symphorien Wanko
*/
public interface PopupMessageHandler
{
/**
* Registers a listener to be informed of systray popup events.
*
* @param listener the listened which will be informed of systray popup
* events
*/
public void addPopupMessageListener(SystrayPopupMessageListener listener);
/**
* Removes a listener previously added with <tt>addPopupMessageListener</tt>.
*
* @param listener the listener to remove
*/
public void removePopupMessageListener(SystrayPopupMessageListener listener);
/**
* Shows the given <tt>PopupMessage</tt>. Any given <tt>PopupMessage</tt>
* will provide a minimum of two values: a message title and a message body.
* These two values are respectively available via
* <tt>PopupMessage#getMessageTitle()</tt> and
* <tt>PopupMessage#getMessage()</tt>
*
* @param popupMessage the message to show
*/
public void showPopupMessage(PopupMessage popupMessage);
/**
* Returns a preference index, which indicates how many features the handler
* implements. Implementer should calculate preference index by adding "1"
* for each of the the following features that the implementation supports:
*
* 1) showing images
* 2) detecting clicks
* 3) being able to match a click to a message
* 4) using a native popup mechanism
*
* @return an integer representing preference index of this popup handler
*/
public int getPreferenceIndex();
/**
* Returns a readable localized description of this popup handler.
*
* @return a string describing this popup handler
*/
@Override
public String toString();
}
|
