platform/platform-impl/src/com/intellij/ui/StateRestoringCheckBox.java

/*
 * Copyright 2000-2009 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * @author Eugene Zhuravlev
 */
package com.intellij.ui;

import javax.swing.*;

/**
 * When enabled the checkbox behaves like the ordinary checkbox
 * If to use special methods to enable/disable it,
 * it will manage different selected/unselected states for each mode - enabled or disabled
 */
public class StateRestoringCheckBox extends JCheckBox {
  private boolean myIsSelectedWhenSelectable;

  public StateRestoringCheckBox() {
    super();
    myIsSelectedWhenSelectable = isSelected();
  }

  public StateRestoringCheckBox(Icon icon) {
    super(icon);
    myIsSelectedWhenSelectable = isSelected();
  }

  public StateRestoringCheckBox(Icon icon, boolean selected) {
    super(icon, selected);
    myIsSelectedWhenSelectable = isSelected();
  }

  public StateRestoringCheckBox(String text) {
    super(text);
    myIsSelectedWhenSelectable = isSelected();
  }

  public StateRestoringCheckBox(Action a) {
    super(a);
    myIsSelectedWhenSelectable = isSelected();
  }

  public StateRestoringCheckBox(String text, boolean selected) {
    super(text, selected);
    myIsSelectedWhenSelectable = isSelected();
  }

  public StateRestoringCheckBox(String text, Icon icon) {
    super(text, icon);
    myIsSelectedWhenSelectable = isSelected();
  }

  public StateRestoringCheckBox(String text, Icon icon, boolean selected) {
    super(text, icon, selected);
    myIsSelectedWhenSelectable = isSelected();
  }

  /**
   * The method should be used instead of setEnabled(false) or disable() in order to support selected state saving/recovering
   * Remembers the selected state of the checkbox when the checkbox is enabled, disables it
   * and sets the selected state according to tha parameter pased
   * @param isSelected the parameter telling whetheer the checkbox is selected when disabled
   */
  public void makeUnselectable(boolean isSelected) {
    if (isEnabled()) {
      myIsSelectedWhenSelectable = isSelected();
      setEnabled(false);
    }
    setSelected(isSelected);
  }

  /**
   * The method should be used instead of setEnabled(true) or enable() in order to support selected state saving/recovering
   * Enables the checkbox and restores the selected state of the checkbox to the one, that it had before the makeUnselectable() method was called
   * that was before the checkbox was disabled
   */
  public void makeSelectable() {
    if (!isEnabled()) {
      setEnabled(true);
      setSelected(myIsSelectedWhenSelectable);
    }
  }

  public boolean isSelectedWhenSelectable() {
    if (isEnabled()) {
      return isSelected();
    }
    return myIsSelectedWhenSelectable;
  }
}