Addressbook/src/org/mxchange/addressbook/client/gui/ClientFrame.java

   1 /*\r
   2  * Copyright (C) 2015 Roland Haeder\r
   3  *\r
   4  * This program is free software: you can redistribute it and/or modify\r
   5  * it under the terms of the GNU General Public License as published by\r
   6  * the Free Software Foundation, either version 3 of the License, or\r
   7  * (at your option) any later version.\r
   8  *\r
   9  * This program is distributed in the hope that it will be useful,\r
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  12  * GNU General Public License for more details.\r
  13  *\r
  14  * You should have received a copy of the GNU General Public License\r
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.\r
  16  */\r
  17 package org.mxchange.addressbook.client.gui;\r
  18 \r
  19 import org.mxchange.addressbook.FrameAlreadyInitializedException;\r
  20 import org.mxchange.addressbook.FrameworkInterface;\r
  21 import org.mxchange.addressbook.client.Client;\r
  22 \r
  23 /**\r
  24  * An interface for applications with a frame\r
  25  *\r
  26  * @author Roland Haeder\r
  27  */\r
  28 public interface ClientFrame extends FrameworkInterface {\r
  29     /**\r
  30      * Setups the frame (and starts it). You have to call initFrame() before you\r
  31      * can call this method.\r
  32      * \r
  33      * @param client Client instance\r
  34      */\r
  35     public void setupFrame (final Client client);\r
  36 \r
  37     /**\r
  38      * Initializes frame\r
  39      * \r
  40      * @throws org.mxchange.addressbook.FrameAlreadyInitializedException If this method has been called twice\r
  41      */\r
  42     public void initFrame () throws FrameAlreadyInitializedException;\r
  43 \r
  44     /**\r
  45      * Returns field isInitialized. This flag indicates whether this frame has been initialized or not.\r
  46      * \r
  47      * @return Field isInitialized\r
  48      */\r
  49     public boolean isInitialized ();\r
  50 }\r