org.eclipse.osbp.runtime.web.ecview.presentation.vaadin/src/org/eclipse/osbp/runtime/web/ecview/presentation/vaadin/internal/PanelPresentation.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.util.ArrayList;
 import java.util.Locale;

 import org.eclipse.emf.common.util.TreeIterator;
 import org.eclipse.emf.ecore.EObject;
 import org.eclipse.emf.ecore.util.EcoreUtil;
 import org.eclipse.osbp.ecview.core.common.editpart.IElementEditpart;
 import org.eclipse.osbp.ecview.core.common.editpart.IEmbeddableEditpart;
 import org.eclipse.osbp.ecview.core.common.editpart.ILayoutEditpart;
 import org.eclipse.osbp.ecview.core.common.model.core.YField;
 import org.eclipse.osbp.ecview.core.common.model.core.YFocusable;
 import org.eclipse.osbp.ecview.core.common.model.core.YView;
 import org.eclipse.osbp.ecview.core.common.services.IWidgetAssocationsService;
 import org.eclipse.osbp.ecview.core.extension.model.extension.YPanel;
 import org.eclipse.osbp.runtime.designer.api.IDesignerService.DesignEvent;
 import org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.common.AbstractLayoutPresenter;
 import org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.internal.util.Util;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

 import com.vaadin.ui.AbstractOrderedLayout;
 import com.vaadin.ui.Component;
 import com.vaadin.ui.Panel;
 import com.vaadin.ui.UI;

 /**
  * This presenter is responsible to render a text field on the given layout.
  */
 public class PanelPresentation extends AbstractLayoutPresenter<Component> {

 	private static final Logger LOGGER = LoggerFactory.getLogger(PanelPresentation.class);

 	private Panel panel;
 	private ModelAccess modelAccess;

 	/**
 	 * The constructor.
 	 *
 	 * @param editpart
 	 *            The editpart of that presentation.
 	 */
 	public PanelPresentation(IElementEditpart editpart) {
 		super((ILayoutEditpart) editpart);
 		this.modelAccess = new ModelAccess((YPanel) editpart.getModel());
 	}

 	@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(), panel);
 	}

 	/**
 	 * Is called to refresh the UI. The element will be removed from the grid
 	 * layout and added to it again afterwards.
 	 */
 	protected void refreshUI() {
 		panel.setContent(null);

 		// iterate all elements and build the child element
 		//
 		for (IEmbeddableEditpart child : getChildren()) {
 			addChild(child);
 		}
 	}

 	@Override
 	public Component doCreateWidget(Object parent) {
 		if (panel == null) {

 			panel = new Panel();

 			setupComponent(panel, getCastedModel());

 			if(parent instanceof AbstractOrderedLayout) {
 				((AbstractOrderedLayout)parent).addLayoutClickListener(e->{
 					YField clickedField = null;
 					Component clickedComponent = e.getClickedComponent();
 					IWidgetAssocationsService<Component, EObject> service = getViewContext().getService(IWidgetAssocationsService.ID);
 					EObject element = service.getModelElement(clickedComponent);
 					if(element instanceof YField) {
 						clickedField = (YField) element;
 						focusFirstField(clickedField);
 					}
 					if(element instanceof YPanel && panel.equals(clickedComponent)) {
 						focusFirstField(null);
 					}
 				});
 			}

 			associateWidget(panel, modelAccess.yLayout);
 			if (modelAccess.isCssIdValid()) {
 				panel.setId(modelAccess.getCssID());
 			} else {
 				panel.setId(getEditpart().getId());
 			}

 			if (modelAccess.isCssClassValid()) {
 				panel.addStyleName(modelAccess.getCssClass());
 			} else {
 				panel.addStyleName(CSS_CLASS_CONTROL);
 			}

 			initialize(panel, getCastedModel());

 			applyCaptions();

 			// creates the binding for the field
 			createBindings(modelAccess.yLayout, panel, null);

 			// initialize all children
 			initializeChildren();

 			renderChildren(false);
 		}

 		return panel;
 	}

 	private void focusFirstField(YField clickedField) {
 		TreeIterator<EObject> iter = EcoreUtil.getAllContents(modelAccess.yLayout, false);
 		while (iter.hasNext()) {
 			EObject element = iter.next();
 			if (element instanceof YFocusable) {
 				UI ui = panel.getUI();
 				// either find first field focusable or the clicked field if not null
 				if(clickedField == null || clickedField.equals(element)) {
 					ui.access(() -> {
 						YView view = (YView) getViewContext().getViewEditpart().getModel();
 						view.setCurrentFocus((YFocusable) element);
 					});
 					break;
 				}
 			}
 		}
 	}

 	/**
 	 * Adds the children to the superclass and prevents rendering.
 	 */
 	private void initializeChildren() {
 		setRenderLock(true);
 		try {
 			for (IEmbeddableEditpart editPart : getEditpart().getElements()) {
 				super.add(editPart);
 			}
 		} finally {
 			setRenderLock(false);
 		}
 	}

 	@Override
 	public Component getWidget() {
 		return panel;
 	}

 	@Override
 	public boolean isRendered() {
 		return panel != null;
 	}

 	@Override
 	public void doUnrender() {
 		if (panel != null) {

 			// unbind all active bindings
 			unbind();

 			// remove assocations
 			unassociateWidget(panel);

 			panel = null;
 		}
 	}

 	@Override
 	protected void internalDispose() {
 		try {
 			for (IEmbeddableEditpart child : new ArrayList<IEmbeddableEditpart>(getChildren())) {
 				child.dispose();
 			}
 			unrender();
 		} finally {
 			super.internalDispose();
 		}
 	}

 	@Override
 	protected void internalAdd(IEmbeddableEditpart editpart) {
 		addChild(editpart);
 	}

 	private void addChild(IEmbeddableEditpart editpart) {
 		int index = getChildren().indexOf(editpart);
 		if (index > 0) {
 			LOGGER.warn("More than one element added to panel.");
 			return;
 		}

 		if (index == 0) {
 			Component child = (Component) editpart.render(panel);
 			child.setSizeFull();
 			panel.setContent(child);
 		}
 	}

 	@Override
 	protected void internalRemove(IEmbeddableEditpart child) {
 		if (panel != null && child.isRendered() && panel.getContent() == child.getWidget()) {
 			panel.setContent(null);
 		}

 		child.unrender();
 	}

 	@Override
 	protected void internalInsert(IEmbeddableEditpart editpart, int index) {
 		refreshUI();
 	}

 	@Override
 	protected void internalMove(IEmbeddableEditpart editpart, int oldIndex, int newIndex) {
 		refreshUI();
 	}

 	@Override
 	public void renderChildren(boolean force) {
 		if (force) {
 			unrenderChildren();
 		}

 		refreshUI();
 	}

 	/**
 	 * Will unrender all children.
 	 */
 	protected void unrenderChildren() {
 		for (IEmbeddableEditpart editpart : getChildren()) {
 			if (editpart.isRendered()) {
 				editpart.unrender();
 			}
 		}
 	}

 	@Override
 	public void notify(DesignEvent event) {
 		// nothing to do
 	}

 	/**
 	 * An internal helper class.
 	 */
 	private static class ModelAccess {
 		private final YPanel yLayout;

 		public ModelAccess(YPanel yLayout) {
 			super();
 			this.yLayout = yLayout;
 		}

 		/**
 		 * @return
 		 * @see org.eclipse.osbp.ecview.core.ui.core.model.core.YCssAble#getCssClass()
 		 */
 		public String getCssClass() {
 			return yLayout.getCssClass();
 		}

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

 		/**
 		 * @return
 		 * @see org.eclipse.osbp.ecview.core.ui.core.model.core.YCssAble#getCssID()
 		 */
 		public String getCssID() {
 			return yLayout.getCssID();
 		}

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

 		/**
 		 * Returns the label.
 		 *
 		 * @return
 		 */
 		public String getLabel() {
 			return yLayout.getDatadescription().getLabel();
 		}

 		/**
 		 * Returns the label.
 		 *
 		 * @return
 		 */
 		public String getLabelI18nKey() {
 			return yLayout.getDatadescription().getLabelI18nKey();
 		}
 	}
 }
	/**
	* 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.util.ArrayList;
	import java.util.Locale;

	import org.eclipse.emf.common.util.TreeIterator;
	import org.eclipse.emf.ecore.EObject;
	import org.eclipse.emf.ecore.util.EcoreUtil;
	import org.eclipse.osbp.ecview.core.common.editpart.IElementEditpart;
	import org.eclipse.osbp.ecview.core.common.editpart.IEmbeddableEditpart;
	import org.eclipse.osbp.ecview.core.common.editpart.ILayoutEditpart;
	import org.eclipse.osbp.ecview.core.common.model.core.YField;
	import org.eclipse.osbp.ecview.core.common.model.core.YFocusable;
	import org.eclipse.osbp.ecview.core.common.model.core.YView;
	import org.eclipse.osbp.ecview.core.common.services.IWidgetAssocationsService;
	import org.eclipse.osbp.ecview.core.extension.model.extension.YPanel;
	import org.eclipse.osbp.runtime.designer.api.IDesignerService.DesignEvent;
	import org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.common.AbstractLayoutPresenter;
	import org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.internal.util.Util;
	import org.slf4j.Logger;
	import org.slf4j.LoggerFactory;

	import com.vaadin.ui.AbstractOrderedLayout;
	import com.vaadin.ui.Component;
	import com.vaadin.ui.Panel;
	import com.vaadin.ui.UI;

	/**
	* This presenter is responsible to render a text field on the given layout.
	*/
	public class PanelPresentation extends AbstractLayoutPresenter<Component> {

	private static final Logger LOGGER = LoggerFactory.getLogger(PanelPresentation.class);

	private Panel panel;
	private ModelAccess modelAccess;

	/**
	* The constructor.
	*
	* @param editpart
	* The editpart of that presentation.
	*/
	public PanelPresentation(IElementEditpart editpart) {
	super((ILayoutEditpart) editpart);
	this.modelAccess = new ModelAccess((YPanel) editpart.getModel());
	}

	@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(), panel);
	}

	/**
	* Is called to refresh the UI. The element will be removed from the grid
	* layout and added to it again afterwards.
	*/
	protected void refreshUI() {
	panel.setContent(null);

	// iterate all elements and build the child element
	//
	for (IEmbeddableEditpart child : getChildren()) {
	addChild(child);
	}
	}

	@Override
	public Component doCreateWidget(Object parent) {
	if (panel == null) {

	panel = new Panel();

	setupComponent(panel, getCastedModel());

	if(parent instanceof AbstractOrderedLayout) {
	((AbstractOrderedLayout)parent).addLayoutClickListener(e->{
	YField clickedField = null;
	Component clickedComponent = e.getClickedComponent();
	IWidgetAssocationsService<Component, EObject> service = getViewContext().getService(IWidgetAssocationsService.ID);
	EObject element = service.getModelElement(clickedComponent);
	if(element instanceof YField) {
	clickedField = (YField) element;
	focusFirstField(clickedField);
	}
	if(element instanceof YPanel && panel.equals(clickedComponent)) {
	focusFirstField(null);
	}
	});
	}

	associateWidget(panel, modelAccess.yLayout);
	if (modelAccess.isCssIdValid()) {
	panel.setId(modelAccess.getCssID());
	} else {
	panel.setId(getEditpart().getId());
	}

	if (modelAccess.isCssClassValid()) {
	panel.addStyleName(modelAccess.getCssClass());
	} else {
	panel.addStyleName(CSS_CLASS_CONTROL);
	}

	initialize(panel, getCastedModel());

	applyCaptions();

	// creates the binding for the field
	createBindings(modelAccess.yLayout, panel, null);

	// initialize all children
	initializeChildren();

	renderChildren(false);
	}

	return panel;
	}

	private void focusFirstField(YField clickedField) {
	TreeIterator<EObject> iter = EcoreUtil.getAllContents(modelAccess.yLayout, false);
	while (iter.hasNext()) {
	EObject element = iter.next();
	if (element instanceof YFocusable) {
	UI ui = panel.getUI();
	// either find first field focusable or the clicked field if not null
	if(clickedField == null \|\| clickedField.equals(element)) {
	ui.access(() -> {
	YView view = (YView) getViewContext().getViewEditpart().getModel();
	view.setCurrentFocus((YFocusable) element);
	});
	break;
	}
	}
	}
	}

	/**
	* Adds the children to the superclass and prevents rendering.
	*/
	private void initializeChildren() {
	setRenderLock(true);
	try {
	for (IEmbeddableEditpart editPart : getEditpart().getElements()) {
	super.add(editPart);
	}
	} finally {
	setRenderLock(false);
	}
	}

	@Override
	public Component getWidget() {
	return panel;
	}

	@Override
	public boolean isRendered() {
	return panel != null;
	}

	@Override
	public void doUnrender() {
	if (panel != null) {

	// unbind all active bindings
	unbind();

	// remove assocations
	unassociateWidget(panel);

	panel = null;
	}
	}

	@Override
	protected void internalDispose() {
	try {
	for (IEmbeddableEditpart child : new ArrayList<IEmbeddableEditpart>(getChildren())) {
	child.dispose();
	}
	unrender();
	} finally {
	super.internalDispose();
	}
	}

	@Override
	protected void internalAdd(IEmbeddableEditpart editpart) {
	addChild(editpart);
	}

	private void addChild(IEmbeddableEditpart editpart) {
	int index = getChildren().indexOf(editpart);
	if (index > 0) {
	LOGGER.warn("More than one element added to panel.");
	return;
	}

	if (index == 0) {
	Component child = (Component) editpart.render(panel);
	child.setSizeFull();
	panel.setContent(child);
	}
	}

	@Override
	protected void internalRemove(IEmbeddableEditpart child) {
	if (panel != null && child.isRendered() && panel.getContent() == child.getWidget()) {
	panel.setContent(null);
	}

	child.unrender();
	}

	@Override
	protected void internalInsert(IEmbeddableEditpart editpart, int index) {
	refreshUI();
	}

	@Override
	protected void internalMove(IEmbeddableEditpart editpart, int oldIndex, int newIndex) {
	refreshUI();
	}

	@Override
	public void renderChildren(boolean force) {
	if (force) {
	unrenderChildren();
	}

	refreshUI();
	}

	/**
	* Will unrender all children.
	*/
	protected void unrenderChildren() {
	for (IEmbeddableEditpart editpart : getChildren()) {
	if (editpart.isRendered()) {
	editpart.unrender();
	}
	}
	}

	@Override
	public void notify(DesignEvent event) {
	// nothing to do
	}

	/**
	* An internal helper class.
	*/
	private static class ModelAccess {
	private final YPanel yLayout;

	public ModelAccess(YPanel yLayout) {
	super();
	this.yLayout = yLayout;
	}

	/**
	* @return
	* @see org.eclipse.osbp.ecview.core.ui.core.model.core.YCssAble#getCssClass()
	*/
	public String getCssClass() {
	return yLayout.getCssClass();
	}

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

	/**
	* @return
	* @see org.eclipse.osbp.ecview.core.ui.core.model.core.YCssAble#getCssID()
	*/
	public String getCssID() {
	return yLayout.getCssID();
	}

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

	/**
	* Returns the label.
	*
	* @return
	*/
	public String getLabel() {
	return yLayout.getDatadescription().getLabel();
	}

	/**
	* Returns the label.
	*
	* @return
	*/
	public String getLabelI18nKey() {
	return yLayout.getDatadescription().getLabelI18nKey();
	}
	}
	}