JbiEditorDetailsContribution.java

/******************************************************************************
 * Copyright (c) 2011-2013, Linagora
 *
 * 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:
 * 		Linagora - initial API and implementation
 *******************************************************************************/
 
package com.ebmwebsourcing.petals.services.su.editor.extensibility;

import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import org.eclipse.ui.forms.widgets.ExpandableComposite;
import org.eclipse.ui.forms.widgets.FormToolkit;
import org.eclipse.ui.forms.widgets.Section;

import com.ebmwebsourcing.petals.common.internal.provisional.formeditor.ISharedEdition;
import com.sun.java.xml.ns.jbi.AbstractEndpoint;

/**
 * @author Mickael Istria - EBM WebSourcing
 */
public abstract class JbiEditorDetailsContribution {

	/**
	 * Adds content in the main tab of the JBI editor.
	 * @param endpoint
	 * @param toolkit
	 * @param generalDetails
	 * @param ise
	 */
	public abstract void addMainSUContent(AbstractEndpoint endpoint, FormToolkit toolkit, Composite generalDetails, ISharedEdition ise);


	/**
	 * Adds content in the advanced tab of the JBI editor.
	 * @param endpoint
	 * @param toolkit
	 * @param advancedDetails
	 * @param ise
	 */
	public abstract void addAdvancedSUContent(AbstractEndpoint endpoint, FormToolkit toolkit, Composite advancedDetails, ISharedEdition ise);


	/**
	 * Creates an editor section which is not expanded.
	 * <p>
	 * Equivalent to <code>createEditorSection( parent, toolkit, title, false );</code>.
	 * </p>
	 *
	 * @param parent
	 * @param toolkit
	 * @param title
	 * @return a composite (which the client of a section)
	 */
	protected Composite createEditorSection( Composite parent, FormToolkit toolkit, String title ) {
		return createEditorSection( parent, toolkit, title, false );
	}


	/**
	 * Creates an editor section.
	 * @param parent
	 * @param toolkit
	 * @param title
	 * @param expandable true to make it expandable, false otherwise
	 * @return a composite (which the client of a section)
	 */
	protected Composite createEditorSection( Composite parent, FormToolkit toolkit, String title, boolean expandable ) {
		return createEditorSection( parent, toolkit, title, null, expandable );
	}


	/**
	 * Creates an editor section.
	 * @param parent
	 * @param toolkit
	 * @param title
	 * @param description
	 * @param expanded true to make it expanded, false to make it expandable
	 * @return a composite (which the client of a section)
	 */
	protected Composite createEditorSection( Composite parent, FormToolkit toolkit, String title, String description, boolean expanded ) {

		int style = expanded ? Section.EXPANDED | Section.TITLE_BAR : Section.TITLE_BAR | ExpandableComposite.TWISTIE;
		if( description != null )
			style |= Section.DESCRIPTION;

		Section section = toolkit.createSection( parent, style );
		section.setText( title );
		section.setLayoutData( new GridData( GridData.FILL_HORIZONTAL ));
		if( description != null ) {
			section.setDescription( description );
			section.clientVerticalSpacing = 10;
		}

		Composite composite = toolkit.createComposite( section );
		composite.setLayout( new GridLayout( 2, false ));
		section.setClient( composite );

		return composite;
	}


	/**
	 * Creates the common section for "provides" blocks.
	 * @param parent
	 * @param toolkit
	 * @return a composite
	 */
	protected Composite createCommonProvideSection( Composite parent, FormToolkit toolkit ) {
		return createEditorSection( parent, toolkit, "Identification", "Edit the service identifiers and WSDL properties.", true );
	}


	/**
	 * Creates the common section for "consumes" blocks.
	 * @param parent
	 * @param toolkit
	 * @return a composite
	 */
	protected Composite createCommonConsumeSection( Composite parent, FormToolkit toolkit ) {
		return createEditorSection( parent, toolkit, "Identification", "Define the service search filters and invocation properties.", true );
	}


	/**
	 * Creates a label with the right font for the JBI editor.
	 * @param toolkit
	 * @param parent
	 * @param text
	 */
	protected void createLabel( FormToolkit toolkit, Composite parent, String text, String tooltip ) {
		Label l = toolkit.createLabel( parent, text );
		l.setForeground( parent.getDisplay().getSystemColor( SWT.COLOR_DARK_BLUE ));
		l.setToolTipText( tooltip );
	}
}