/* 
    P/P   *  Method: com.dmdirc.addons.systray.PopupCommand__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.addons.systray;
    24  
    25  import com.dmdirc.Server;
    26  import com.dmdirc.commandparser.CommandArguments;
    27  import com.dmdirc.commandparser.CommandManager;
    28  import com.dmdirc.commandparser.commands.ServerCommand;
    29  import com.dmdirc.ui.interfaces.InputWindow;
    30  
    31  /**
    32   * The /popup command allows the user to show a popup message from the system
    33   * tray icon.
    34   * @author chris
    35   */
    36  public final class PopupCommand extends ServerCommand {
    37      
    38      /** The SystrayPlugin that we belong to. */
    39      private final SystrayPlugin parent;
    40      
    41      /**
    42       * Creates a new instance of PopupCommand.
    43       * @param newParent The plugin that this command belongs to
    44       */
    45      public PopupCommand(final SystrayPlugin newParent) {
                 /* 
    P/P           *  Method: void com.dmdirc.addons.systray.PopupCommand(SystrayPlugin)
                  * 
                  *  Postconditions:
                  *    this.parent == newParent
                  *    init'ed(this.parent)
                  */
    46          super();
    47          
    48          this.parent = newParent;
    49          
    50          CommandManager.registerCommand(this);
    51      }
    52  
    53      /**
    54       * Used to show a notification using this plugin.
    55       *
    56       * @param title Title of dialog if applicable
    57       * @param message Message to show
    58       * @return True if the notification was shown.
    59       */
    60      public boolean showPopup(final String title, final String message) {
                 /* 
    P/P           *  Method: bool showPopup(String, String)
                  * 
                  *  Preconditions:
                  *    this.parent != null
                  *    this.parent.icon != null
                  * 
                  *  Postconditions:
                  *    return_value == 1
                  */
    61          parent.notify(title, message);
    62          return true;
    63      }
    64  
    65      /** {@inheritDoc} */
    66      @Override
    67      public void execute(final InputWindow origin, final Server server,
    68              final boolean isSilent, final CommandArguments args) {
                 /* 
    P/P           *  Method: void execute(InputWindow, Server, bool, CommandArguments)
                  * 
                  *  Preconditions:
                  *    args != null
                  *    this.parent != null
                  *    this.parent.icon != null
                  */
    69          showPopup("DMDirc", args.getArgumentsAsString());
    70      }
    71  
    72      /** {@inheritDoc} */
    73      @Override
    74      public String getName() {
                 /* 
    P/P           *  Method: String getName()
                  * 
                  *  Postconditions:
                  *    return_value == &"popup"
                  */
    75          return "popup";
    76      }
    77  
    78      /** {@inheritDoc} */
    79      @Override
    80      public boolean showInHelp() {
                 /* 
    P/P           *  Method: bool showInHelp()
                  * 
                  *  Postconditions:
                  *    return_value == 1
                  */
    81          return true;
    82      }
    83  
    84      /** {@inheritDoc} */
    85      @Override
    86      public String getHelp() {
                 /* 
    P/P           *  Method: String getHelp()
                  * 
                  *  Postconditions:
                  *    return_value == &amp;"popup <message> - shows the message as a system tray popup"
                  */
    87          return "popup <message> - shows the message as a system tray popup";
    88      }
    89      
    90      /** Unregisters this command from the CommandManager. */
    91      public void unregister() {
                 /* 
    P/P           *  Method: void unregister()
                  */
    92          CommandManager.unregisterCommand(this);
    93      }
    94      
    95  }