blob: 24ce28962631a6d82aa770c4b049a8fdae4cf1ec [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2011, 2019 Mia-Software and others.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v20.html
*
* Contributors:
* Nicolas Guyomar (Mia-Software) - Bug 339554 - org.eclipse.modisco.facet.widgets.celleditors API cleaning
* Nicolas Bros (Mia-Software) - Bug 339855 - ModelCellEditor class should not be exposed
*******************************************************************************/
package org.eclipse.modisco.facet.widgets.celleditors;
import java.util.List;
import org.eclipse.emf.ecore.EClassifier;
import org.eclipse.modisco.facet.widgets.celleditors.internal.CellEditorsRegistry;
import org.eclipse.modisco.facet.widgets.celleditors.modelCellEditor.AbstractModelCellEditor;
/**
* Registry for the "celleditors" extension point
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface ICellEditorsRegistry {
static ICellEditorsRegistry INSTANCE = new CellEditorsRegistry();
List<IModelCellEditorContainer<? extends AbstractModelCellEditor>> getAllCellEditors();
/**
* Returns a cell editor to edit a single value of the given type, or <code>null</code> if none
* was found. Custom cell editors override the default ones (from
* "org.eclipse.modisco.facet.widgets.celleditors").
*
* @param type
* the type for which to get a cell editor
* @return the cell editor or <code>null</code> if none was found for the given type
*/
IModelCellEditor getCellEditorFor(EClassifier type);
/**
* Returns a cell editor to edit a list of values of the given type, or <code>null</code> if
* none was found. Custom cell editors override the default ones (from
* "org.eclipse.modisco.facet.widgets.celleditors").
*
* @param type
* the type for which to get a cell editor
* @return the cell editor or <code>null</code> if none was found for the given type
*/
INaryFeatureCellEditor getNaryCellEditorFor(EClassifier type);
/**
* Returns a cell editor to edit a single value of the given type, or <code>null</code> if none
* was found. Custom cell editors override the default ones (from
* "org.eclipse.modisco.facet.widgets.celleditors").
*
* @param type
* the type for which to get a cell editor
* @param preferredCellEditors
* the cell editors that should be chosen in case of conflicts (several cell editors
* defined for the same type)
* @return the cell editor or <code>null</code> if none was found for the given type
*/
IModelCellEditor getCellEditorFor(EClassifier type,
List<AbstractModelCellEditor> preferredCellEditors);
/**
* Returns a cell editor to edit a list of values of the given type, or <code>null</code> if
* none was found. Custom cell editors override the default ones (from
* "org.eclipse.modisco.facet.widgets.celleditors").
*
* @param type
* the type for which to get a cell editor
* @param preferredCellEditors
* the cell editors that should be chosen in case of conflicts (several cell editors
* defined for the same type)
* @return the cell editor or <code>null</code> if none was found for the given type
*/
INaryFeatureCellEditor getNaryCellEditorFor(EClassifier type,
List<AbstractModelCellEditor> preferredCellEditors);
}