All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.eclipse.jface.menus.TextState Maven / Gradle / Ivy

The newest version!
/*******************************************************************************
 * Copyright (c) 2005, 2015 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.jface.menus;

import org.eclipse.core.commands.INamedHandleStateIds;
import org.eclipse.jface.commands.PersistentState;
import org.eclipse.jface.preference.IPreferenceStore;

/**
 * 

* A piece of state carrying a single {@link String}. *

*

* If this state is registered using {@link INamedHandleStateIds#NAME} or * {@link INamedHandleStateIds#DESCRIPTION}, then this allows the handler to * communicate a textual change for a given command. This is typically used by * graphical applications to allow more specific text to be displayed in the * menus. For example, "Undo" might become "Undo Typing" through the use of a * {@link TextState}. *

*

* Clients may instantiate this class, but must not extend. *

* * @since 3.2 * @see INamedHandleStateIds */ public class TextState extends PersistentState { @Override public final void load(final IPreferenceStore store, final String preferenceKey) { final String value = store.getString(preferenceKey); setValue(value); } @Override public final void save(final IPreferenceStore store, final String preferenceKey) { final Object value = getValue(); if (value instanceof String) { store.setValue(preferenceKey, ((String) value)); } } @Override public void setValue(final Object value) { if (!(value instanceof String) && value != null) { throw new IllegalArgumentException( "TextState takes a String as a value"); //$NON-NLS-1$ } super.setValue(value); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy