com.ocs.dynamo.ui.composite.grid.FixedGridWrapper 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.Collection;
import java.util.List;
import java.util.Map;

import com.ocs.dynamo.domain.AbstractEntity;
import com.ocs.dynamo.domain.model.EntityModel;
import com.ocs.dynamo.service.BaseService;
import com.ocs.dynamo.ui.composite.ComponentContext;
import com.ocs.dynamo.ui.composite.layout.FormOptions;
import com.ocs.dynamo.ui.provider.QueryType;
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.data.provider.SortOrder;
import com.vaadin.flow.function.SerializablePredicate;

/**
 * A wrapper for a grid that displays a fixed number of in-memory entities
 * 
 * @author bas.rutten
 * @param  type of the primary key
 * @param   type of the entity
 */
public class FixedGridWrapper> extends BaseGridWrapper {

	private static final long serialVersionUID = -6711832174203817230L;

	/**
	 * The items to display in the grid
	 */
	private Collection items;

	/**
	 * Constructor
	 * 
	 * @param service      the service used for retrieving data from the database
	 * @param entityModel  the entity model
	 * @param formOptions  the form options
	 * @param fieldFilters the field
	 * @param items        the entities to display
	 * @param sortOrders   the sort orders
	 */
	public FixedGridWrapper(BaseService service, EntityModel entityModel, FormOptions formOptions,
			ComponentContext context, Map> fieldFilters, Collection items,
			List> sortOrders) {
		super(service, entityModel, QueryType.NONE, formOptions, context.toBuilder().editable(false).build(), null,
				fieldFilters, sortOrders);
		this.items = items;
	}

	@Override
	protected DataProvider> constructDataProvider() {
		return new ListDataProvider<>(items);
	}

	@Override
	public void forceSearch() {
		// not needed
	}

	@Override
	protected List> initSortingAndFiltering() {
		List> fallBacks = super.initSortingAndFiltering();
		getGrid().addSelectionListener(event -> onSelect(getGrid().getSelectedItems()));

		// right click to download
		if (getFormOptions().isExportAllowed() && getExportDelegate() != null) {
			GridContextMenu contextMenu = getGrid().addContextMenu();
			Button downloadButton = new Button(message("ocs.download"));
			downloadButton.addClickListener(event -> {
				ListDataProvider provider = (ListDataProvider) getDataProvider();
				getExportDelegate().exportFixed(
						getExportEntityModel() != null ? getExportEntityModel() : getEntityModel(),
						getFormOptions().getExportMode(), provider.getItems());
			});
			contextMenu.add(downloadButton);
		}
		return fallBacks;
	}

	@Override
	public void reloadDataProvider() {
		// do nothing
	}

	@Override
	public void search(SerializablePredicate filter) {
		// do nothing (collection of items is fixed)
	}

	@Override
	public int getDataProviderSize() {
		ListDataProvider lp = (ListDataProvider) getDataProvider();
		return lp.getItems().size();
	}

}