org.eclipse.jface.commands.ToggleState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.jface Show documentation

This is org.eclipse.jface jar used by Scout SDK

The newest version!

/*******************************************************************************
 * Copyright (c) 2005, 2015 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.jface.commands;

import org.eclipse.jface.menus.IMenuStateIds;
import org.eclipse.jface.preference.IPreferenceStore;

/**
 * 
 * A piece of state storing a {@link Boolean}.
 * 
 * 
 * If this state is registered using {@link IMenuStateIds#STYLE}, then it will
 * control the presentation of the command if displayed in the menus, tool bars
 * or status line.
 * 
 * 
 * Clients may instantiate this class, but must not extend.
 * 
 *
 * @since 3.2
 */
public class ToggleState extends PersistentState {

	/**
	 * Constructs a new ToggleState. By default, the toggle is off
	 * (e.g., false).
	 */
	public ToggleState() {
		setValue(Boolean.FALSE);
	}

	@Override
	public final void load(final IPreferenceStore store,
			final String preferenceKey) {
		final boolean currentValue = ((Boolean) getValue()).booleanValue();
		store.setDefault(preferenceKey, currentValue);
		if (shouldPersist() && (store.contains(preferenceKey))) {
			final boolean value = store.getBoolean(preferenceKey);
			setValue(value ? Boolean.TRUE : Boolean.FALSE);
		}
	}

	@Override
	public final void save(final IPreferenceStore store,
			final String preferenceKey) {
		if (shouldPersist()) {
			final Object value = getValue();
			if (value instanceof Boolean) {
				store.setValue(preferenceKey, ((Boolean) value).booleanValue());
			}
		}
	}

	@Override
	public void setValue(final Object value) {
		if (!(value instanceof Boolean)) {
			throw new IllegalArgumentException(
					"ToggleState takes a Boolean as a value"); //$NON-NLS-1$
		}

		super.setValue(value);
	}
}