ecommons.waltable/org.eclipse.statet.ecommons.waltable.core/src/org/eclipse/statet/ecommons/waltable/edit/editor/IEditErrorHandler.java

/*=============================================================================#
 # Copyright (c) 2012, 2021 Original NatTable authors and others.
 # 
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License 2.0 which is available at
 # https://www.eclipse.org/legal/epl-2.0.
 # 
 # SPDX-License-Identifier: EPL-2.0
 # 
 # Contributors:
 #     Original NatTable authors and others - initial API and implementation
 #=============================================================================*/

package org.eclipse.statet.ecommons.waltable.edit.editor;

import org.eclipse.statet.ecommons.waltable.config.IConfigRegistry;
import org.eclipse.statet.ecommons.waltable.edit.EditConfigAttributes;


/**
 * An {@link IEditErrorHandler} will be used if on data conversion or validation 
 * while editing via {@link ICellEditor} an error occurs. Such a handler is usually
 * registered in the {@link IConfigRegistry}, using the {@link EditConfigAttributes}.
 * <p>
 * For some {@link ICellEditor}s they are also used for just in time conversion/validation
 * to render the wrong input immediately for feedback to the user. This is done e.g. in
 * the {@link TextCellEditor}.
 * 
 * @see EditConfigAttributes#CONVERSION_ERROR_HANDLER
 * @see EditConfigAttributes#VALIDATION_ERROR_HANDLER
 */
public interface IEditErrorHandler {

	/**
	 * Will remove styling or other decorations that indicate that an error occurred.
	 * Only necessary to implement if the error handler adds special styling or decorations
	 * on error.
	 * @param cellEditor The {@link ICellEditor} to remove the error styling from.
	 */
	void removeError(ICellEditor cellEditor);

	/**
	 * If an error occurs on conversion/validation of data, this method will be called
	 * for showing that error to the user. Usually the message contained within the
	 * given {@link Exception} will be shown to the user.
	 * @param cellEditor The {@link ICellEditor} on which the conversion/validation error
	 * 			occurred. Needed to add error styling or special handling.
	 * @param e The {@link Exception} that contains information about the conversion/validation
	 * 			error. Used to show a more detailed description on the error to the user.
	 */
	void displayError(ICellEditor cellEditor, Exception e);
}