/* 
    P/P   *  Method: com.dmdirc.ui.interfaces.StatusBar__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  /**
    26   * Status bar interface.
    27   */
    28  public interface StatusBar {
    29      
    30      /**
    31       * sets the message in the status bar.
    32       *
    33       * @param newMessage Message to display
    34       */
    35      void setMessage(final String newMessage);
    36      
    37      /**
    38       * sets the message in the status bar.
    39       *
    40       * @param iconType Message icon
    41       * @param newMessage Message to display
    42       * 
    43       * @since 0.6
    44       */
    45      void setMessage(final String iconType, final String newMessage);
    46      
    47      /**
    48       * Sets the message in the status bar with a specified callback event
    49       * using the default timeout.
    50       *
    51       * @param newMessage Message to display
    52       * @param newNotifier status message notifier to be notified for events on
    53       * this message
    54       * 
    55       * @since 0.6
    56       */
    57      void setMessage(final String newMessage, 
    58              final StatusMessageNotifier newNotifier);
    59      
    60      /**
    61       * Sets the message in the status bar with a specified callback event
    62       * using the default timeout.
    63       *
    64       * @param iconType Message icon
    65       * @param newMessage Message to display
    66       * @param newNotifier status message notifier to be notified for events on
    67       * this message
    68       * 
    69       * @since 0.6
    70       */
    71      void setMessage(final String iconType, final String newMessage, 
    72              final StatusMessageNotifier newNotifier);
    73      
    74      /**
    75       * Sets the message in the status bar with a specified callback event for
    76       * a specified time.
    77       *
    78       * @param newMessage Message to display
    79       * @param newNotifier status message notifier to be notified for events on
    80       * this message
    81       * @param timeout message timeout in seconds
    82       */
    83      void setMessage(final String newMessage,
    84              final StatusMessageNotifier newNotifier, final int timeout);
    85      
    86      /**
    87       * Sets the message in the status bar with a specified callback event for
    88       * a specified time.
    89       *
    90       * @param iconType Message icon
    91       * @param newMessage Message to display
    92       * @param newNotifier status message notifier to be notified for events on
    93       * this message
    94       * @param timeout message timeout in seconds
    95       * 
    96       * @since 0.6
    97       */
    98      void setMessage(final String iconType, final String newMessage,
    99              final StatusMessageNotifier newNotifier, final int timeout);
   100      
   101      /**
   102       * Removes the message from the status bar.
   103       */
   104      void clearMessage();
   105      
   106      /**
   107       * Adds a component to the status bar.
   108       *
   109       * @param component component to add
   110       */
   111      void addComponent(final StatusBarComponent component);
   112      
   113      /**
   114       * Removes a component to the status bar.
   115       *
   116       * @param component component to add
   117       */
   118      void removeComponent(final StatusBarComponent component);
   119      
   120      /**
   121       * Returns true if the status bar is visible.
   122       *
   123       * @return true iff the status bar is visible
   124       */
   125      boolean isVisible();
   126      
   127  }