blob: ac7eca4a25c189e92dc9dc0cc54917f2c3753a51 [file] [log] [blame]
/**
* 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 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.eclipse.osbp.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.eclipse.emf.databinding.EMFProperties;
import org.eclipse.osbp.ecview.core.common.editpart.IElementEditpart;
import org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableBindingEndpoint;
import org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableCollectionEndpoint;
import org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableMultiSelectionEndpoint;
import org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableSelectionEndpoint;
import org.eclipse.osbp.ecview.core.databinding.emf.model.ECViewModelBindable;
import org.eclipse.osbp.ecview.core.extension.model.extension.ExtensionModelPackage;
import org.eclipse.osbp.ecview.core.extension.model.extension.YList;
import org.eclipse.osbp.ecview.core.extension.model.extension.YSelectionType;
import org.eclipse.osbp.ecview.core.ui.core.editparts.extension.IListEditpart;
import org.eclipse.osbp.runtime.common.state.ISharedStateContext;
import org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.common.AbstractFieldWidgetPresenter;
import org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.internal.util.Util;
import org.eclipse.osbp.runtime.web.vaadin.common.data.BeanServiceLazyLoadingContainer;
import org.eclipse.osbp.runtime.web.vaadin.common.data.DeepResolvingBeanItemContainer;
import org.eclipse.osbp.runtime.web.vaadin.common.data.IBeanSearchServiceFactory;
import com.vaadin.data.Property;
import com.vaadin.data.util.IndexedContainer;
import com.vaadin.data.util.ObjectProperty;
import com.vaadin.server.ErrorMessage;
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.ListSelect;
// TODO: Auto-generated Javadoc
/**
* This presenter is responsible to render a list on the given layout.
*/
@SuppressWarnings("restriction")
public class ListPresentation extends AbstractFieldWidgetPresenter<Component> {
/** The model access. */
private final ModelAccess modelAccess;
/** The list. */
private ListSelect list;
/** The property. */
private ObjectProperty<?> property;
/**
* Constructor.
*
* @param editpart
* The editpart of that presenter
*/
public ListPresentation(IElementEditpart editpart) {
super((IListEditpart) editpart);
this.modelAccess = new ModelAccess((YList) editpart.getModel());
}
/**
* {@inheritDoc}
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
@Override
public Component doCreateWidget(Object parent) {
if (list == null) {
list = new CustomListSelect();
list.addStyleName(CSS_CLASS_CONTROL);
list.setMultiSelect(modelAccess.yField.getSelectionType() == YSelectionType.MULTI);
list.setImmediate(true);
setupComponent(list, getCastedModel());
associateWidget(list, modelAccess.yField);
if (modelAccess.isCssIdValid()) {
list.setId(modelAccess.getCssID());
} else {
list.setId(getEditpart().getId());
}
if (list.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);
}
}
list.setPropertyDataSource(property);
if (modelAccess.yField.getType() == String.class) {
IndexedContainer datasource = new IndexedContainer();
list.setContainerDataSource(datasource);
list.setItemCaptionMode(ItemCaptionMode.ID);
} else {
if (modelAccess.yField.getType() != null) {
if (!modelAccess.yField.isUseBeanService()) {
DeepResolvingBeanItemContainer datasource = new DeepResolvingBeanItemContainer(
modelAccess.yField.getType());
list.setContainerDataSource(datasource);
} else {
IBeanSearchServiceFactory factory = getViewContext()
.getService(
IBeanSearchServiceFactory.class
.getName());
if (factory != null) {
ISharedStateContext sharedState = getViewContext()
.getService(
ISharedStateContext.class.getName());
BeanServiceLazyLoadingContainer<?> datasource = new BeanServiceLazyLoadingContainer(
factory.createService(modelAccess.yField
.getType()),
modelAccess.yField.getType(), sharedState);
list.setContainerDataSource(datasource);
}
}
} else {
IndexedContainer container = new IndexedContainer();
container.addContainerProperty("for", String.class, null);
container.addContainerProperty("preview", String.class,
null);
container.addItem(new String[] { "Some value", "other" });
list.setContainerDataSource(container);
}
}
String itemCaptionProperty = modelAccess.yField
.getCaptionProperty();
if (itemCaptionProperty != null && !itemCaptionProperty.equals("")) {
list.setItemCaptionPropertyId(itemCaptionProperty);
}
String itemImageProperty = modelAccess.yField.getImageProperty();
if (itemImageProperty != null && !itemImageProperty.equals("")) {
list.setItemIconPropertyId(itemImageProperty);
}
// creates the binding for the field
createBindings(modelAccess.yField, list);
if (modelAccess.isCssClassValid()) {
list.addStyleName(modelAccess.getCssClass());
}
applyCaptions();
initializeField(list);
}
return list;
}
/* (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(), list);
}
/* (non-Javadoc)
* @see org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.common.AbstractFieldWidgetPresenter#doGetField()
*/
@Override
protected Field<?> doGetField() {
return list;
}
/* (non-Javadoc)
* @see org.eclipse.osbp.runtime.web.ecview.presentation.vaadin.common.AbstractVaadinWidgetPresenter#internalGetObservableEndpoint(org.eclipse.osbp.ecview.core.common.model.core.YEmbeddableBindingEndpoint)
*/
@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);
} else if (bindableValue instanceof YEmbeddableMultiSelectionEndpoint) {
return internalGetMultiSelectionEndpoint();
}
throw new IllegalArgumentException("Not a valid input: "
+ bindableValue);
}
/**
* Returns the observable to observe the collection.
*
* @return the i observable list
*/
protected IObservableList internalGetCollectionEndpoint() {
// return the observable value for text
return EMFProperties.list(
ExtensionModelPackage.Literals.YLIST__COLLECTION).observe(
getModel());
}
/**
* Returns the observable to observe the selection.
*
* @param yEndpoint
* the y endpoint
* @return the i observable value
*/
protected IObservableValue internalGetSelectionEndpoint(
YEmbeddableSelectionEndpoint yEndpoint) {
String attributePath = ECViewModelBindable.getAttributePath(
ExtensionModelPackage.Literals.YLIST__SELECTION,
yEndpoint.getAttributePath());
// return the observable value for text
return ECViewModelBindable.observeValue(castEObject(getModel()),
attributePath, modelAccess.yField.getType(),
modelAccess.yField.getEmfNsURI());
}
/**
* Returns the observable to observe the selection.
*
* @return the i observable list
*/
protected IObservableList internalGetMultiSelectionEndpoint() {
// return the observable value for text
return EMFProperties.list(
ExtensionModelPackage.Literals.YLIST__MULTI_SELECTION).observe(
getModel());
}
/**
* Creates the bindings for the given values.
*
* @param yField
* the y field
* @param field
* the field
*/
protected void createBindings(YList yField, ListSelect field) {
// create the model binding from ridget to ECView-model
registerBinding(createBindings_ContainerContents(
castEObject(getModel()),
ExtensionModelPackage.Literals.YLIST__COLLECTION, field,
yField.getType()));
if (modelAccess.yField.getSelectionType() == YSelectionType.MULTI) {
// create the model binding from ridget to ECView-model
registerBinding(createBindingsMultiSelection(
castEObject(getModel()),
ExtensionModelPackage.Literals.YLIST__MULTI_SELECTION,
field, yField.getType()));
} else {
// create the model binding from ridget to ECView-model
registerBinding(createBindingsSelection(castEObject(getModel()),
ExtensionModelPackage.Literals.YLIST__SELECTION, field,
yField.getType()));
}
super.createBindings(yField, field, null);
}
/* (non-Javadoc)
* @see org.eclipse.osbp.ecview.core.common.presentation.IWidgetPresentation#getWidget()
*/
@Override
public Component getWidget() {
return list;
}
/* (non-Javadoc)
* @see org.eclipse.osbp.ecview.core.common.presentation.IWidgetPresentation#isRendered()
*/
@Override
public boolean isRendered() {
return list != null;
}
/**
* {@inheritDoc}
*/
@Override
public void doUnrender() {
if (list != null) {
// unbind all active bindings
unbind();
Component parent = ((Component) list.getParent());
if (parent != null && parent instanceof ComponentContainer) {
((ComponentContainer) parent).removeComponent(list);
}
// remove assocations
unassociateWidget(list);
list = null;
}
}
/**
* {@inheritDoc}
*/
@Override
protected void internalDispose() {
try {
unrender();
} finally {
super.internalDispose();
}
}
/**
* A helper class.
*/
private static class ModelAccess {
/** The y field. */
private final YList yField;
/**
* Instantiates a new model access.
*
* @param yField
* the y field
*/
public ModelAccess(YList 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;
}
}
/**
* Converts the string value of the item icon property to
* {@link ThemeResource}.
*/
@SuppressWarnings("serial")
private class CustomListSelect extends ListSelect {
/** The item icon property id. */
private Object itemIconPropertyId;
/* (non-Javadoc)
* @see com.vaadin.ui.AbstractSelect#setItemIconPropertyId(java.lang.Object)
*/
@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);
}
}
/* (non-Javadoc)
* @see com.vaadin.ui.AbstractSelect#getItemIconPropertyId()
*/
public Object getItemIconPropertyId() {
return itemIconPropertyId != null ? itemIconPropertyId : super
.getItemIconPropertyId();
}
/* (non-Javadoc)
* @see com.vaadin.ui.AbstractSelect#getItemIcon(java.lang.Object)
*/
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) {
// nothing to do
}
}
return null;
}
/* (non-Javadoc)
* @see com.vaadin.ui.AbstractField#getErrorMessage()
*/
@Override
public ErrorMessage getErrorMessage() {
if(isDisposed()) {
// after disposal, Vaadin will call this method once.
return null;
}
ErrorMessage message = super.getErrorMessage();
reportValidationError(message);
return message;
}
}
}