org.eclipse.osbp.runtime.web.ecview.presentation.vaadin/src/org/eclipse/osbp/runtime/web/ecview/presentation/vaadin/internal/BrowserPresentation.java - osbp/org.eclipse.osbp.runtime.web - Git at Google

 /**
  * Copyright (c) 2011, 2015 - Lunifera GmbH (Gross Enzersdorf, Austria), 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:
  *         Florian Pirchner - Initial implementation
  */
 package org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.internal;

 import java.io.InputStream;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.util.Locale;

 import org.eclipse.core.databinding.Binding;
 import org.eclipse.core.databinding.UpdateValueStrategy;
 import org.eclipse.core.databinding.beans.PojoObservables;
 import org.eclipse.core.databinding.observable.value.IObservableValue;
 import org.eclipse.emf.databinding.EMFObservables;
 import org.eclipse.emf.ecore.EObject;
 import org.eclipse.emf.ecore.EStructuralFeature;
 import org.eclipse.osbp.ecview.core.common.editpart.IElementEditpart;
 import org.eclipse.osbp.ecview.core.extension.model.extension.ExtensionModelPackage;
 import org.eclipse.osbp.ecview.core.extension.model.extension.YBrowser;
 import org.eclipse.osbp.ecview.core.extension.model.extension.YBrowserStreamInput;
 import org.eclipse.osbp.ecview.core.ui.core.editparts.extension.IBrowserEditpart;
 import org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.IBindingManager;
 import org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.common.AbstractEmbeddedWidgetPresenter;
 import org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.internal.util.Util;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

 import com.vaadin.server.ExternalResource;
 import com.vaadin.server.Resource;
 import com.vaadin.server.StreamResource;
 import com.vaadin.ui.AbstractComponentContainer;
 import com.vaadin.ui.AbstractEmbedded;
 import com.vaadin.ui.BrowserFrame;
 import com.vaadin.ui.Component;
 import com.vaadin.ui.ComponentContainer;

 // TODO: Auto-generated Javadoc
 /**
  * This presenter is responsible to render a text area on the given layout.
  */
 public class BrowserPresentation extends
 		AbstractEmbeddedWidgetPresenter<Component> {

 	/** The Constant LOGGER. */
 	private static final Logger LOGGER = LoggerFactory
 			.getLogger(BrowserPresentation.class);

 	/** The model access. */
 	private final ModelAccess modelAccess;

 	/** The source converter. */
 	private SourceConverter sourceConverter;

 	/** The browser. */
 	private BrowserFrame browser;

 	/**
 	 * Constructor.
 	 *
 	 * @param editpart
 	 *            The editpart of that presenter
 	 */
 	public BrowserPresentation(IElementEditpart editpart) {
 		super((IBrowserEditpart) editpart);
 		this.modelAccess = new ModelAccess((YBrowser) editpart.getModel());
 	}

 	/**
 	 * {@inheritDoc}
 	 */
 	@Override
 	public Component doCreateWidget(Object parent) {
 		if (browser == null) {

 			browser = new BrowserFrame();
 			browser.addStyleName(CSS_CLASS_CONTROL);
 			browser.setImmediate(true);
 			setupComponent(browser, getCastedModel());

 			associateWidget(browser, modelAccess.yField);

 			if (modelAccess.isCssIdValid()) {
 				browser.setId(modelAccess.getCssID());
 			} else {
 				browser.setId(getEditpart().getId());
 			}

 			initialize(browser, getCastedModel());

 			// creates the binding for the field
 			createBindings(modelAccess.yField, browser, null);

 			if (modelAccess.isCssClassValid()) {
 				browser.addStyleName(modelAccess.getCssClass());
 			}

 			// set the captions
 			applyCaptions();
 		}
 		return browser;
 	}

 	/**
 	 * Creates the bindings for the given values.
 	 *
 	 * @param yField
 	 *            the y field
 	 * @param field
 	 *            the field
 	 * @param parent
 	 *            the parent
 	 */
 	protected void createBindings(YBrowser yField, BrowserFrame field,
 			AbstractComponentContainer parent) {

 		// bind the model to the source converter
 		registerBinding(createBindingsSource(castEObject(getModel()),
 				ExtensionModelPackage.Literals.YBROWSER__VALUE, field));

 		super.createBindings(yField, field, parent);
 	}

 	/**
 	 * Creates the bindings source.
 	 *
 	 * @param model
 	 *            the model
 	 * @param modelFeature
 	 *            the model feature
 	 * @param field
 	 *            the field
 	 * @return the binding
 	 */
 	protected Binding createBindingsSource(EObject model,
 			EStructuralFeature modelFeature, AbstractEmbedded field) {
 		IBindingManager bindingManager = getViewContext()
 				.getService(
 						org.eclipse.osbp.ecview.core.common.binding.IECViewBindingManager.class
 								.getName());
 		if (bindingManager != null) {

 			sourceConverter = new SourceConverter();

 			// bind the value of yText to textRidget
 			IObservableValue modelObservable = EMFObservables.observeValue(
 					model, modelFeature);
 			IObservableValue uiObservable = PojoObservables.observeValue(
 					sourceConverter, "source");
 			return bindingManager.bindValue(uiObservable, modelObservable,
 					new UpdateValueStrategy(UpdateValueStrategy.POLICY_NEVER),
 					new UpdateValueStrategy(UpdateValueStrategy.POLICY_UPDATE));
 		}
 		return null;
 	}

 	/* (non-Javadoc)
 	 * @see org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.common.AbstractVaadinWidgetPresenter#doUpdateLocale(java.util.Locale)
 	 */
 	@Override
 	protected void doUpdateLocale(Locale locale) {
 		// no need to set the locale to the ui elements. Is handled by vaadin
 		// internally.

 		// update the captions
 		applyCaptions();
 	}

 	/**
 	 * Applies the labels to the widgets.
 	 */
 	protected void applyCaptions() {
 		Util.applyCaptions(getI18nService(), modelAccess.getLabel(),
 				modelAccess.getLabelI18nKey(), getLocale(), browser);
 	}

 	/* (non-Javadoc)
 	 * @see org.eclipse.osbp.ecview.core.common.presentation.IWidgetPresentation#getWidget()
 	 */
 	@Override
 	public Component getWidget() {
 		return browser;
 	}

 	/* (non-Javadoc)
 	 * @see org.eclipse.osbp.ecview.core.common.presentation.IWidgetPresentation#isRendered()
 	 */
 	@Override
 	public boolean isRendered() {
 		return browser != null;
 	}

 	/**
 	 * {@inheritDoc}
 	 */
 	@Override
 	public void doUnrender() {
 		if (browser != null) {

 			// unbind all active bindings
 			unbind();

 			// remove assocations
 			unassociateWidget(browser);

 			Component parent = ((Component) browser.getParent());
 			if (parent != null && parent instanceof ComponentContainer) {
 				((ComponentContainer) parent).removeComponent(browser);
 			}
 			browser = null;
 			sourceConverter = null;
 		}
 	}

 	/**
 	 * {@inheritDoc}
 	 */
 	@Override
 	protected void internalDispose() {
 		try {
 			unrender();
 		} finally {
 			super.internalDispose();
 		}
 	}

 	/**
 	 * A helper class.
 	 */
 	private static class ModelAccess {

 		/** The y field. */
 		private final YBrowser yField;

 		/**
 		 * Instantiates a new model access.
 		 *
 		 * @param yField
 		 *            the y field
 		 */
 		public ModelAccess(YBrowser yField) {
 			super();
 			this.yField = yField;
 		}

 		/**
 		 * Gets the css class.
 		 *
 		 * @return the css class
 		 * @see org.eclipse.osbp.ecview.core.ui.core.model.core.YCssAble#getCssClass()
 		 */
 		public String getCssClass() {
 			return yField.getCssClass();
 		}

 		/**
 		 * Returns true, if the css class is not null and not empty.
 		 *
 		 * @return true, if is css class valid
 		 */
 		public boolean isCssClassValid() {
 			return getCssClass() != null && !getCssClass().equals("");
 		}

 		/**
 		 * Gets the css id.
 		 *
 		 * @return the css id
 		 * @see org.eclipse.osbp.ecview.core.ui.core.model.core.YCssAble#getCssID()
 		 */
 		public String getCssID() {
 			return yField.getCssID();
 		}

 		/**
 		 * Returns true, if the css id is not null and not empty.
 		 *
 		 * @return true, if is css id valid
 		 */
 		public boolean isCssIdValid() {
 			return getCssID() != null && !getCssID().equals("");
 		}

 		/**
 		 * Returns the label.
 		 *
 		 * @return the label
 		 */
 		public String getLabel() {
 			return yField.getDatadescription() != null ? yField
 					.getDatadescription().getLabel() : null;
 		}

 		/**
 		 * Returns the label.
 		 *
 		 * @return the label i18n key
 		 */
 		public String getLabelI18nKey() {
 			return yField.getDatadescription() != null ? yField
 					.getDatadescription().getLabelI18nKey() : null;
 		}
 	}

 	/**
 	 * The Class SourceConverter.
 	 */
 	@SuppressWarnings("serial")
 	private class SourceConverter {

 		/** The source. */
 		private Object source;

 		/**
 		 * Gets the source.
 		 *
 		 * @return the source
 		 */
 		@SuppressWarnings("unused")
 		public Object getSource() {
 			return source;
 		}

 		/**
 		 * Sets the source.
 		 *
 		 * @param source
 		 *            the new source
 		 * @throws MalformedURLException
 		 *             the malformed url exception
 		 */
 		@SuppressWarnings("unused")
 		public void setSource(Object source) throws MalformedURLException {
 			this.source = source;

 			if (browser == null) {
 				LOGGER.error("Browser instance is null, but binding still active!");
 				return;
 			}

 			Resource resource = null;
 			if (source instanceof String) {
 				resource = new ExternalResource(new URL((String) source));
 			} else if (source instanceof YBrowserStreamInput) {
 				YBrowserStreamInput input = (YBrowserStreamInput) source;
 				final InputStream stream = input.getInputStream();
 				StreamResource tempResource = new StreamResource(
 						new StreamResource.StreamSource() {
 							@Override
 							public InputStream getStream() {
 								return stream;
 							}
 						}, input.getFilename());
 				tempResource.setMIMEType(input.getMimeType());
 				resource = tempResource;
 			}

 			browser.setSource(resource);
 		}
 	}
 }
	/**
	* Copyright (c) 2011, 2015 - Lunifera GmbH (Gross Enzersdorf, Austria), 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:
	* Florian Pirchner - Initial implementation
	*/
	package org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.internal;

	import java.io.InputStream;
	import java.net.MalformedURLException;
	import java.net.URL;
	import java.util.Locale;

	import org.eclipse.core.databinding.Binding;
	import org.eclipse.core.databinding.UpdateValueStrategy;
	import org.eclipse.core.databinding.beans.PojoObservables;
	import org.eclipse.core.databinding.observable.value.IObservableValue;
	import org.eclipse.emf.databinding.EMFObservables;
	import org.eclipse.emf.ecore.EObject;
	import org.eclipse.emf.ecore.EStructuralFeature;
	import org.eclipse.osbp.ecview.core.common.editpart.IElementEditpart;
	import org.eclipse.osbp.ecview.core.extension.model.extension.ExtensionModelPackage;
	import org.eclipse.osbp.ecview.core.extension.model.extension.YBrowser;
	import org.eclipse.osbp.ecview.core.extension.model.extension.YBrowserStreamInput;
	import org.eclipse.osbp.ecview.core.ui.core.editparts.extension.IBrowserEditpart;
	import org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.IBindingManager;
	import org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.common.AbstractEmbeddedWidgetPresenter;
	import org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.internal.util.Util;
	import org.slf4j.Logger;
	import org.slf4j.LoggerFactory;

	import com.vaadin.server.ExternalResource;
	import com.vaadin.server.Resource;
	import com.vaadin.server.StreamResource;
	import com.vaadin.ui.AbstractComponentContainer;
	import com.vaadin.ui.AbstractEmbedded;
	import com.vaadin.ui.BrowserFrame;
	import com.vaadin.ui.Component;
	import com.vaadin.ui.ComponentContainer;

	// TODO: Auto-generated Javadoc
	/**
	* This presenter is responsible to render a text area on the given layout.
	*/
	public class BrowserPresentation extends
	AbstractEmbeddedWidgetPresenter<Component> {

	/** The Constant LOGGER. */
	private static final Logger LOGGER = LoggerFactory
	.getLogger(BrowserPresentation.class);

	/** The model access. */
	private final ModelAccess modelAccess;

	/** The source converter. */
	private SourceConverter sourceConverter;

	/** The browser. */
	private BrowserFrame browser;

	/**
	* Constructor.
	*
	* @param editpart
	* The editpart of that presenter
	*/
	public BrowserPresentation(IElementEditpart editpart) {
	super((IBrowserEditpart) editpart);
	this.modelAccess = new ModelAccess((YBrowser) editpart.getModel());
	}

	/**
	* {@inheritDoc}
	*/
	@Override
	public Component doCreateWidget(Object parent) {
	if (browser == null) {

	browser = new BrowserFrame();
	browser.addStyleName(CSS_CLASS_CONTROL);
	browser.setImmediate(true);
	setupComponent(browser, getCastedModel());

	associateWidget(browser, modelAccess.yField);

	if (modelAccess.isCssIdValid()) {
	browser.setId(modelAccess.getCssID());
	} else {
	browser.setId(getEditpart().getId());
	}

	initialize(browser, getCastedModel());

	// creates the binding for the field
	createBindings(modelAccess.yField, browser, null);

	if (modelAccess.isCssClassValid()) {
	browser.addStyleName(modelAccess.getCssClass());
	}

	// set the captions
	applyCaptions();
	}
	return browser;
	}

	/**
	* Creates the bindings for the given values.
	*
	* @param yField
	* the y field
	* @param field
	* the field
	* @param parent
	* the parent
	*/
	protected void createBindings(YBrowser yField, BrowserFrame field,
	AbstractComponentContainer parent) {

	// bind the model to the source converter
	registerBinding(createBindingsSource(castEObject(getModel()),
	ExtensionModelPackage.Literals.YBROWSER__VALUE, field));

	super.createBindings(yField, field, parent);
	}

	/**
	* Creates the bindings source.
	*
	* @param model
	* the model
	* @param modelFeature
	* the model feature
	* @param field
	* the field
	* @return the binding
	*/
	protected Binding createBindingsSource(EObject model,
	EStructuralFeature modelFeature, AbstractEmbedded field) {
	IBindingManager bindingManager = getViewContext()
	.getService(
	org.eclipse.osbp.ecview.core.common.binding.IECViewBindingManager.class
	.getName());
	if (bindingManager != null) {

	sourceConverter = new SourceConverter();

	// bind the value of yText to textRidget
	IObservableValue modelObservable = EMFObservables.observeValue(
	model, modelFeature);
	IObservableValue uiObservable = PojoObservables.observeValue(
	sourceConverter, "source");
	return bindingManager.bindValue(uiObservable, modelObservable,
	new UpdateValueStrategy(UpdateValueStrategy.POLICY_NEVER),
	new UpdateValueStrategy(UpdateValueStrategy.POLICY_UPDATE));
	}
	return null;
	}

	/* (non-Javadoc)
	* @see org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.common.AbstractVaadinWidgetPresenter#doUpdateLocale(java.util.Locale)
	*/
	@Override
	protected void doUpdateLocale(Locale locale) {
	// no need to set the locale to the ui elements. Is handled by vaadin
	// internally.

	// update the captions
	applyCaptions();
	}

	/**
	* Applies the labels to the widgets.
	*/
	protected void applyCaptions() {
	Util.applyCaptions(getI18nService(), modelAccess.getLabel(),
	modelAccess.getLabelI18nKey(), getLocale(), browser);
	}

	/* (non-Javadoc)
	* @see org.eclipse.osbp.ecview.core.common.presentation.IWidgetPresentation#getWidget()
	*/
	@Override
	public Component getWidget() {
	return browser;
	}

	/* (non-Javadoc)
	* @see org.eclipse.osbp.ecview.core.common.presentation.IWidgetPresentation#isRendered()
	*/
	@Override
	public boolean isRendered() {
	return browser != null;
	}

	/**
	* {@inheritDoc}
	*/
	@Override
	public void doUnrender() {
	if (browser != null) {

	// unbind all active bindings
	unbind();

	// remove assocations
	unassociateWidget(browser);

	Component parent = ((Component) browser.getParent());
	if (parent != null && parent instanceof ComponentContainer) {
	((ComponentContainer) parent).removeComponent(browser);
	}
	browser = null;
	sourceConverter = null;
	}
	}

	/**
	* {@inheritDoc}
	*/
	@Override
	protected void internalDispose() {
	try {
	unrender();
	} finally {
	super.internalDispose();
	}
	}

	/**
	* A helper class.
	*/
	private static class ModelAccess {

	/** The y field. */
	private final YBrowser yField;

	/**
	* Instantiates a new model access.
	*
	* @param yField
	* the y field
	*/
	public ModelAccess(YBrowser yField) {
	super();
	this.yField = yField;
	}

	/**
	* Gets the css class.
	*
	* @return the css class
	* @see org.eclipse.osbp.ecview.core.ui.core.model.core.YCssAble#getCssClass()
	*/
	public String getCssClass() {
	return yField.getCssClass();
	}

	/**
	* Returns true, if the css class is not null and not empty.
	*
	* @return true, if is css class valid
	*/
	public boolean isCssClassValid() {
	return getCssClass() != null && !getCssClass().equals("");
	}

	/**
	* Gets the css id.
	*
	* @return the css id
	* @see org.eclipse.osbp.ecview.core.ui.core.model.core.YCssAble#getCssID()
	*/
	public String getCssID() {
	return yField.getCssID();
	}

	/**
	* Returns true, if the css id is not null and not empty.
	*
	* @return true, if is css id valid
	*/
	public boolean isCssIdValid() {
	return getCssID() != null && !getCssID().equals("");
	}

	/**
	* Returns the label.
	*
	* @return the label
	*/
	public String getLabel() {
	return yField.getDatadescription() != null ? yField
	.getDatadescription().getLabel() : null;
	}

	/**
	* Returns the label.
	*
	* @return the label i18n key
	*/
	public String getLabelI18nKey() {
	return yField.getDatadescription() != null ? yField
	.getDatadescription().getLabelI18nKey() : null;
	}
	}

	/**
	* The Class SourceConverter.
	*/
	@SuppressWarnings("serial")
	private class SourceConverter {

	/** The source. */
	private Object source;

	/**
	* Gets the source.
	*
	* @return the source
	*/
	@SuppressWarnings("unused")
	public Object getSource() {
	return source;
	}

	/**
	* Sets the source.
	*
	* @param source
	* the new source
	* @throws MalformedURLException
	* the malformed url exception
	*/
	@SuppressWarnings("unused")
	public void setSource(Object source) throws MalformedURLException {
	this.source = source;

	if (browser == null) {
	LOGGER.error("Browser instance is null, but binding still active!");
	return;
	}

	Resource resource = null;
	if (source instanceof String) {
	resource = new ExternalResource(new URL((String) source));
	} else if (source instanceof YBrowserStreamInput) {
	YBrowserStreamInput input = (YBrowserStreamInput) source;
	final InputStream stream = input.getInputStream();
	StreamResource tempResource = new StreamResource(
	new StreamResource.StreamSource() {
	@Override
	public InputStream getStream() {
	return stream;
	}
	}, input.getFilename());
	tempResource.setMIMEType(input.getMimeType());
	resource = tempResource;
	}

	browser.setSource(resource);
	}
	}
	}