]> git.mxchange.org Git - jfinancials-swing.git/blob - Addressbook/src/org/mxchange/addressbook/client/gui/ClientFrame.java
Renamed some classes/interfaces to make it clear they belong only to this project...
[jfinancials-swing.git] / Addressbook / src / org / mxchange / addressbook / client / gui / ClientFrame.java
1 /*
2  * Copyright (C) 2015 Roland Haeder
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 3 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, see <http://www.gnu.org/licenses/>.
16  */
17 package org.mxchange.addressbook.client.gui;
18
19 import org.mxchange.jcore.FrameworkInterface;
20 import org.mxchange.jcore.client.Client;
21 import org.mxchange.jcore.contact.Contact;
22 import org.mxchange.jcore.exceptions.FrameAlreadyInitializedException;
23
24 /**
25  * An interface for applications with a frame
26  *
27  * @author Roland Haeder
28  */
29 public interface ClientFrame extends FrameworkInterface {
30
31         /**
32          * Shows the user the "add contact" form with some special text
33          * 
34          * @return Contact instance
35          */
36         public Contact doEnterOwnData ();
37
38         /**
39          * Shutdown this frame
40          */
41         public void doShutdown ();
42
43         /**
44          * Enables main window (frame)
45          */
46         public void enableMainWindow ();
47
48         /**
49          * Setups the frame (and starts it). You have to call init() before you can
50          * call this method.
51          *
52          * @param client Client instance
53          */
54         public void setupFrame (final Client client);
55
56         /**
57          * Initializes frame
58          *
59          * @throws
60          * org.mxchange.jcore.exceptions.FrameAlreadyInitializedException If
61          * this method has been called twice
62          */
63         public void init () throws FrameAlreadyInitializedException;
64
65         /**
66          * Returns field isInitialized. This flag indicates whether this frame has
67          * been initialized or not.
68          *
69          * @return Field isInitialized
70          */
71         public boolean isInitialized ();
72
73         /**
74          * Shuts down application
75          */
76         public void shutdownApplication ();
77 }