ControlBuilder.java

/**
 * Copyright (c) Red Hat, Inc., contributors and others 2013 - 2014. All rights reserved
 *
 * Licensed under the Eclipse Public License version 1.0, available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.jboss.tools.forge.ui.internal.ext.control;

import org.eclipse.jface.bindings.keys.KeyStroke;
import org.eclipse.jface.fieldassist.ContentProposalAdapter;
import org.eclipse.jface.fieldassist.ControlDecoration;
import org.eclipse.jface.fieldassist.FieldDecoration;
import org.eclipse.jface.fieldassist.FieldDecorationRegistry;
import org.eclipse.jface.fieldassist.TextContentAdapter;
import org.eclipse.rse.ui.Mnemonics;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text;
import org.jboss.forge.addon.convert.ConverterFactory;
import org.jboss.forge.addon.ui.hints.InputType;
import org.jboss.forge.addon.ui.input.InputComponent;
import org.jboss.forge.addon.ui.input.UICompleter;
import org.jboss.forge.addon.ui.util.InputComponents;
import org.jboss.forge.furnace.util.Strings;
import org.jboss.tools.forge.core.furnace.FurnaceService;
import org.jboss.tools.forge.ui.internal.ext.autocomplete.InputComponentProposalProvider;
import org.jboss.tools.forge.ui.internal.ext.context.UIContextImpl;
import org.jboss.tools.forge.ui.internal.ext.wizards.ForgeWizardPage;

/**
 * Builds a control
 *
 * @author <a href="mailto:ggastald@redhat.com">George Gastaldi</a>
 *
 */
public abstract class ControlBuilder<CONTROL extends Control> {

	protected static final String LABEL_DATA_KEY = "forge.label";
	private static final String NOTE_DATA_KEY = "forge.note";

	/**
	 * Builds an Eclipse {@link Control} object based on the input
	 *
	 * @param page
	 *            TODO
	 * @param input
	 * @param inputName
	 *            TODO
	 * @param container
	 *            the container this control will be placed on
	 * @return
	 */
	public abstract CONTROL build(final ForgeWizardPage page, final InputComponent<?, ?> input, final String inputName,
			final Composite container);

	/**
	 * Returns the supported type this control may produce
	 *
	 * @return
	 */
	protected abstract Class<?> getProducedType();

	/**
	 * Returns the supported input type for this component
	 *
	 * @return
	 */
	protected abstract String getSupportedInputType();

	/**
	 * Returns the subclasses of {@link InputComponent}
	 *
	 * @return
	 */
	protected abstract Class<?>[] getSupportedInputComponentTypes();

	/**
	 * Tests if this builder may handle this specific input
	 *
	 * @param input
	 * @return
	 */
	public boolean handles(InputComponent<?, ?> input) {
		boolean handles = false;
		for (Class<?> inputType : getSupportedInputComponentTypes()) {
			if (inputType.isInstance(input)) {
				handles = true;
				break;
			}
		}

		if (handles) {
			String inputTypeHint = InputComponents.getInputType(input);
			if (inputTypeHint != null && !inputTypeHint.equals(InputType.DEFAULT)) {
				handles = inputTypeHint.equals(getSupportedInputType());
			} else {
				// Fallback to standard type
				handles = getProducedType().isAssignableFrom(input.getValueType());
			}
		}

		return handles;
	}

	public void setEnabled(CONTROL control, boolean enabled) {
		if (control instanceof Composite) {
			Composite c = (Composite) control;
			for (Control child : c.getChildren()) {
				child.setEnabled(enabled);
			}
		} else {
			control.setEnabled(enabled);
		}
	}

	/**
	 * Return the controls that accept listeners for modifications
	 */
	public Control[] getModifiableControlsFor(CONTROL control) {
		if (control instanceof Composite) {
			return ((Composite) control).getChildren();
		} else {
			return new Control[] { control };
		}
	}

	protected ContentProposalAdapter setupAutoCompleteForText(UIContextImpl context, InputComponent<?, ?> input,
			UICompleter<?> completer, Text text) {
		ContentProposalAdapter result = null;
		if (completer != null) {
			ControlDecoration dec = new ControlDecoration(text, SWT.TOP | SWT.LEFT);
			// Add lightbulb
			FieldDecoration completerIndicator = FieldDecorationRegistry.getDefault()
					.getFieldDecoration(FieldDecorationRegistry.DEC_CONTENT_PROPOSAL);
			dec.setImage(completerIndicator.getImage());
			dec.setDescriptionText(completerIndicator.getDescription());

			// Register auto-complete
			KeyStroke activationKeyStroke = KeyStroke.getInstance(SWT.CONTROL, SWT.SPACE);
			result = new ContentProposalAdapter(text, new TextContentAdapter(),
					new InputComponentProposalProvider(context, input, completer), activationKeyStroke, null);
			result.setProposalAcceptanceStyle(ContentProposalAdapter.PROPOSAL_REPLACE);
		}
		return result;
	}

	public void setupNote(Composite parent, Control control, InputComponent<?, ?> input) {
		// Add a placeholder
		Label placeholder = new Label(parent, SWT.NONE);
		GridData layoutData = new GridData();
		layoutData.heightHint = SWT.NULL;
		placeholder.setLayoutData(layoutData);

		// Label as the note for this component
		Label notes = new Label(parent, SWT.WRAP);
		control.setData(NOTE_DATA_KEY, notes);
		layoutData = new GridData(GridData.FILL_HORIZONTAL);
		layoutData.horizontalSpan = 2;
		notes.setLayoutData(layoutData);
		String note = input.getNote();
		if (Strings.isNullOrEmpty(note)) {
			layoutData.heightHint = SWT.NULL;
		} else {
			notes.setText(note);
		}
	}

	protected String getMnemonicLabel(InputComponent<?, ?> input, boolean addColon) {
		String label = InputComponents.getLabelFor(input, addColon);
		char shortName = input.getShortName();
		if (shortName != InputComponents.DEFAULT_SHORT_NAME) {
			label = Mnemonics.applyMnemonic(label, shortName);
		}
		return label;
	}

	public void updateState(CONTROL control, InputComponent<?, ?> input) {
		setEnabled(control, input.isEnabled());
		setNote(control, input.getNote());
		setLabelTooltip(control, input.getDescription());
	}

	protected void setNote(CONTROL control, String note) {
		Label notes = (Label) control.getData(NOTE_DATA_KEY);
		GridData gridData = (GridData) notes.getLayoutData();
		boolean changed = !(notes.getText().equals(note));
		if (Strings.isNullOrEmpty(note)) {
			gridData.heightHint = SWT.NULL;
			notes.setText("");
		} else {
			gridData.heightHint = SWT.DEFAULT;
			notes.setText(note);
		}
		if (changed) {
			notes.getParent().layout();
			notes.getParent().redraw();
		}
	}

	protected void setLabelTooltip(CONTROL control, String tooltip) {
		Label label = (Label) control.getData(LABEL_DATA_KEY);
		if (label != null) {
			label.setToolTipText(tooltip);
		}
	}

	protected ConverterFactory getConverterFactory() {
		return FurnaceService.INSTANCE.getConverterFactory();
	}
}