diff dwtx/jface/viewers/ICellEditorValidator.d @ 10:b6c35faf97c8

Viewers
author Frank Benoit <benoit@tionex.de>
date Mon, 31 Mar 2008 00:47:19 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/dwtx/jface/viewers/ICellEditorValidator.d	Mon Mar 31 00:47:19 2008 +0200
@@ -0,0 +1,40 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2006 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:
+ *     IBM Corporation - initial API and implementation
+ * Port to the D programming language:
+ *     Frank Benoit <benoit@tionex.de>
+ *******************************************************************************/
+module dwtx.jface.viewers.ICellEditorValidator;
+
+import dwt.dwthelper.utils;
+
+/**
+ * An interface for validating a cell editor's input.
+ * <p>
+ * This interface should be implemented by classes that wish to
+ * act as cell editor validators.
+ * </p>
+ */
+public interface ICellEditorValidator {
+    /**
+     * Returns a string indicating whether the given value is valid;
+     * <code>null</code> means valid, and non-<code>null</code> means
+     * invalid, with the result being the error message to display
+     * to the end user.
+     * <p>
+     * It is the responsibility of the implementor to fully format the
+     * message before returning it.
+     * </p>
+     *
+     * @param value the value to be validated
+     * @return the error message, or <code>null</code> indicating
+     *  that the value is valid
+     */
+    public String isValid(Object value);
+}