com.ocs.dynamo.ui.component.DetailsEditGrid 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.component;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Comparator;
import java.util.List;

import com.ocs.dynamo.domain.AbstractEntity;
import com.ocs.dynamo.domain.model.AttributeModel;
import com.ocs.dynamo.domain.model.EntityModel;
import com.ocs.dynamo.exception.OCSRuntimeException;
import com.ocs.dynamo.ui.composite.layout.FormOptions;
import com.ocs.dynamo.ui.utils.ConvertUtils;
import com.ocs.dynamo.ui.utils.VaadinUtils;
import com.vaadin.flow.component.button.Button;
import com.vaadin.flow.component.grid.contextmenu.GridContextMenu;
import com.vaadin.flow.data.provider.DataProvider;
import com.vaadin.flow.data.provider.ListDataProvider;
import com.vaadin.flow.function.SerializablePredicate;

import lombok.Getter;
import lombok.Setter;

/**
 * A grid component for the in-line editing of a one-to-many relation. It can
 * also be used to manage a many-to-many relation but in this case the
 * "setDetailsGridSearchMode" on the FormOptions must be set to true.
 * 
 * @author bas.rutten
 * @param  the type of the primary key
 * @param   the type of the entity
 */
public class DetailsEditGrid>
		extends BaseDetailsEditGrid, ID, T> {

	private static final long serialVersionUID = -1203245694503350276L;

	@Getter
	@Setter
	private Comparator comparator;

	private final ListDataProvider provider;

	/**
	 * Constructor
	 *
	 * @param entityModel    the entity model of the entities to display
	 * @param attributeModel the attribute model of the attribute to display
	 * @param viewMode       the view mode
	 * @param formOptions    the form options that determine how the grid behaves
	 */
	public DetailsEditGrid(EntityModel entityModel, AttributeModel attributeModel, boolean viewMode,
			FormOptions formOptions) {
		super(null, entityModel, attributeModel, viewMode, false, formOptions);
		this.provider = new ListDataProvider<>(new ArrayList<>());

		// add a row containing a new entity
		setOnAdd(() -> {
			T entity = getCreateEntity().get();
			provider.getItems().add(entity);
			provider.refreshAll();
		});
	}

	/**
	 * Adds a context menu used to download the contents of the grid
	 */
	protected void addDownloadMenu() {
		if (getFormOptions().isExportAllowed() && getExportDelegate() != null) {
			GridContextMenu contextMenu = getGrid().addContextMenu();
			Button downloadButton = new Button(getMessageService().getMessage("ocs.download", VaadinUtils.getLocale()));
			downloadButton.addClickListener(event -> {
				ListDataProvider prov = (ListDataProvider) getDataProvider();
				EntityModel em = getExportEntityModel() != null ? getExportEntityModel() : getEntityModel();
				getExportDelegate().exportFixed(em, getFormOptions().getExportMode(), prov.getItems());
			});
			contextMenu.add(downloadButton);
		}
	}

	@Override
	protected final void applyFilter() {
		// do nothing
	}

	@Override
	protected Collection generateModelValue() {
		return ConvertUtils.convertCollection(provider == null ? new ArrayList<>() : provider.getItems(),
				getAttributeModel());
	}

	@Override
	protected DataProvider> getDataProvider() {
		return provider;
	}

	public int getItemCount() {
		return provider.getItems().size();
	}

	@Override
	public Collection getValue() {
		return ConvertUtils.convertCollection(provider == null ? new ArrayList<>() : provider.getItems(),
				getAttributeModel());
	}

	@Override
	protected void handleDialogSelection(Collection selected) {
		if (getLinkEntity() == null) {
			throw new OCSRuntimeException(
					"linkEntity not set. Please use the setLinkEntity method to specify what to do with the selected items");
		}

		// add to data provider
		for (T entity : selected) {
			if (!provider.getItems().contains(entity)) {
				provider.getItems().add(entity);
			}
		}

		// link to parent entity
		for (T t : selected) {
			getLinkEntity().accept(t);
		}
	}

	@Override
	protected void setPresentationValue(Collection value) {
		List list = new ArrayList<>(value);
		if (comparator != null) {
			list.sort(comparator);
		}

		getBinders().clear();
		if (provider != null) {
			provider.getItems().clear();
			provider.getItems().addAll(list);
			provider.refreshAll();
		}

		updateCaption(value.size());

		// clear the selection
		setSelectedItem(null);
	}

	@Override
	protected boolean showDetailsPanelInEditMode() {
		return false;
	}

}