rtm/org.eclipse.statet.rtm.base.ui/src/org/eclipse/statet/ecommons/emf/ui/forms/EFFormPage.java

/*=============================================================================#
 # Copyright (c) 2012, 2020 Stephan Wahlbrink and others.
 # 
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License 2.0 which is available at
 # https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 # which is available at https://www.apache.org/licenses/LICENSE-2.0.
 # 
 # SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 # 
 # Contributors:
 #     Stephan Wahlbrink <sw@wahlbrink.eu> - initial API and implementation
 #=============================================================================*/

package org.eclipse.statet.ecommons.emf.ui.forms;

import java.util.ArrayList;
import java.util.List;

import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.jface.viewers.ISelectionProvider;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Layout;
import org.eclipse.ui.forms.IManagedForm;
import org.eclipse.ui.forms.editor.FormPage;
import org.eclipse.ui.forms.widgets.FormToolkit;
import org.eclipse.ui.forms.widgets.ScrolledForm;
import org.eclipse.ui.forms.widgets.TableWrapData;
import org.eclipse.ui.forms.widgets.TableWrapLayout;


public abstract class EFFormPage extends FormPage
		implements IEFFormPage {
	
	
	private final List<EFFormSection> sections= new ArrayList<>();
	
	private ISelectionProvider selectionProvider;
	
	
	public EFFormPage(final EFEditor editor, final String id, final String title) {
		super(editor, id, title);
	}
	
	
	@Override
	public EFEditor getEditor() {
		return (EFEditor) super.getEditor();
	}
	
	protected void registerSection(final EFFormSection section) {
		this.sections.add(section);
	}
	
	
	@Override
	protected void createFormContent(final IManagedForm managedForm) {
		final ScrolledForm form= managedForm.getForm();
		final FormToolkit toolkit= managedForm.getToolkit();
		toolkit.decorateFormHeading(form.getForm());
		
		final IToolBarManager manager= form.getToolBarManager();
		getEditor().contributeToPages(manager);
		
		final IEFModelDescriptor descriptor= getEditor().getModelDescriptor();
		form.setImage(descriptor.getImage());
		form.setText(descriptor.getName());
		
		final Composite body= form.getBody();
		body.setLayout(createBodyLayout());
		
		createFormBodyContent(body);
		
		initBindings();
		
		form.updateToolBar();
		
		body.getDisplay().asyncExec(new Runnable() {
			@Override
			public void run() {
				getManagedForm().reflow(true);
			}
		});
	}
	
	@Override
	public EFToolkit getToolkit() {
		return (EFToolkit) getManagedForm().getToolkit();
	}
	
	protected void initBindings() {
		final EFDataBindingSupport databinding= getEditor().getDataBinding();
		for (final EFFormSection section : this.sections) {
			section.addBindings(databinding);
		}
	}
	
	protected Layout createBodyLayout() {
		return EFLayoutUtil.createBodyTableLayout(1);
	}
	
	protected Composite addBodyComposite() {
		final IManagedForm managedForm= getManagedForm();
		final FormToolkit toolkit= managedForm.getToolkit();
		
		final Composite body= managedForm.getForm().getBody();
		final Composite composite= toolkit.createComposite(body);
		final TableWrapData layoutData= new TableWrapData(TableWrapData.FILL_GRAB);
		layoutData.colspan= ((TableWrapLayout) body.getLayout()).numColumns;
		composite.setLayoutData(layoutData);
		
		return composite;
	}
	
	protected MasterDetailComposite addBodySashComposite() {
		final IManagedForm managedForm= getManagedForm();
		
		final Composite body= managedForm.getForm().getBody();
		final MasterDetailComposite composite= new MasterDetailComposite(body, managedForm);
		final TableWrapData layoutData= new TableWrapData(TableWrapData.FILL_GRAB);
		layoutData.colspan= ((TableWrapLayout) body.getLayout()).numColumns;
		composite.setLayoutData(layoutData);
		
		managedForm.getToolkit().adapt(composite);
		
		return composite;
	}
	
	protected void setSelectionProvider(final ISelectionProvider selectionProvider) {
		this.selectionProvider= selectionProvider;
		getEditor().getSelectionProvider().update();
	}
	
	
	protected abstract void createFormBodyContent(Composite body);
	
	@Override
	public void reflow(final boolean flushCache) {
		getManagedForm().reflow(flushCache);
	}
	
	@Override
	@SuppressWarnings("unchecked")
	public <T> T getAdapter(final Class<T> adapterType) {
		if (adapterType.equals(ISelectionProvider.class)) {
			return (T) this.selectionProvider;
		}
		return super.getAdapter(adapterType);
	}
	
}