org.eclipse.ui.views.properties.IPropertySource2 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.rap.ui.views
The RAP Widget Toolkit Eclipse UI Views
The newest version!
/*******************************************************************************
 * Copyright (c) 2000, 2005 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:
 *     Gunnar Wagenknecht - initial API and implementation
 *******************************************************************************/
package org.eclipse.ui.views.properties;

/**
 * Extension to the standard IPropertySource interface.
 * 
 * This interface provides extended API to IPropertySource to
 * allow an easier indication of properties that have a default value and can be
 * resetted.
 * 
 * 
 * @since 1.0
 * @see org.eclipse.ui.views.properties.IPropertySource
 */
public interface IPropertySource2 extends IPropertySource {

    /**
     * Returns whether the value of the property with the specified id is
     * resettable to a default value.
     * 
     * @param id
     *            the id of the property
     * @return true if the property with the specified id has a
     *         meaningful default value to which it can be resetted, and
     *         false otherwise
     * @see IPropertySource#resetPropertyValue(Object)
     * @see IPropertySource#isPropertySet(Object)
     */
    boolean isPropertyResettable(Object id);

    /**
     * IPropertySource2 overrides the specification of this IPropertySource 
     * method to return true instead of false if the specified 
     * property does not have a meaningful default value.
     * isPropertyResettable will only be called if isPropertySet returns
     * true.
     *  
     * Returns whether the value of the property with the given id has changed
     * from its default value. Returns false if this source does
     * not have the specified property.
     * 
     * 
     * If the notion of default value is not meaningful for the specified
     * property then true is returned.
     * 
     * 
     * @param id
     *            the id of the property
     * @return true if the value of the specified property has
     *         changed from its original default value, true if
     *         the specified property does not have a meaningful default value,
     *         and false if this source does not have the
     *         specified property
     * @see IPropertySource2#isPropertyResettable(Object)
     * @see #resetPropertyValue(Object)
     */
    public boolean isPropertySet(Object id);
}