bundles/org.eclipse.emf.ecp.edit/src/org/eclipse/emf/ecp/edit/spi/ECPControlDescription.java

/*******************************************************************************
 * Copyright (c) 2011-2013 EclipseSource Muenchen GmbH and others.
 *
 * All rights reserved. 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:
 * Eugen Neufeld - initial API and implementation
 *
 *******************************************************************************/
package org.eclipse.emf.ecp.edit.spi;

import java.util.Set;

import org.eclipse.emf.ecp.edit.spi.util.ECPApplicableTester;

/**
 * This class describes the control extensionpoint. It is used to provide the possibility to access all known controls
 * without reading the extension point.
 *
 * @author Eugen Neufeld
 */
@Deprecated
public final class ECPControlDescription {

	private final String id;
	private final Class<? extends ECPAbstractControl> controlClass;
	private final boolean showLabel;
	private final Set<ECPApplicableTester> tester;

	/**
	 * The constructor of the ControlDescription.
	 *
	 * @param controlClass the class implementing the control
	 * @param showLabel whether to show a label for this control or not
	 * @param tester the class testing whether the control is applicable for the current feature of the current eobject
	 * @param id the id of the control that is being described
	 */
	public ECPControlDescription(String id, Class<? extends ECPAbstractControl> controlClass, boolean showLabel,
		Set<ECPApplicableTester> tester) {
		super();
		this.id = id;
		this.controlClass = controlClass;
		this.showLabel = showLabel;
		this.tester = tester;
	}

	/**
	 * The id of this control.
	 *
	 * @return the id of the control
	 */
	public String getId() {
		return id;
	}

	/**
	 * The class implementing the Control. It extends the {@link ECPAbstractControl}.
	 *
	 * @return the class implementing this control
	 */
	public Class<? extends ECPAbstractControl> getControlClass() {
		return controlClass;
	}

	/**
	 * Whether to show a label for this control or not.
	 *
	 * @return true if a label should be shown
	 */
	public boolean isShowLabel() {
		return showLabel;
	}

	/**
	 * The tester for this control. The tester is used to check whether this control is usable on a specific feature of
	 * a specific eobject.
	 *
	 * @return the {@link ECPApplicableTester} implementation
	 */
	public Set<ECPApplicableTester> getTester() {
		return tester;
	}
}