com.ocs.dynamo.ui.composite.ComponentContext 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;

import com.ocs.dynamo.domain.AbstractEntity;
import com.ocs.dynamo.domain.model.AttributeModel;
import com.ocs.dynamo.domain.model.GroupTogetherMode;
import com.ocs.dynamo.ui.component.CustomFieldContext;
import com.ocs.dynamo.ui.composite.form.ModelBasedEditForm;
import com.ocs.dynamo.ui.composite.layout.HasSelectedItem;
import com.ocs.dynamo.util.SystemPropertyUtils;
import com.vaadin.flow.component.Component;
import com.vaadin.flow.component.HasComponents;
import com.vaadin.flow.data.binder.Validator;
import com.vaadin.flow.data.converter.Converter;
import lombok.Builder;
import lombok.Getter;
import lombok.Setter;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.*;

/**
 * A context for keeping track of component settings that cannot be modified
 * externally
 * 
 * @author BasRutten
 *
 */
@Getter
@Builder(toBuilder = true)
@Setter
public class ComponentContext> {

	private BiConsumer, T> afterEntitySelected;

	private Consumer afterEntitySet;

	/**
	 * Consumer that runs after the edit form has been built in a composite layout
	 * Takes as its arguments the parent component and whether the component is in
	 * view mode
	 */
	private BiConsumer afterEditFormBuilt;

	private BiConsumer, Boolean> afterModeChanged;

	private Consumer afterTabSelected;

	private BiConsumer afterUploadCompleted;

	@Builder.Default
	private Map>> customConverters = new HashMap<>();

	@Builder.Default
	private Map> customFields = new HashMap<>();

	@Builder.Default
	private Map, Validator>> customRequiredValidators = new HashMap<>();

	private BiConsumer, T> customSaveAction;

	private Predicate customSaveExceptionHandler;

	@Builder.Default
	private Map, Validator>> customValidators = new HashMap<>();

	private boolean editable;

	@Builder.Default
	private List editColumnThresholds = new ArrayList<>();

	@Builder.Default
	private Map fieldEntityModels = new HashMap<>();

	@Builder.Default
	private GroupTogetherMode groupTogetherMode = SystemPropertyUtils.getDefaultGroupTogetherMode();

	@Builder.Default
	private Integer groupTogetherWidth = SystemPropertyUtils.getDefaultGroupTogetherWidth();

	@Builder.Default
	private String maxEditFormWidth = SystemPropertyUtils.getDefaultMaxEditFormWidth();

	@Builder.Default
	private String maxSearchFormWidth = SystemPropertyUtils.getDefaultMaxSearchFormWidth();

	private boolean multiSelect;

	private boolean popup;

	private Consumer> postProcessEditFields;

	@Getter
	@Setter
	@Builder.Default
	private List searchColumnThresholds = new ArrayList<>();

	/**
	 * Whether to use check boxes for multiple selection inside popup
	 */
	@Builder.Default
	private boolean useCheckboxesForMultiSelect = SystemPropertyUtils.useGridSelectionCheckBoxes();

	public void addCustomConverter(String path, Supplier> converter) {
		customConverters.put(path, converter);
	}

	public void addCustomField(String path, Function function) {
		customFields.put(path, function);
	}

	public void addCustomRequiredValidator(String path, Function, Validator> validator) {
		customRequiredValidators.put(path, validator);
	}

	public void addCustomValidator(String path, Function, Validator> validator) {
		customValidators.put(path, validator);
	}

	/**
	 * Sets a custom entity model to use for a certain field/property
	 *
	 * @param path      the path of the property
	 * @param reference the unique ID of the entity model
	 */
	public void addFieldEntityModel(String path, String reference) {
		fieldEntityModels.put(path, reference);
	}

	@SuppressWarnings("rawtypes")
	public Converter findCustomConverter(AttributeModel attributeModel) {
		Supplier> supplier = customConverters.get(attributeModel.getPath());
		if (supplier != null) {
			return supplier.get();
		}
		return null;
	}

	public Function, Validator> findCustomRequiredValidator(AttributeModel attributeModel) {
		return findValidator(attributeModel, customRequiredValidators);
	}

	public Function, Validator> findCustomValidator(AttributeModel attributeModel) {
		return findValidator(attributeModel, customValidators);
	}

	private Function, Validator> findValidator(AttributeModel attributeModel,
			Map, Validator>> map) {
		return map.get(attributeModel.getPath());
	}

	public Function getCustomFieldCreator(String path) {
		return customFields.get(path);
	}

	public String getFieldEntityModel(String path) {
		return fieldEntityModels.get(path);
	}

}