org.eclipse.osbp.preferences.ui.page/src/org/eclipse/osbp/preferences/ui/component/HookedMultilineStringFieldEditor.java - osbp/org.eclipse.osbp.preferences - Git at Google

 /**
  *
  * Copyright (c) 2011, 2016 - Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
  *
  * 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:
  * Christophe Loetz (Loetz GmbH&Co.KG) - initial implementation
  */
 package org.eclipse.osbp.preferences.ui.component;

 import org.eclipse.jface.preference.FieldEditor;
 import org.eclipse.jface.util.Assert;
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.events.DisposeEvent;
 import org.eclipse.swt.events.DisposeListener;
 import org.eclipse.swt.events.FocusAdapter;
 import org.eclipse.swt.events.FocusEvent;
 import org.eclipse.swt.events.KeyAdapter;
 import org.eclipse.swt.events.KeyEvent;
 import org.eclipse.swt.layout.GridData;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Label;
 import org.eclipse.swt.widgets.Text;

 public class HookedMultilineStringFieldEditor extends FieldEditor {

 	private final IPreferenceCheckStateProvider fCheckStateProvider;

 //	private static final String ERROR_MESSAGE = "Multiline.error.message"; //$NON-NLS-1$
 	public static final int VALIDATE_ON_KEY_STROKE = 0;
 	public static final int VALIDATE_ON_FOCUS_LOST = 1;
 	public static int UNLIMITED = -1;

 	private boolean isValid;
 	private String oldValue;
 	private String compTitle;
 	private Label title;
 	private Text textField;
 	private int widthInChars = 120;
 	private int textLimit = UNLIMITED;
 	private String errorMessage;
 	private boolean emptyStringAllowed = true;
 	private int validateStrategy = VALIDATE_ON_KEY_STROKE;

 	protected HookedMultilineStringFieldEditor() {
 		fCheckStateProvider = null;
 	}

 	public HookedMultilineStringFieldEditor(String name, String labelText, int width, int strategy, IPreferenceCheckStateProvider checkStateProvider, Composite parent) {
 		fCheckStateProvider = checkStateProvider;
 		init(name, labelText);
 		widthInChars = width;
 		setValidateStrategy(strategy);
 		isValid = false;
 		errorMessage = "error";
 		createControl(parent);
 	}

 	public HookedMultilineStringFieldEditor(String name, String labelText, int width, IPreferenceCheckStateProvider checkStateProvider, Composite parent) {
 		this(name, labelText, width, VALIDATE_ON_KEY_STROKE, checkStateProvider, parent);
 		this.compTitle = labelText;
 	}

 	public HookedMultilineStringFieldEditor(String name, String labelText, IPreferenceCheckStateProvider checkStateProvider, Composite parent) {
 		this(name, labelText, UNLIMITED, checkStateProvider, parent);
 	}

 	@Override
 	public void setEnabled(boolean enabled, Composite parent) {
 		super.setEnabled(enabled, parent);
 		if	(textField != null) {
 			textField.setEditable(enabled);
 		}
 	}

 	@Override
 	protected void adjustForNumColumns(int numColumns) {
 		GridData gd = (GridData) textField.getLayoutData();
 		gd.horizontalSpan = numColumns - 1;
 		// We only grab excess space if we have to
 		// If another field editor has more columns then
 		// we assume it is setting the width.
 		gd.grabExcessHorizontalSpace = gd.horizontalSpan == 1;
 	}

 	protected boolean checkState() {

 		boolean result = false;
 		String  txt    = "";

 		if( textField != null )
 			txt = textField.getText();

 		result = !txt.trim().isEmpty() || emptyStringAllowed;

 		// call hook for subclasses
 		result = result && doCheckState();

 		if (result)
 			clearErrorMessage();
 		else
 			showErrorMessage(errorMessage);

 		return result;
 	}

 	protected boolean doCheckState() {
 		if	(fCheckStateProvider != null) {
 			return fCheckStateProvider.doCheckState(this, getTextControl().getText());
 		}
 		return true;
 	}

 	@Override
 	protected void doFillIntoGrid(Composite parent, int numColumns) {

 		title = new Label(parent, SWT.UP);
 		title.setFont(parent.getFont());
 		this.compTitle = getLabelText();
 		title.setText(this.compTitle);
 		title.setLayoutData(new GridData(GridData.VERTICAL_ALIGN_BEGINNING));

 		textField = getTextControl(parent);
 		GridData gd = new GridData(GridData.FILL_HORIZONTAL);
 		gd.widthHint = 100;
 		gd.heightHint = 500;
 		textField.setLayoutData(gd);

 	}

 	@Override
 	protected void doLoad() {
 		if (textField != null) {
 			String value = getPreferenceStore().getString(getPreferenceName());
 			textField.setText(value);
 			oldValue = value;
 		}
 	}

 	@Override
 	protected void doLoadDefault() {
 		if (textField != null) {
 			String value = getPreferenceStore().getDefaultString(
 					getPreferenceName());
 			textField.setText(value);
 		}
 		valueChanged();
 	}

 	@Override
 	protected void doStore() {
 		getPreferenceStore().setValue(getPreferenceName(), textField.getText());
 	}

 	public String getErrorMessage() {
 		return errorMessage;
 	}

 	@Override
 	public int getNumberOfControls() {
 		return 2;
 	}

 	public String getStringValue() {
 		if (textField != null)
 			return textField.getText();
 		else
 			return getPreferenceStore().getString(getPreferenceName());
 	}

 	protected Text getTextControl() {
 		return textField;
 	}

 	public Text getTextControl(Composite parent) {
 		if (textField == null) {
 			textField = new Text(parent, SWT.MULTI | SWT.V_SCROLL | SWT.BORDER
 					| SWT.WRAP);
 			textField.setFont(parent.getFont());
 			switch (validateStrategy) {
 			case VALIDATE_ON_KEY_STROKE:
 				textField.addKeyListener(new KeyAdapter() {
 					@Override
 					public void keyPressed(KeyEvent e) {
 						valueChanged();
 					}
 				});

 				textField.addFocusListener(new FocusAdapter() {
 					@Override
 					public void focusGained(FocusEvent e) {
 						refreshValidState();
 					}

 					@Override
 					public void focusLost(FocusEvent e) {
 						clearErrorMessage();
 					}
 				});
 				break;
 			case VALIDATE_ON_FOCUS_LOST:
 				textField.addKeyListener(new KeyAdapter() {
 					@Override
 					public void keyPressed(KeyEvent e) {
 						clearErrorMessage();
 					}
 				});
 				textField.addFocusListener(new FocusAdapter() {
 					@Override
 					public void focusGained(FocusEvent e) {
 						refreshValidState();
 					}

 					@Override
 					public void focusLost(FocusEvent e) {
 						valueChanged();
 						clearErrorMessage();
 					}
 				});
 				break;
 			default:
 				Assert.isTrue(false, "Unknown validate strategy"); //$NON-NLS-1$
 			}
 			textField.addDisposeListener(new DisposeListener() {
 				@Override
 				public void widgetDisposed(DisposeEvent event) {
 					textField = null;
 				}
 			});
 			if (textLimit > 0) { // Only set limits above 0 - see SWT spec
 				textField.setTextLimit(textLimit);
 			}
 		} else {
 			checkParent(textField, parent);
 		}
 		return textField;
 	}

 	public boolean isEmptyStringAllowed() {
 		return emptyStringAllowed;
 	}

 	@Override
 	public boolean isValid() {
 		return isValid;
 	}

 	@Override
 	protected void refreshValidState() {
 		isValid = checkState();
 	}

 	public void setEmptyStringAllowed(boolean b) {
 		emptyStringAllowed = b;
 	}

 	public void setErrorMessage(String message) {
 		errorMessage = message;
 	}

 	@Override
 	public void setFocus() {
 		if (textField != null) {
 			textField.setFocus();
 		}
 	}

 	public void setStringValue(String value) {
 		if (textField != null) {
 			if (value == null)
 				value = ""; //$NON-NLS-1$
 			oldValue = textField.getText();
 			if (!oldValue.equals(value)) {
 				textField.setText(value);
 				valueChanged();
 			}
 		}
 	}

 	public void setTextLimit(int limit) {
 		textLimit = limit;
 		if (textField != null)
 			textField.setTextLimit(limit);
 	}

 	public void setValidateStrategy(int value) {
 		Assert.isTrue(value == VALIDATE_ON_FOCUS_LOST
 				|| value == VALIDATE_ON_KEY_STROKE);
 		validateStrategy = value;
 	}

 	public void showErrorMessage() {
 		showErrorMessage(errorMessage);
 	}

 	protected void valueChanged() {
 		setPresentsDefaultValue(false);
 		boolean oldState = isValid;
 		refreshValidState();

 		if (isValid != oldState)
 			fireStateChanged(IS_VALID, oldState, isValid);

 		String newValue = textField.getText();
 		if (!newValue.equals(oldValue)) {
 			fireValueChanged(VALUE, oldValue, newValue);
 			oldValue = newValue;
 		}
 	}

 }
	/**
	*
	* Copyright (c) 2011, 2016 - Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
	*
	* 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:
	* Christophe Loetz (Loetz GmbH&Co.KG) - initial implementation
	*/
	package org.eclipse.osbp.preferences.ui.component;

	import org.eclipse.jface.preference.FieldEditor;
	import org.eclipse.jface.util.Assert;
	import org.eclipse.swt.SWT;
	import org.eclipse.swt.events.DisposeEvent;
	import org.eclipse.swt.events.DisposeListener;
	import org.eclipse.swt.events.FocusAdapter;
	import org.eclipse.swt.events.FocusEvent;
	import org.eclipse.swt.events.KeyAdapter;
	import org.eclipse.swt.events.KeyEvent;
	import org.eclipse.swt.layout.GridData;
	import org.eclipse.swt.widgets.Composite;
	import org.eclipse.swt.widgets.Label;
	import org.eclipse.swt.widgets.Text;

	public class HookedMultilineStringFieldEditor extends FieldEditor {

	private final IPreferenceCheckStateProvider fCheckStateProvider;

	// private static final String ERROR_MESSAGE = "Multiline.error.message"; //$NON-NLS-1$
	public static final int VALIDATE_ON_KEY_STROKE = 0;
	public static final int VALIDATE_ON_FOCUS_LOST = 1;
	public static int UNLIMITED = -1;

	private boolean isValid;
	private String oldValue;
	private String compTitle;
	private Label title;
	private Text textField;
	private int widthInChars = 120;
	private int textLimit = UNLIMITED;
	private String errorMessage;
	private boolean emptyStringAllowed = true;
	private int validateStrategy = VALIDATE_ON_KEY_STROKE;

	protected HookedMultilineStringFieldEditor() {
	fCheckStateProvider = null;
	}

	public HookedMultilineStringFieldEditor(String name, String labelText, int width, int strategy, IPreferenceCheckStateProvider checkStateProvider, Composite parent) {
	fCheckStateProvider = checkStateProvider;
	init(name, labelText);
	widthInChars = width;
	setValidateStrategy(strategy);
	isValid = false;
	errorMessage = "error";
	createControl(parent);
	}

	public HookedMultilineStringFieldEditor(String name, String labelText, int width, IPreferenceCheckStateProvider checkStateProvider, Composite parent) {
	this(name, labelText, width, VALIDATE_ON_KEY_STROKE, checkStateProvider, parent);
	this.compTitle = labelText;
	}

	public HookedMultilineStringFieldEditor(String name, String labelText, IPreferenceCheckStateProvider checkStateProvider, Composite parent) {
	this(name, labelText, UNLIMITED, checkStateProvider, parent);
	}

	@Override
	public void setEnabled(boolean enabled, Composite parent) {
	super.setEnabled(enabled, parent);
	if (textField != null) {
	textField.setEditable(enabled);
	}
	}

	@Override
	protected void adjustForNumColumns(int numColumns) {
	GridData gd = (GridData) textField.getLayoutData();
	gd.horizontalSpan = numColumns - 1;
	// We only grab excess space if we have to
	// If another field editor has more columns then
	// we assume it is setting the width.
	gd.grabExcessHorizontalSpace = gd.horizontalSpan == 1;
	}

	protected boolean checkState() {

	boolean result = false;
	String txt = "";

	if( textField != null )
	txt = textField.getText();

	result = !txt.trim().isEmpty() \|\| emptyStringAllowed;

	// call hook for subclasses
	result = result && doCheckState();

	if (result)
	clearErrorMessage();
	else
	showErrorMessage(errorMessage);

	return result;
	}

	protected boolean doCheckState() {
	if (fCheckStateProvider != null) {
	return fCheckStateProvider.doCheckState(this, getTextControl().getText());
	}
	return true;
	}

	@Override
	protected void doFillIntoGrid(Composite parent, int numColumns) {

	title = new Label(parent, SWT.UP);
	title.setFont(parent.getFont());
	this.compTitle = getLabelText();
	title.setText(this.compTitle);
	title.setLayoutData(new GridData(GridData.VERTICAL_ALIGN_BEGINNING));

	textField = getTextControl(parent);
	GridData gd = new GridData(GridData.FILL_HORIZONTAL);
	gd.widthHint = 100;
	gd.heightHint = 500;
	textField.setLayoutData(gd);

	}

	@Override
	protected void doLoad() {
	if (textField != null) {
	String value = getPreferenceStore().getString(getPreferenceName());
	textField.setText(value);
	oldValue = value;
	}
	}

	@Override
	protected void doLoadDefault() {
	if (textField != null) {
	String value = getPreferenceStore().getDefaultString(
	getPreferenceName());
	textField.setText(value);
	}
	valueChanged();
	}

	@Override
	protected void doStore() {
	getPreferenceStore().setValue(getPreferenceName(), textField.getText());
	}

	public String getErrorMessage() {
	return errorMessage;
	}

	@Override
	public int getNumberOfControls() {
	return 2;
	}

	public String getStringValue() {
	if (textField != null)
	return textField.getText();
	else
	return getPreferenceStore().getString(getPreferenceName());
	}

	protected Text getTextControl() {
	return textField;
	}

	public Text getTextControl(Composite parent) {
	if (textField == null) {
	textField = new Text(parent, SWT.MULTI \| SWT.V_SCROLL \| SWT.BORDER
	\| SWT.WRAP);
	textField.setFont(parent.getFont());
	switch (validateStrategy) {
	case VALIDATE_ON_KEY_STROKE:
	textField.addKeyListener(new KeyAdapter() {
	@Override
	public void keyPressed(KeyEvent e) {
	valueChanged();
	}
	});

	textField.addFocusListener(new FocusAdapter() {
	@Override
	public void focusGained(FocusEvent e) {
	refreshValidState();
	}

	@Override
	public void focusLost(FocusEvent e) {
	clearErrorMessage();
	}
	});
	break;
	case VALIDATE_ON_FOCUS_LOST:
	textField.addKeyListener(new KeyAdapter() {
	@Override
	public void keyPressed(KeyEvent e) {
	clearErrorMessage();
	}
	});
	textField.addFocusListener(new FocusAdapter() {
	@Override
	public void focusGained(FocusEvent e) {
	refreshValidState();
	}

	@Override
	public void focusLost(FocusEvent e) {
	valueChanged();
	clearErrorMessage();
	}
	});
	break;
	default:
	Assert.isTrue(false, "Unknown validate strategy"); //$NON-NLS-1$
	}
	textField.addDisposeListener(new DisposeListener() {
	@Override
	public void widgetDisposed(DisposeEvent event) {
	textField = null;
	}
	});
	if (textLimit > 0) { // Only set limits above 0 - see SWT spec
	textField.setTextLimit(textLimit);
	}
	} else {
	checkParent(textField, parent);
	}
	return textField;
	}

	public boolean isEmptyStringAllowed() {
	return emptyStringAllowed;
	}

	@Override
	public boolean isValid() {
	return isValid;
	}

	@Override
	protected void refreshValidState() {
	isValid = checkState();
	}

	public void setEmptyStringAllowed(boolean b) {
	emptyStringAllowed = b;
	}

	public void setErrorMessage(String message) {
	errorMessage = message;
	}

	@Override
	public void setFocus() {
	if (textField != null) {
	textField.setFocus();
	}
	}

	public void setStringValue(String value) {
	if (textField != null) {
	if (value == null)
	value = ""; //$NON-NLS-1$
	oldValue = textField.getText();
	if (!oldValue.equals(value)) {
	textField.setText(value);
	valueChanged();
	}
	}
	}

	public void setTextLimit(int limit) {
	textLimit = limit;
	if (textField != null)
	textField.setTextLimit(limit);
	}

	public void setValidateStrategy(int value) {
	Assert.isTrue(value == VALIDATE_ON_FOCUS_LOST
	\|\| value == VALIDATE_ON_KEY_STROKE);
	validateStrategy = value;
	}

	public void showErrorMessage() {
	showErrorMessage(errorMessage);
	}

	protected void valueChanged() {
	setPresentsDefaultValue(false);
	boolean oldState = isValid;
	refreshValidState();

	if (isValid != oldState)
	fireStateChanged(IS_VALID, oldState, isValid);

	String newValue = textField.getText();
	if (!newValue.equals(oldValue)) {
	fireValueChanged(VALUE, oldValue, newValue);
	oldValue = newValue;
	}
	}

	}