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.addressbook.FrameworkInterface;
  20 import org.mxchange.addressbook.client.Client;
  21 import org.mxchange.addressbook.exceptions.FrameAlreadyInitializedException;
  22
  23 /**
  24  * An interface for applications with a frame
  25  *
  26  * @author Roland Haeder
  27  */
  28 public interface ClientFrame extends FrameworkInterface {
  29
  30         /**
  31          * Shutdown this frame
  32          */
  33         public void doShutdown ();
  34
  35         /**
  36          * Setups the frame (and starts it). You have to call init() before you can
  37          * call this method.
  38          *
  39          * @param client Client instance
  40          */
  41         public void setupFrame (final Client client);
  42
  43         /**
  44          * Initializes frame
  45          *
  46          * @throws
  47          * org.mxchange.addressbook.exceptions.FrameAlreadyInitializedException If
  48          * this method has been called twice
  49          */
  50         public void init () throws FrameAlreadyInitializedException;
  51
  52         /**
  53          * Returns field isInitialized. This flag indicates whether this frame has
  54          * been initialized or not.
  55          *
  56          * @return Field isInitialized
  57          */
  58         public boolean isInitialized ();
  59
  60         public void shutdownApplication ();
  61 }