com.ocs.dynamo.ui.composite.grid.ModelBasedGrid Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dynamo-frontend Show documentation
The newest version!
/*
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
 */
package com.ocs.dynamo.ui.composite.grid;

import java.io.Serializable;
import java.util.List;
import java.util.Map;
import java.util.stream.Stream;

import com.ocs.dynamo.domain.AbstractEntity;
import com.ocs.dynamo.domain.model.AttributeModel;
import com.ocs.dynamo.domain.model.EntityModel;
import com.ocs.dynamo.service.MessageService;
import com.ocs.dynamo.service.ServiceLocatorFactory;
import com.ocs.dynamo.ui.Buildable;
import com.ocs.dynamo.ui.UIHelper;
import com.ocs.dynamo.ui.composite.ComponentContext;
import com.ocs.dynamo.ui.composite.layout.FormOptions;
import com.vaadin.flow.component.AttachEvent;
import com.vaadin.flow.component.Component;
import com.vaadin.flow.component.grid.Grid;
import com.vaadin.flow.component.grid.GridVariant;
import com.vaadin.flow.data.binder.BeanValidationBinder;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.data.binder.Binder.BindingBuilder;
import com.vaadin.flow.data.provider.DataProvider;
import com.vaadin.flow.data.provider.SortOrder;
import com.vaadin.flow.function.SerializablePredicate;

import lombok.Getter;

/**
 * A Grid that bases its columns on the meta model of an entity
 * 
 * @author bas.rutten
 * @param  type of the primary key
 * @param   type of the entity
 */
public class ModelBasedGrid> extends Grid
		implements Buildable {

	private static final long serialVersionUID = 6946260934644731038L;

	/**
	 * The entity model of the entities to display in the grid
	 */
	@Getter
	private EntityModel entityModel;

	@Getter
	private MessageService messageService;

	private Map> fieldFilters;

	private boolean built;

	private ComponentContext componentContext;

	private FormOptions formOptions;

	/**
	 * 
	 * @param dataProvider
	 * @param model
	 * @param fieldFilters
	 * @param formOptions
	 * @param componentContext
	 */
	public ModelBasedGrid(DataProvider> dataProvider, EntityModel model,
			Map> fieldFilters, FormOptions formOptions,
			ComponentContext componentContext) {
		setDataProvider(dataProvider);
		// https://vaadin.com/api/platform/23.0.10/deprecated-list.html
		//setItems((Stream) dataProvider);
		this.componentContext = componentContext;
		this.entityModel = model;
		this.messageService = ServiceLocatorFactory.getServiceLocator().getMessageService();
		this.fieldFilters = fieldFilters;
		this.formOptions = formOptions;
		addThemeVariants(GridVariant.LUMO_COMPACT, GridVariant.LUMO_ROW_STRIPES);

		setSizeFull();
		setColumnReorderingAllowed(true);
		setSelectionMode(SelectionMode.SINGLE);

		// in Vaadin 14, we explicitly need to set the binder
		Binder binder = new BeanValidationBinder<>(entityModel.getEntityClass());
		getEditor().setBinder(binder);
		getEditor().setBuffered(false);

		build();

	}

	@Override
	protected void onAttach(AttachEvent attachEvent) {
		super.onAttach(attachEvent);
		build();
	}

	@Override
	public void build() {
		if (!built) {

			ModelBasedGridBuilder gridBuilder = new ModelBasedGridBuilder(this, entityModel, fieldFilters,
					formOptions, componentContext) {

				@Override
				protected void postProcessComponent(ID id, AttributeModel am, Component comp) {
					ModelBasedGrid.this.postProcessComponent(id, am, comp);
				}

				@Override
				protected Component constructCustomField(EntityModel entityModel, AttributeModel attributeModel) {
					return ModelBasedGrid.this.constructCustomField(entityModel, attributeModel);
				}

				@Override
				protected BindingBuilder doBind(T t, Component field, String attributeName) {
					return ModelBasedGrid.this.doBind(t, field, attributeName);
				}

			};

			gridBuilder.addColumns(entityModel.getAttributeModelsSortedForGrid());

			addSortListener(event -> {
				UIHelper helper = ServiceLocatorFactory.getServiceLocator().getService(UIHelper.class);
				if (helper != null && formOptions.isPreserveSortOrders()) {
					List> collect = SortOrderUtil.restoreSortOrder(event.getSortOrder());
					helper.storeSortOrders(collect);
				}
			});
		}
		built = true;
	}

	/**
	 * Callback method for constructing a custom field
	 * 
	 * @param entityModel    the entity model of the main entity
	 * @param attributeModel the attribute model to base the field on
	 * @return
	 */
	protected Component constructCustomField(EntityModel entityModel, AttributeModel attributeModel) {
		return null;
	}

	/**
	 * Callback method for components that incorporate this grid component but do
	 * the binding themselves
	 * 
	 * @param t     the entity
	 * @param field the field to bind
	 * @return
	 */
	protected BindingBuilder doBind(T t, Component field, String attributeName) {
		return null;
	}

	/**
	 * Post process the component. Callback method that can be used from a component
	 * that includes the grid
	 * 
	 * @param am
	 * @param comp
	 */
	protected void postProcessComponent(ID id, AttributeModel am, Component comp) {
		// override in subclass
	}

	/**
	 * Sets the visibility of a column. This can only be used to show/hide columns
	 * that would show up in the grid based on the entity model
	 *
	 * @param propertyId the ID of the column.
	 * @param visible    whether the column must be visible
	 */
	public void setColumnVisible(String propertyId, boolean visible) {
		getColumnByKey(propertyId).setVisible(visible);
	}

}