/* 
    P/P   *  Method: com.dmdirc.addons.ui_swing.components.themepanel.ThemeToggle__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  package com.dmdirc.addons.ui_swing.components.themepanel;
    23  
    24  import com.dmdirc.ui.themes.Theme;
    25  
    26  /**
    27   * Wraps a Theme object with a boolean to indicate whether it should be
    28   * enabled or not.
    29   * 
    30   * @author chris
    31   */
    32  public class ThemeToggle {
    33      
    34      /** The Theme object we're wrapping. */
    35      private final Theme theme;
    36      
    37      /** Whether or not to enable it. */
    38      private boolean enable;
    39  
    40      /**
    41       * Creates a new instance of ThemeToggle to wrap the specified
    42       * Theme.
    43       * 
    44       * @param theme The theme to be wrapped
    45       */
             /* 
    P/P       *  Method: void com.dmdirc.addons.ui_swing.components.themepanel.ThemeToggle(Theme)
              * 
              *  Preconditions:
              *    theme != null
              * 
              *  Postconditions:
              *    init'ed(this.enable)
              *    this.theme == theme
              *    this.theme != null
              */
    46      public ThemeToggle(final Theme theme) {
    47          this.theme = theme;
    48          enable = theme.isEnabled();
    49      }
    50      
    51      /**
    52       * Toggles this theme.
    53       */
    54      public void toggle() {
                 /* 
    P/P           *  Method: void toggle()
                  * 
                  *  Preconditions:
                  *    init'ed(this.enable)
                  * 
                  *  Postconditions:
                  *    init'ed(this.enable)
                  */
    55          enable = !enable;
    56      }
    57      
    58      /**
    59       * Gets the state of this ThemeToggle.
    60       * 
    61       * @return True if the theme is or should be loaded, false otherwise.
    62       */
    63      public boolean getState() {
                 /* 
    P/P           *  Method: bool getState()
                  * 
                  *  Preconditions:
                  *    init'ed(this.enable)
                  * 
                  *  Postconditions:
                  *    return_value == this.enable
                  *    init'ed(return_value)
                  */
    64          return enable;
    65      }
    66  
    67      /**
    68       * Retrieves the Theme object associated with this toggle.
    69       * 
    70       * @return This toggle's theme object.
    71       */
    72      public Theme getTheme() {
                 /* 
    P/P           *  Method: Theme getTheme()
                  * 
                  *  Postconditions:
                  *    return_value == this.theme
                  *    init'ed(return_value)
                  */
    73          return theme;
    74      }
    75  
    76  }