/* 
    P/P   *  Method: com.dmdirc.addons.ui_swing.components.ContainerToggleButton__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.ui_swing.components;
    24  
    25  import javax.swing.Icon;
    26  import javax.swing.JToggleButton;
    27  
    28  /**
    29   * JButton that holds an object.
    30   * 
    31   * @param <T> Holds an object of this type
    32   */
    33  public class ContainerToggleButton<T> extends JToggleButton {
    34  
    35      /**
    36       * A version number for this class. It should be changed whenever the class
    37       * structure is changed (or anything else that would prevent serialized
    38       * objects being unserialized with the new class).
    39       */
    40      private static final long serialVersionUID = 1;
    41      /** Contents. */
    42      private T contents;
    43  
    44      /**
    45       * Instantiates a new container button.
    46       * 
    47       * @param contents Contents
    48       * @param string Title
    49       * @param icon Icon
    50       */
    51      public ContainerToggleButton(final T contents, final String string,
    52              final Icon icon) {
                 /* 
    P/P           *  Method: void com.dmdirc.addons.ui_swing.components.ContainerToggleButton(Object, String, Icon)
                  */
    53          super(string, icon);
    54      }
    55  
    56      /**
    57       * Instantiates a new container button.
    58       * 
    59       * @param contents Contents
    60       * @param string Title
    61       */
    62      public ContainerToggleButton(final T contents, final String string) {
                 /* 
    P/P           *  Method: void com.dmdirc.addons.ui_swing.components.ContainerToggleButton(Object, String)
                  */
    63          super(string);
    64      }
    65  
    66      /**
    67       * Instantiates a new container button.
    68       * 
    69       * @param contents Contents
    70       * @param icon Icon
    71       */
    72      public ContainerToggleButton(final T contents, final Icon icon) {
                 /* 
    P/P           *  Method: void com.dmdirc.addons.ui_swing.components.ContainerToggleButton(Object, Icon)
                  */
    73          super(icon);
    74      }
    75  
    76      /**
    77       * Instantiates a new container button.
    78       * 
    79       * @param contents Contents
    80       */
    81      public ContainerToggleButton(final T contents) {
                 /* 
    P/P           *  Method: void com.dmdirc.addons.ui_swing.components.ContainerToggleButton(Object)
                  */
    82          super();
    83      }
    84  
    85      /**
    86       * Instantiates a new container button.
    87       */
    88      public ContainerToggleButton() {
                 /* 
    P/P           *  Method: void com.dmdirc.addons.ui_swing.components.ContainerToggleButton()
                  */
    89          super();
    90      }
    91  
    92      /**
    93       * Gets the button's contents
    94       * 
    95       * @return Button contents
    96       */
    97      public T getContents() {
                 /* 
    P/P           *  Method: Object getContents()
                  * 
                  *  Preconditions:
                  *    init'ed(this.contents)
                  * 
                  *  Postconditions:
                  *    return_value == this.contents
                  *    init'ed(return_value)
                  */
    98          return contents;
    99      }
   100  
   101      /**
   102       * Sets the button's contents
   103       * 
   104       * @param contents New contents
   105       */
   106      public void setValue(final T contents) {
                 /* 
    P/P           *  Method: void setValue(Object)
                  * 
                  *  Postconditions:
                  *    this.contents == contents
                  *    init'ed(this.contents)
                  */
   107          this.contents = contents;
   108      }
   109  }