1 /*
2 * (C) 2002 David Carr david@carr.name
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 */
18
19 package net.sourceforge.mflow.api;
20
21 import javax.swing.JFrame;
22
23 /***
24 * Interface to specify what funcionality a MFlowUI must provide
25 *
26 * @author <a href="mailto:david@carr.name">David Carr</a>
27 * @version $Revision: 1.3 $
28 */
29 public interface MFlowUI {
30 /***
31 * Gets the currently selected Contacts
32 *
33 * @return an array of selected Contacts
34 */
35 Contact[] getSelectedContacts();
36
37 /***
38 * Gets the currently selected ContactMethods
39 *
40 * @return an array of selected ContactMethods
41 */
42 ContactMethod[] getSelectedContactMethods();
43
44 /***
45 * Gets the currently selected MsgFolder
46 *
47 * @return the selected MsgFolder, or null
48 */
49 MsgFolder getSelectedFolder();
50
51 /***
52 * Gets the currently selected Msg. If multiple Msgs are selected, returns
53 * only the first one.
54 *
55 * @return the selected Msg, or null
56 */
57 Msg getSelectedMsg();
58
59 /***
60 * Gets the currently selected Msgs.
61 *
62 * @return an array of selected Msgs
63 */
64 Msg[] getSelectedMsgs();
65
66 /***
67 * Sets the visibility of the UI
68 *
69 * @param b whether or not to display the UI
70 */
71 void setVisible(boolean b);
72
73 /***
74 * Returns whether or not the UI is currently visible
75 *
76 * @return the visibility of the UI
77 */
78 boolean isVisible();
79
80 /***
81 * Repaints the UI
82 */
83 void repaint();
84
85 /***
86 * Returns the base JFrame of the UI
87 *
88 * @return the base JFrame
89 */
90 JFrame getFrame();
91
92 /***
93 * Initializes the user interface
94 */
95 void init();
96 }
This page was automatically generated by Maven