Java tutorial
/** * Copyright (c) 2011 - 2015, Lunifera GmbH (Gross Enzersdorf), Loetz KG (Heidelberg) * 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: * Florian Pirchner - Initial implementation */ package org.lunifera.runtime.web.ecview.presentation.vaadin.internal; import java.util.HashSet; import java.util.Locale; import java.util.Set; import org.eclipse.core.databinding.observable.IObservable; import org.eclipse.core.databinding.observable.list.IObservableList; import org.eclipse.core.databinding.observable.value.IObservableValue; import org.lunifera.ecview.core.common.editpart.IElementEditpart; import org.lunifera.ecview.core.common.model.core.YEmbeddableBindingEndpoint; import org.lunifera.ecview.core.common.model.core.YEmbeddableCollectionEndpoint; import org.lunifera.ecview.core.common.model.core.YEmbeddableSelectionEndpoint; import org.lunifera.ecview.core.databinding.emf.model.ECViewModelBindable; import org.lunifera.ecview.core.extension.model.extension.ExtensionModelPackage; import org.lunifera.ecview.core.extension.model.extension.YEnumOptionsGroup; import org.lunifera.ecview.core.extension.model.extension.YSelectionType; import org.lunifera.ecview.core.ui.core.editparts.extension.IEnumOptionsGroupEditpart; import org.lunifera.runtime.web.ecview.presentation.vaadin.internal.data.EnumConverter; import org.lunifera.runtime.web.ecview.presentation.vaadin.internal.data.EnumOptionBean; import org.lunifera.runtime.web.ecview.presentation.vaadin.internal.data.EnumOptionBeanHelper; import org.lunifera.runtime.web.ecview.presentation.vaadin.internal.data.EnumSetConverter; import org.lunifera.runtime.web.ecview.presentation.vaadin.internal.util.Util; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import com.vaadin.data.Property; import com.vaadin.data.util.BeanItemContainer; import com.vaadin.data.util.ObjectProperty; import com.vaadin.server.Resource; import com.vaadin.server.ThemeResource; import com.vaadin.ui.AbstractSelect.ItemCaptionMode; import com.vaadin.ui.Component; import com.vaadin.ui.ComponentContainer; import com.vaadin.ui.Field; import com.vaadin.ui.OptionGroup; /** * This presenter is responsible to render a list box on the given layout. */ @SuppressWarnings("restriction") public class EnumOptionsGroupPresentation extends AbstractFieldWidgetPresenter<Component> { private static final Logger LOGGER = LoggerFactory.getLogger(EnumOptionsGroupPresentation.class); private final ModelAccess modelAccess; private OptionGroup optionsGroup; @SuppressWarnings("rawtypes") private ObjectProperty property; /** * Constructor. * * @param editpart * The editpart of that presenter */ public EnumOptionsGroupPresentation(IElementEditpart editpart) { super((IEnumOptionsGroupEditpart) editpart); this.modelAccess = new ModelAccess((YEnumOptionsGroup) editpart.getModel()); } /** * {@inheritDoc} */ @SuppressWarnings({ "unchecked", "rawtypes" }) @Override public Component doCreateWidget(Object parent) { if (optionsGroup == null) { optionsGroup = new CustomOptionsGroup(); optionsGroup.addStyleName(CSS_CLASS_CONTROL); optionsGroup.setImmediate(true); optionsGroup.setMultiSelect(modelAccess.yField.getSelectionType() == YSelectionType.MULTI); setupComponent(optionsGroup, getCastedModel()); associateWidget(optionsGroup, modelAccess.yField); if (modelAccess.isCssIdValid()) { optionsGroup.setId(modelAccess.getCssID()); } else { optionsGroup.setId(getEditpart().getId()); } try { if (optionsGroup.isMultiSelect()) { property = new ObjectProperty(new HashSet(), Set.class); } else { if (modelAccess.yField.getType() != null) { property = new ObjectProperty(null, modelAccess.yField.getType()); } else { property = new ObjectProperty(null, Object.class); } } optionsGroup.setPropertyDataSource(property); if (modelAccess.yField.getType() != null) { BeanItemContainer<EnumOptionBean> datasource = createDatasource( (Class<? extends Enum<?>>) modelAccess.yField.getType()); optionsGroup.setContainerDataSource(datasource); } if (optionsGroup.isMultiSelect()) { optionsGroup.setConverter( new EnumSetConverter((Class<Enum<?>>) modelAccess.yField.getType(), optionsGroup)); } else { optionsGroup.setConverter( new EnumConverter((Class<Enum<?>>) modelAccess.yField.getType(), optionsGroup)); } optionsGroup.setItemCaptionPropertyId("description"); optionsGroup.setItemCaptionMode(ItemCaptionMode.PROPERTY); optionsGroup.setItemIconPropertyId("imagePath"); // creates the binding for the field createBindings(modelAccess.yField, optionsGroup); if (modelAccess.isCssClassValid()) { optionsGroup.addStyleName(modelAccess.getCssClass()); } applyCaptions(); initializeField(optionsGroup); } catch (Exception e) { LOGGER.error("{}", e); } } return optionsGroup; } /** * Creates the datasource used for the enum field. * * @return */ protected BeanItemContainer<EnumOptionBean> createDatasource(Class<? extends Enum<?>> enumClass) { BeanItemContainer<EnumOptionBean> datasource = new BeanItemContainer<EnumOptionBean>(EnumOptionBean.class); datasource.addAll(EnumOptionBeanHelper.getBeans(enumClass, getI18nService(), getLocale())); return datasource; } @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(), optionsGroup); } @Override protected Field<?> doGetField() { return optionsGroup; } @Override protected IObservable internalGetObservableEndpoint(YEmbeddableBindingEndpoint bindableValue) { if (bindableValue == null) { throw new IllegalArgumentException("BindableValue must not be null!"); } if (bindableValue instanceof YEmbeddableCollectionEndpoint) { return internalGetCollectionEndpoint(); } else if (bindableValue instanceof YEmbeddableSelectionEndpoint) { return internalGetSelectionEndpoint((YEmbeddableSelectionEndpoint) bindableValue); } throw new IllegalArgumentException("Not a valid input: " + bindableValue); } /** * Returns the observable to observe the collection. * * @return */ protected IObservableList internalGetCollectionEndpoint() { throw new UnsupportedOperationException(); } /** * Returns the observable to observe the selection. * * @return */ protected IObservableValue internalGetSelectionEndpoint(YEmbeddableSelectionEndpoint yEndpoint) { String attributePath = ECViewModelBindable.getAttributePath( ExtensionModelPackage.Literals.YENUM_OPTIONS_GROUP__SELECTION, yEndpoint.getAttributePath()); // return the observable value for text return ECViewModelBindable.observeValue(castEObject(getModel()), attributePath, modelAccess.yField.getType(), modelAccess.yField.getEmfNsURI()); } /** * Creates the bindings for the given values. * * @param yField * @param field */ protected void createBindings(YEnumOptionsGroup yField, OptionGroup field) { if (modelAccess.yField.getSelectionType() == YSelectionType.MULTI) { // create the model binding from ridget to ECView-model registerBinding(createBindingsMultiSelection(castEObject(getModel()), ExtensionModelPackage.Literals.YENUM_OPTIONS_GROUP__MULTI_SELECTION, field, yField.getType())); } else { // create the model binding from ridget to ECView-model registerBinding(createBindingsSelection(castEObject(getModel()), ExtensionModelPackage.Literals.YENUM_OPTIONS_GROUP__SELECTION, field, yField.getType())); } super.createBindings(yField, field, null); } @Override public Component getWidget() { return optionsGroup; } @Override public boolean isRendered() { return optionsGroup != null; } /** * {@inheritDoc} */ @Override public void doUnrender() { if (optionsGroup != null) { // unbind all active bindings unbind(); ComponentContainer parent = ((ComponentContainer) optionsGroup.getParent()); if (parent != null) { parent.removeComponent(optionsGroup); } // remove assocations unassociateWidget(optionsGroup); optionsGroup = null; } } /** * {@inheritDoc} */ @Override protected void internalDispose() { try { unrender(); } finally { super.internalDispose(); } } /** * A helper class. */ private static class ModelAccess { private final YEnumOptionsGroup yField; public ModelAccess(YEnumOptionsGroup yField) { super(); this.yField = yField; } /** * @return * @see org.lunifera.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 */ public boolean isCssClassValid() { return getCssClass() != null && !getCssClass().equals(""); } /** * @return * @see org.lunifera.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 */ public boolean isCssIdValid() { return getCssID() != null && !getCssID().equals(""); } /** * Returns the label. * * @return */ public String getLabel() { return yField.getDatadescription() != null ? yField.getDatadescription().getLabel() : null; } /** * Returns the label. * * @return */ public String getLabelI18nKey() { return yField.getDatadescription() != null ? yField.getDatadescription().getLabelI18nKey() : null; } } /** * Converts the string value of the item icon property to * {@link ThemeResource}. */ @SuppressWarnings("serial") private static class CustomOptionsGroup extends OptionGroup { private Object itemIconPropertyId; public CustomOptionsGroup() { } // @Override // public Class<?> getType() { // return EnumOptionBean.class; // } @Override public void setItemIconPropertyId(Object propertyId) throws IllegalArgumentException { if (propertyId == null) { super.setItemIconPropertyId(propertyId); } else if (!getContainerPropertyIds().contains(propertyId)) { super.setItemIconPropertyId(propertyId); } else if (String.class.isAssignableFrom(getType(propertyId))) { itemIconPropertyId = propertyId; } else { super.setItemIconPropertyId(propertyId); } } public Object getItemIconPropertyId() { return itemIconPropertyId != null ? itemIconPropertyId : super.getItemIconPropertyId(); } public Resource getItemIcon(Object itemId) { if (itemIconPropertyId == null) { return super.getItemIcon(itemId); } else { final Property<?> ip = getContainerProperty(itemId, getItemIconPropertyId()); if (ip == null) { return null; } final Object icon = ip.getValue(); try { if (icon instanceof String) { return new ThemeResource((String) icon); } } catch (Exception e) { } } return null; } } }