/* 
    P/P   *  Method: com.dmdirc.ui.interfaces.InputWindow__static_init
          */
     1  /*
     2   * Copyright (c) 2006-2009 Chris Smith, Shane Mc Cormack, Gregory Holmes
     3   *
     4   * Permission is hereby granted, free of charge, to any person obtaining a copy
     5   * of this software and associated documentation files (the "Software"), to deal
     6   * in the Software without restriction, including without limitation the rights
     7   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   * copies of the Software, and to permit persons to whom the Software is
     9   * furnished to do so, subject to the following conditions:
    10   *
    11   * The above copyright notice and this permission notice shall be included in
    12   * all copies or substantial portions of the Software.
    13   *
    14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   * SOFTWARE.
    21   */
    22  
    23  package com.dmdirc.ui.interfaces;
    24  
    25  import com.dmdirc.WritableFrameContainer;
    26  import com.dmdirc.commandparser.parsers.CommandParser;
    27  import com.dmdirc.ui.input.InputHandler;
    28  
    29  /**
    30   * The Input Window interface specifies additional methods that windows should
    31   * implement if they have an input field.
    32   * 
    33   * @author chris
    34   */
    35  public interface InputWindow extends Window {
    36      
    37      /**
    38       * Retrieves the command Parser for this input window.
    39       * 
    40       * @return This window's command parser
    41       */
    42      CommandParser getCommandParser();
    43      
    44      /**
    45       * Retrieves the input handler for this input window.
    46       * 
    47       * @return This window's input handler
    48       */
    49      InputHandler getInputHandler();
    50      
    51      /**
    52       * Toggles the away-status indicator for this input window, if the UI
    53       * supports it.
    54       * 
    55       * @param isAway Whether the away indicator should be displayed or not
    56       */
    57      void setAwayIndicator(boolean isAway);
    58      
    59      /**
    60       * Retrieves the container that owns this command window.
    61       *
    62       * @return The container that owns this command window.
    63       */
    64      @Override
    65      WritableFrameContainer getContainer();    
    66      
    67  }