GeneralInformationComposite.java

/*******************************************************************************
 * This file is protected by Copyright. 
 * Please refer to the COPYRIGHT file distributed with this source distribution.
 *
 * This file is part of REDHAWK IDE.
 *
 * 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
 *******************************************************************************/
package gov.redhawk.ide.spd.internal.ui.editor.composite;

import gov.redhawk.common.ui.editor.FormLayoutFactory;
import gov.redhawk.common.ui.parts.FormEntry;
import gov.redhawk.ui.editor.IScaComposite;

import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.IActionBars;
import org.eclipse.ui.forms.widgets.FormToolkit;
import org.eclipse.ui.forms.widgets.TableWrapData;

/**
 * 
 */
public class GeneralInformationComposite extends Composite implements IScaComposite {
	private static final int NUM_COLUMNS = 3;

	private boolean isLibrary; // Let's us know if the resource is a Softpackage Library
	
	private FormEntry typeEntry;
	private FormEntry descriptionEntry;
	private FormEntry scdEntry;
	private FormEntry prfEntry;
	private FormEntry titleEntry;
	private FormEntry idEntry;
	private FormEntry versionEntry;
	private FormEntry nameEntry;

	/**
	 * @param parent
	 * @param style
	 * @param toolkit
	 * @param actionBars
	 */
	public GeneralInformationComposite(final Composite parent, final int style, final FormToolkit toolkit, final IActionBars actionBars, final boolean isLibrary) {
		super(parent, style);
		this.setLayout(FormLayoutFactory.createSectionClientGridLayout(false, GeneralInformationComposite.NUM_COLUMNS));
		this.isLibrary = isLibrary;

		createTypeEntry(this, toolkit, actionBars);
		createIDEntry(this, toolkit, actionBars);
		createNameEntry(this, toolkit, actionBars);
		createVersionEntry(this, toolkit, actionBars);
		createTitleEntry(this, toolkit, actionBars);

		if (!this.isLibrary) {
			// Don't include these fields if the resource is a Softpackage Library
			createPrfFileEntry(this, toolkit, actionBars);
			createScdFileEntry(this, toolkit, actionBars);
		}
		
		createDescriptionEntry(this, toolkit, actionBars);
	}

	/**
	 * Creates the type entry.
	 * 
	 * @param client the client
	 * @param toolkit the toolkit
	 * @param actionBars the action bars
	 */
	private void createTypeEntry(final Composite client, final FormToolkit toolkit, final IActionBars actionBars) {
		this.typeEntry = new FormEntry(client, toolkit, "Type:", null, false);
		this.typeEntry.setEditable(false);
		this.typeEntry.getText().setEnabled(false);
	}

	/**
	 * Creates the description area.
	 * 
	 * @param client the client
	 * @param toolkit the toolkit
	 * @param actionBars the action bars
	 */
	private void createDescriptionEntry(final Composite client, final FormToolkit toolkit, final IActionBars actionBars) {
		this.descriptionEntry = new FormEntry(client, toolkit, "Description:", SWT.MULTI | SWT.WRAP);
		final Object data = this.descriptionEntry.getText().getLayoutData();
		if (data instanceof GridData) {
			((GridData) this.descriptionEntry.getLabel().getLayoutData()).verticalAlignment = SWT.TOP;
			final GridData gData = (GridData) data;
			gData.verticalAlignment = SWT.FILL;
			gData.grabExcessVerticalSpace = true;
			gData.heightHint = 75; // SUPPRESS CHECKSTYLE MagicNumber
		} else if (data instanceof TableWrapData) {
			((TableWrapData) this.descriptionEntry.getLabel().getLayoutData()).valign = SWT.TOP;
			final TableWrapData tData = (TableWrapData) data;
			tData.valign = SWT.FILL;
			tData.grabVertical = true;
			tData.heightHint = 75; // SUPPRESS CHECKSTYLE MagicNumber
		}
	}

	/**
	 * Creates the description file entry.
	 * 
	 * @param client the client
	 * @param toolkit the toolkit
	 * @param actionBars the action bars
	 */
	private void createScdFileEntry(final Composite client, final FormToolkit toolkit, final IActionBars actionBars) {
		this.scdEntry = new FormEntry(client, toolkit, "SCD:", "Browse...", true);
	}

	/**
	 * Creates the property file entry.
	 * 
	 * @param client the client
	 * @param toolkit the toolkit
	 * @param actionBars the action bars
	 */
	private void createPrfFileEntry(final Composite client, final FormToolkit toolkit, final IActionBars actionBars) {
		this.prfEntry = new FormEntry(client, toolkit, "PRF:", "Browse...", true);
	}

	/**
	 * Creates the title entry.
	 * 
	 * @param client the client
	 * @param toolkit the toolkit
	 * @param actionBars the action bars
	 */
	private void createTitleEntry(final Composite client, final FormToolkit toolkit, final IActionBars actionBars) {
		this.titleEntry = new FormEntry(client, toolkit, "Title:", null, false);
	}

	/**
	 * Creates the id entry.
	 * 
	 * @param client the client
	 * @param toolkit the toolkit
	 * @param actionBars the action bars
	 */
	private void createIDEntry(final Composite client, final FormToolkit toolkit, final IActionBars actionBars) {
		this.idEntry = new FormEntry(client, toolkit, "ID*:", "Generate", false);

	}

	/**
	 * Creates the version entry.
	 * 
	 * @param client the client
	 * @param toolkit the toolkit
	 * @param actionBars the action bars
	 */
	private void createVersionEntry(final Composite client, final FormToolkit toolkit, final IActionBars actionBars) {
		this.versionEntry = new FormEntry(client, toolkit, "Version:", null, false);
	}

	/**
	 * Creates the name entry.
	 * 
	 * @param client the client
	 * @param toolkit the toolkit
	 * @param actionBars the action bars
	 */
	private void createNameEntry(final Composite client, final FormToolkit toolkit, final IActionBars actionBars) {
		this.nameEntry = new FormEntry(client, toolkit, "Name*:", null, false);
	}

	/**
	 * @return the typeEntry
	 */
	public FormEntry getTypeEntry() {
		return this.typeEntry;
	}

	/**
	 * @return the descriptionEntry
	 */
	public FormEntry getDescriptionEntry() {
		return this.descriptionEntry;
	}

	/**
	 * @return the scdEntry
	 */
	public FormEntry getScdEntry() {
		return this.scdEntry;
	}

	/**
	 * @return the prfEntry
	 */
	public FormEntry getPrfEntry() {
		return this.prfEntry;
	}

	/**
	 * @return the titleEntry
	 */
	public FormEntry getTitleEntry() {
		return this.titleEntry;
	}

	/**
	 * @return the idEntry
	 */
	public FormEntry getIdEntry() {
		return this.idEntry;
	}

	/**
	 * @return the versionEntry
	 */
	public FormEntry getVersionEntry() {
		return this.versionEntry;
	}

	/**
	 * @return the nameEntry
	 */
	public FormEntry getNameEntry() {
		return this.nameEntry;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void setEditable(final boolean editable) {
		this.descriptionEntry.setEditable(editable);
		this.idEntry.setEditable(editable);
		this.nameEntry.setEditable(editable);
		if (!this.isLibrary) {
			this.prfEntry.setEditable(editable);
			this.scdEntry.setEditable(editable);
		}
		this.titleEntry.setEditable(editable);
		// this.typeEntry.setEditable(editable);
		this.versionEntry.setEditable(editable);
	}

}