src/org/mxchange/jcore/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.jcore.client.gui;
  18
  19 import java.io.IOException;
  20 import org.mxchange.jcore.FrameworkInterface;
  21 import org.mxchange.jcore.client.Client;
  22 import org.mxchange.jcore.contact.Contact;
  23 import org.mxchange.jcore.exceptions.BadTokenException;
  24 import org.mxchange.jcore.exceptions.FrameAlreadyInitializedException;
  25
  26 /**
  27  * An interface for applications with a frame
  28  *
  29  * @author Roland Haeder
  30  */
  31 public interface ClientFrame extends FrameworkInterface {
  32
  33         /**
  34          * Shows the user the "add contact" form with some special text
  35          *
  36          * @return Contact instance
  37          */
  38         public Contact doEnterOwnData ();
  39
  40         /**
  41          * Shutdown this frame
  42          */
  43         public void doShutdown ();
  44
  45         /**
  46          * Enables main window (frame)
  47          */
  48         public void enableMainWindow ();
  49
  50         /**
  51          * Setups the frame (and starts it). You have to call init() before you can
  52          * call this method.
  53          *
  54          * @param client Client instance
  55          * @throws java.io.IOException If an IO error was found
  56          * @throws org.mxchange.jcore.exceptions.BadTokenException If a bad token was found
  57          */
  58         public void setupFrame (final Client client) throws IOException, BadTokenException;
  59
  60         /**
  61          * Initializes frame
  62          *
  63          * @throws
  64          * org.mxchange.jcore.exceptions.FrameAlreadyInitializedException If
  65          * this method has been called twice
  66          */
  67         public void init () throws FrameAlreadyInitializedException;
  68
  69         /**
  70          * Returns field isInitialized. This flag indicates whether this frame has
  71          * been initialized or not.
  72          *
  73          * @return Field isInitialized
  74          */
  75         public boolean isInitialized ();
  76
  77         /**
  78          * Shuts down application
  79          */
  80         public void shutdownApplication ();
  81 }