src/main/java/irc/gui/GUISource.java

   1 /*****************************************************/\r
   2 /*          This java file is a part of the          */\r
   3 /*                                                   */\r
   4 /*           -  Plouf's Java IRC Client  -           */\r
   5 /*                                                   */\r
   6 /*   Copyright (C)  2002 - 2004 Philippe Detournay   */\r
   7 /*                                                   */\r
   8 /*         All contacts : theplouf@yahoo.com         */\r
   9 /*                                                   */\r
  10 /*  PJIRC is free software; you can redistribute     */\r
  11 /*  it and/or modify it under the terms of the GNU   */\r
  12 /*  General Public License as published by the       */\r
  13 /*  Free Software Foundation; version 2 or later of  */\r
  14 /*  the License.                                     */\r
  15 /*                                                   */\r
  16 /*  PJIRC is distributed in the hope that it will    */\r
  17 /*  be useful, but WITHOUT ANY WARRANTY; without     */\r
  18 /*  even the implied warranty of MERCHANTABILITY or  */\r
  19 /*  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU   */\r
  20 /*  General Public License for more details.         */\r
  21 /*                                                   */\r
  22 /*  You should have received a copy of the GNU       */\r
  23 /*  General Public License along with PJIRC; if      */\r
  24 /*  not, write to the Free Software Foundation,      */\r
  25 /*  Inc., 59 Temple Place, Suite 330, Boston,        */\r
  26 /*  MA  02111-1307  USA                              */\r
  27 /*                                                   */\r
  28 /*****************************************************/\r
  29 \r
  30 package irc.gui;\r
  31 \r
  32 import irc.Source;\r
  33 \r
  34 /**\r
  35  * The GUI source.\r
  36  */\r
  37 public interface GUISource {\r
  38         /**\r
  39          * Set the current textfield text.\r
  40          * \r
  41          * @param txt\r
  42          *          new textfield text.\r
  43          */\r
  44         public void setFieldText(String txt);\r
  45 \r
  46         /**\r
  47          * Get the current textfield text.\r
  48          * \r
  49          * @return the current textfield text.\r
  50          */\r
  51         public String getFieldText();\r
  52 \r
  53         /**\r
  54          * Validate the current textfield text, as if user pressed return key.\r
  55          */\r
  56         public void validateText();\r
  57 \r
  58         /**\r
  59          * Get the source.\r
  60          * \r
  61          * @return the source.\r
  62          */\r
  63         public Source getSource();\r
  64 \r
  65         /**\r
  66          * Request the keyboard focus on this awt source.\r
  67          */\r
  68         public void requestFocus();\r
  69 \r
  70         /**\r
  71          * Get the source title.\r
  72          * \r
  73          * @return source title.\r
  74          */\r
  75         public String getTitle();\r
  76 \r
  77 } // GUISource\r
  78 \r