io.imunity.vaadin.endpoint.common.mvel.MVELExpressionField Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of unity-server-vaadin-endpoint-common Show documentation
Common Vaadin endpoint components
The newest version!
/*
 * Copyright (c) 2021 Bixbit - Krzysztof Benedyczak. All rights reserved.
 * See LICENCE.txt file for licensing information.
 */
package io.imunity.vaadin.endpoint.common.mvel;

import com.vaadin.flow.component.Component;
import com.vaadin.flow.component.Unit;
import com.vaadin.flow.component.customfield.CustomField;
import com.vaadin.flow.component.dnd.DropEffect;
import com.vaadin.flow.component.dnd.DropTarget;
import com.vaadin.flow.component.icon.Icon;
import com.vaadin.flow.component.icon.VaadinIcon;
import com.vaadin.flow.component.orderedlayout.HorizontalLayout;
import com.vaadin.flow.component.textfield.TextField;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.data.binder.Setter;
import com.vaadin.flow.function.ValueProvider;

import io.imunity.vaadin.elements.CssClassNames;
import io.imunity.vaadin.elements.FormItemRequiredIndicatorHandler;
import io.imunity.vaadin.endpoint.common.WebSession;
import io.imunity.vaadin.endpoint.common.api.HtmlTooltipFactory;
import pl.edu.icm.unity.base.message.MessageSource;
import pl.edu.icm.unity.engine.api.mvel.MVELExpressionContext;

import java.util.Optional;

import static io.imunity.vaadin.elements.CSSVars.BASE_MARGIN;
import static io.imunity.vaadin.elements.CSSVars.TEXT_FIELD_BIG;
import static io.imunity.vaadin.elements.CssClassNames.FIELD_ICON_GAP;
import static io.imunity.vaadin.elements.CssClassNames.POINTER;

/**
 * Plain text field allowing for editing an MVEL expression
 */
public class MVELExpressionField extends CustomField
{
	private final MVELExpressionEditor editor;
	private final TextField field;
	private final Icon editorButton;
	private String value;
	private boolean mandatory;
	private MVELExpressionContext context;

	public MVELExpressionField(MessageSource msg, String description, MVELExpressionContext context, HtmlTooltipFactory htmlTooltipFactory)
	{
		this.field = new TextField();
		field.setWidth(TEXT_FIELD_BIG.value());
		
		this.editorButton = VaadinIcon.COGS.create();
		this.context = context;

		editorButton.addClickListener(e ->
		{
			if (!field.isReadOnly())
				new MVELExpressionEditorDialog(msg, this.context, mandatory, field.getValue(), field::setValue).open();
		});
		editorButton.setClassName(POINTER.getName());
		this.editor = new MVELExpressionEditor(this, msg);

		HorizontalLayout layout = new HorizontalLayout();
		layout.setWidthFull();
		layout.setSpacing(false);
		
		Component tooltip =  description == null ? null : htmlTooltipFactory.get(description);
		HorizontalLayout iconsLayout = new HorizontalLayout(editorButton);
		if (tooltip != null)
		{
			iconsLayout.add(tooltip);
		}
		iconsLayout.setSpacing(false);
		iconsLayout.getStyle().set("margin-top", BASE_MARGIN.value());
		iconsLayout.setClassName(FIELD_ICON_GAP.getName());
		layout.add(field, iconsLayout);

		field.addValueChangeListener(e ->
		{
			value = e.getValue();
			fireEvent(new ComponentValueChangeEvent<>(this, e.getSource(), getValue(), e.isFromClient()));
		});
		add(layout);
		addDropHandler();
	}

	public MVELExpressionField(MessageSource msg, String caption, String description, MVELExpressionContext context, HtmlTooltipFactory htmlTooltipFactory)
	{
		this(msg, description, context, htmlTooltipFactory);
		setLabel(caption);
	}
	
	private void addDropHandler()
	{
		DropTarget dropTarget = DropTarget.create(this);
		dropTarget.setDropEffect(DropEffect.MOVE);

		dropTarget.addDropListener(event ->
		{
			Optional dragData = event.getDragData();
			if (dragData.isPresent())
			{
				Object next = dragData.get();
				if (next instanceof DragDropBean dragDropBean)
					field.setValue((field.getValue() != null ? field.getValue() : "") + dragDropBean.getExpression());
			}
		});		
		
		WebSession.getCurrent()
				.getEventBus()
				.addListener(e -> add(), DragStartEvent.class);
		WebSession.getCurrent()
				.getEventBus()
				.addListener(e -> field.removeClassName(CssClassNames.DROP_FIELD.getName()), DragEndEvent.class);

	}
	
	private void add()
	{
		field.addClassName(CssClassNames.DROP_FIELD.getName());
	}
	
	public void addClassNameToField(String className)
	{
		field.addClassName(className);
	}
	
	public void removeClassNameFromField(String name)
	{
		field.removeClassName(name);
	}

	public void configureBinding(Binder binder, String fieldName, boolean mandatory)
	{
		this.mandatory = mandatory;
		editor.configureBinding(binder, fieldName, mandatory);
	}

	public void configureBinding(Binder binder, ValueProvider getter,
								 Setter setter, boolean mandatory)
	{
		this.mandatory = mandatory;
		editor.configureBinding(binder, getter, setter, mandatory);
	}

	@Override
	public String getValue()
	{
		return field.getValue();
	}

	@Override
	public String getEmptyValue()
	{
		return "";
	}

	@Override
	public void focus()
	{
		field.focus();
	}

	@Override
	public void setErrorMessage(String errorMessage)
	{
		field.setInvalid(errorMessage != null);
		field.setErrorMessage(errorMessage);
	}
	
	@Override
	public void setReadOnly(boolean readOnly)
	{
		field.setReadOnly(readOnly);
		editorButton.getStyle().set("opacity", readOnly ? "0.5" : "1");
	}

	public void setContext(MVELExpressionContext context)
	{
		this.context = context;
	}
	
	public MVELExpressionContext getContext()
	{
		return context;
	}
	
	public void setWidth(float width, Unit unit)
	{
		if (field != null)
		{
			field.setWidth(width, unit);
		}	
	}
	
	public void setWidth(String width)
	{
		if (field != null)
		{
			field.setWidth(width);
		}	
	}
	
	@Override
	protected String generateModelValue()
	{
		return value;
	}

	@Override
	protected void setPresentationValue(String s)
	{
		field.setValue(s);
	}

	@Override
	public void setInvalid(boolean invalid)
	{
		super.setInvalid(invalid);
		field.setInvalid(invalid);
		FormItemRequiredIndicatorHandler.setInvalid(this, invalid);
	}

	
}