• Home
• nz.co.senanque
• madura-vaadin
• 3.4.0
• source code
• MaduraFieldGroupImpl.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

nz.co.senanque.vaadin.MaduraFieldGroupImpl Maven / Gradle / Ivy

package nz.co.senanque.vaadin;

import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import nz.co.senanque.vaadin.application.MaduraNumericConverter;
import nz.co.senanque.validationengine.SetterListener;
import nz.co.senanque.validationengine.ValidationObject;
import nz.co.senanque.validationengine.ValidationSession;

import org.springframework.context.MessageSource;
import org.springframework.context.support.MessageSourceAccessor;

import com.vaadin.data.Item;
import com.vaadin.data.fieldgroup.FieldGroup;
import com.vaadin.data.fieldgroup.PropertyId;
import com.vaadin.data.util.BeanItem;
import com.vaadin.data.util.converter.Converter;
import com.vaadin.ui.AbstractComponent;
import com.vaadin.ui.AbstractComponentContainer;
import com.vaadin.ui.AbstractField;
import com.vaadin.ui.Button;
import com.vaadin.ui.Button.ClickListener;
import com.vaadin.ui.Field;
import com.vaadin.ui.Label;
import com.vaadin.ui.MenuBar.Command;
import com.vaadin.ui.MenuBar.MenuItem;
import com.vaadin.util.ReflectTools;

/**
 * Use this instead of the Vaadin {link com.vaadin.data.fieldgroup.FieldGroup} to manage integration with a Madura session.
 * 
 * @author Roger Parkinson
 *
 */
public class MaduraFieldGroupImpl extends FieldGroup implements PropertiesSource, MaduraFieldGroup {
	
	private final MaduraSessionManager m_maduraSessionManager;
	private final FieldFactory m_fieldFactory;
	private Hints m_hints;
	private MessageSource m_messageSource;
	private List m_myButtons = new ArrayList();
	private List m_properties = new ArrayList<>();
	private Map m_labels = new HashMap<>();
	private List m_menuItems = new ArrayList<>();
	private String m_id;

    /**
     * Constructor insists on a {link nz.co.senanque.vaadin.application.MaduraSessionManager}.
     * It does not need a current session or a current object to instantiate this. Use the method
     * on MaduraSessionManager to create this.
     * 
     * @param maduraSessionManager
     */
    protected MaduraFieldGroupImpl(MaduraSessionManager maduraSessionManager) {
    	this(maduraSessionManager,null);
	}

    protected MaduraFieldGroupImpl(MaduraSessionManager maduraSessionManager, String id) {
		m_maduraSessionManager = maduraSessionManager;
		m_fieldFactory = maduraSessionManager.getFieldFactory();
		m_messageSource = maduraSessionManager.getMessageSource();
		m_hints = maduraSessionManager.getHints();
		m_id = id;
	}

	/**
	 * Tells the Madura session manager to connect this {link com.vaadin.ui.Label) to the given propertyId.
	 * This can be done before there is a data source.
	 * @param field
	 * @param propertyId
	 */
	public void bind(Label label, Object propertyId) {
		m_maduraSessionManager.register(label);
		m_labels.put(label,propertyId.toString());
		if (getItemDataSource() == null) {
			return;
		}
		configureLabel(label);
	}
	/* (non-Javadoc)
	 * @see nz.co.senanque.vaadin.MaduraFieldGroup#setItemDataSource(com.vaadin.data.Item)
	 */
	@Override
	@SuppressWarnings("unchecked")
	public void setItemDataSource(Item itemDataSource) {
    	if (!(itemDataSource instanceof BeanItem && ((BeanItem) itemDataSource).getBean() instanceof ValidationObject)) {
    		throw new RuntimeException("Use BeanItem only");
    	}
    	// make sure the data source is bound to Madura
		m_maduraSessionManager.getValidationSession().bind(((BeanItem)itemDataSource).getBean());
		// the super call will only bind fields
    	m_properties.clear();
    	super.setItemDataSource(itemDataSource);
    	// this will configure labels, menuitems, and buttons
    	configure((BeanItem) itemDataSource);
    	m_maduraSessionManager.updateOtherFields(null);
	}
	
   
    /**
     * Establish the Madura binding for the fields.
     * 
     * @param dataSource
     */
    private void configure(BeanItem dataSource) {
    	if (m_maduraSessionManager == null) {
    		return; // too early
    	}
    	if (dataSource == null) {
    		throw new RuntimeException("No data source set");
    	}
		for (Label label : m_labels.keySet()) {
			configureLabel(label);
		}
		for (MenuItem menuItem : m_menuItems) {
			configureMenuItem(menuItem);
		}
		for (Button button : m_myButtons) {
			configureButton(button);
		}
    }
    
    /**
     * Create (if necessary) and bind fields.
     * @see com.vaadin.data.fieldgroup.FieldGroup#buildAndBindMemberFields(java.lang.Object, boolean)
     */
    protected void buildAndBindMemberFields(Object objectWithMemberFields,
            boolean buildFields) throws BindException {
    	throw new RuntimeException("buildAndBindMemberFields is not supported by Madura");    }
    
    /**
     * We get here when there is a bind() call and the data source has been set.
     * @see com.vaadin.data.fieldgroup.FieldGroup#configureField(com.vaadin.ui.Field)
     */
    protected void configureField(Field field) {
    	super.configureField(field);
    	ValidationObject source = getDataSource();
    	MaduraPropertyWrapper p = getMaduraPropertyWrapper(source,getPropertyId(field),true);
    	AbstractField f = (AbstractField)field;
    	m_maduraSessionManager.bind(f, p);
    }
    
    private ValidationObject getDataSource() {
    	@SuppressWarnings("unchecked")
		BeanItem dataSource = (BeanItem)getItemDataSource();
    	if (dataSource == null) {
    		return null;
    	}
		ValidationObject source = dataSource.getBean();
    	return source;
    }
    
    protected void configureLabel(Label label) {
    	ValidationObject source = getDataSource();
    	MaduraPropertyWrapper maduraPropertyWrapper = getMaduraPropertyWrapper(source,m_labels.get(label),true);
    	@SuppressWarnings("rawtypes")
		final LabelProperty property = new LabelProperty(maduraPropertyWrapper);
    	label.setPropertyDataSource(property);
    	Converter c = label.getConverter();
    	if (c != null && c instanceof MaduraNumericConverter) {
    		((MaduraNumericConverter)c).setFractionDigits(maduraPropertyWrapper.getFieldMetadata().getFractionalDigits());
    	}

    	m_maduraSessionManager.setPermissions(property.getProperty(), label);
        MaduraPropertyWrapper wrapper = property.getProperty();
        if (wrapper != null) {
            m_maduraSessionManager.getValidationSession().addListener(wrapper.getOwner(),wrapper.getName(), new SetterListener(){

    			@Override
    			public void run(ValidationObject object, String name,
    					Object newValue, ValidationSession session) {
    				com.vaadin.data.util.ProtectedMethods.fireValueChange(property);
    			}});
        }
    	
    }
    
    protected void configureMenuItem(MenuItem menuItem) {
    	Command command = menuItem.getCommand();
    	if (command instanceof CommandExt)
    	{
    		CommandExt commandExt = (CommandExt)command;
    		MenuItemPainter painter = commandExt.getPainter();
    		if (painter.getProperty() != null) {
    			m_hints.setCommonProperties(menuItem, painter.getProperty(), m_messageSource);
    		}
    		painter.paint(menuItem);
    	}
    }
        
    protected void configureButton(Button button) {
        ButtonProperty buttonProperty = (ButtonProperty)button.getData();
        button.setCaption(buttonProperty.getCaption());
        ButtonPainter painter = buttonProperty.getPainter();
        if (painter.getPropertyName() != null) {
        	ValidationObject source = getDataSource();
        	getMaduraPropertyWrapper(source, painter.getPropertyName(), true);
        }
        painter.setPropertiesSource(this);
        painter.paint(button);
        MaduraPropertyWrapper wrapper = buttonProperty.getPainter().getProperty();
        if (wrapper != null) {
            m_hints.setCommonProperties(button, wrapper, m_messageSource);
        	final Button finalButton = button;
        	m_maduraSessionManager.getValidationSession().addListener(wrapper.getOwner(),wrapper.getName(), new SetterListener(){

    			@Override
    			public void run(ValidationObject object, String name,
    					Object newValue, ValidationSession session) {
    				finalButton.markAsDirty();
    			}});
        }
    }
        
    /** 
     * Scan the class for {link com.vaadin.ui.Label} fields, as opposed for input fields that the
     * Vaadin code already scans for, and bind them to the Madura session.
     * @param objectWithMemberFields
     * @param buildFields
     */
    private void processLabels(Object objectWithMemberFields, boolean buildFields) {
    	Class objectClass = objectWithMemberFields.getClass();
        for (java.lang.reflect.Field memberField : getFieldsInDeclareOrder(objectClass)) {

            if (!Label.class.isAssignableFrom(memberField.getType())) {
                // Process next field
                continue;
            }

            PropertyId propertyIdAnnotation = memberField
                    .getAnnotation(PropertyId.class);

            Object propertyId = null;
            if (propertyIdAnnotation != null) {
                // @PropertyId(propertyId) always overrides property id
                propertyId = propertyIdAnnotation.value();
            } else {
                try {
                    propertyId = findPropertyId(memberField);
                } catch (SearchException e) {
                    // Property id was not found, skip this field
                    continue;
                }
                if (propertyId == null) {
                    // Property id was not found, skip this field
                    continue;
                }
            }
            Label label;
            try {
                // Get the field from the object
                label = (Label) ReflectTools.getJavaFieldValue(
                        objectWithMemberFields, memberField, Label.class);
            } catch (Exception e) {
                // If we cannot determine the value, just skip the field and try
                // the next one
                continue;
            }
            if (label == null && buildFields) {

                // Create the component (Field)
                label = new Label();

                // Store it in the field
                try {
                    ReflectTools.setJavaFieldValue(objectWithMemberFields,
                            memberField, label);
                } catch (IllegalArgumentException e) {
                    throw new BindException("Could not assign value to field '"
                            + memberField.getName() + "'", e);
                } catch (IllegalAccessException e) {
                    throw new BindException("Could not assign value to field '"
                            + memberField.getName() + "'", e);
                } catch (InvocationTargetException e) {
                    throw new BindException("Could not assign value to field '"
                            + memberField.getName() + "'", e);
                }
            }
            if (label != null) {
                // Bind it to the property id
            	bind(label,propertyId.toString());
            }
        }    	
    }
    /**
     *  We don't trust this call to work right so this override just throws an exception
     * @see com.vaadin.data.fieldgroup.FieldGroup#build(java.lang.String, java.lang.Class, java.lang.Class)
     */
    @SuppressWarnings("rawtypes")
	protected  T build(String caption, Class dataType,
            Class fieldType) throws BindException {
    	throw new RuntimeException("Using the buildxxx methods is not supported by Madura");
    }
    
    /**
     * Using this is inevitably wrong
     * 
     * @see com.vaadin.data.fieldgroup.FieldGroup#buildAndBind(java.lang.Object)
     */
    public Field buildAndBind(Object propertyId) throws BindException {
    	throw new RuntimeException("use buildAndBind(String[] fields, BeanItem itemDataSource) instead");
    }
    
	@Override
	public void buildAndBind(AbstractComponentContainer panel,
			List fields,
			BeanItem itemDataSource) {
		Map> fieldList = buildAndBind(fields,itemDataSource);
		panel.removeAllComponents();
		for (Field f: fieldList.values()) {
			panel.addComponent(f);
		}		
	}
	@Override
	public void buildAndBind(AbstractComponentContainer panel, String[] fields, BeanItem itemDataSource) {
		Map> fieldList = buildAndBind(Arrays.asList(fields),itemDataSource);
		panel.removeAllComponents();
		for (Field f: fieldList.values()) {
			panel.addComponent(f);
		}
	}
	/* (non-Javadoc)
	 * @see nz.co.senanque.vaadin.MaduraFieldGroup#buildAndBind(com.vaadin.ui.Layout, java.util.List, com.vaadin.data.util.BeanItem)
	 */
	@Override
	public Map> buildAndBind(String[] fields, BeanItem itemDataSource) {
		return buildAndBind(Arrays.asList(fields),itemDataSource);
	}
	/* (non-Javadoc)
	 * @see nz.co.senanque.vaadin.MaduraFieldGroup#buildAndBind(com.vaadin.ui.Layout, java.util.List, com.vaadin.data.util.BeanItem)
	 */
	@Override
	public Map> buildAndBind(List fields, BeanItem itemDataSource) {
		m_maduraSessionManager.getValidationSession().bind(((BeanItem)itemDataSource).getBean());
		// the super call will only bind fields
    	super.setItemDataSource(itemDataSource);
    	Map> ret = new HashMap<>();
    	m_properties.clear();
		for (String propertyId : fields) {
	    	ValidationObject validationObject = getDataSource();
	    	MaduraPropertyWrapper maduraPropertyWrapper = getMaduraPropertyWrapper(validationObject,propertyId,true);
	    	final Field field = m_fieldFactory.createFieldByPropertyType(maduraPropertyWrapper);
			ret.put(propertyId,field);
		}
		configure(itemDataSource);
		return ret;
	}
    private MaduraPropertyWrapper getMaduraPropertyWrapper(ValidationObject validationObject, Object propertyId, boolean create) {
    	for (MaduraPropertyWrapper maduraPropertyWrapper: m_properties) {
    		if (maduraPropertyWrapper.getName().equals(propertyId)) {
    	    	return maduraPropertyWrapper;
    		}
    	}
    	if (create) {
    		MaduraPropertyWrapper maduraPropertyWrapper = m_maduraSessionManager.getMaduraPropertyWrapper(validationObject, propertyId.toString());
    		m_properties.add(maduraPropertyWrapper);
    		return maduraPropertyWrapper;
    	}
    	throw new RuntimeException("No such property defined: "+propertyId);
    }
    public void destroy()
    {
        MaduraSessionManager maduraSessionManager = getMaduraSessionManager();
        for (MaduraPropertyWrapper property: m_properties)
        {
            AbstractComponent field = (AbstractComponent)getField(property.getName());
            maduraSessionManager.deregister(field);
        }
        for (Button button : m_myButtons)
        {
            maduraSessionManager.deregister(button);
        }
    }
    
    /* (non-Javadoc)
	 * @see nz.co.senanque.vaadin.MaduraFieldGroup#unbind()
	 */
    @Override
	public void unbind() {
    	m_properties.clear();
    }

	public MaduraSessionManager getMaduraSessionManager() {
		return m_maduraSessionManager;
	}

	public Hints getHints() {
		return m_hints;
	}

	public void setHints(Hints hints) {
		m_hints = hints;
	}
	
	/* (non-Javadoc)
	 * @see nz.co.senanque.vaadin.MaduraFieldGroup#createSubmitButton(java.lang.String, com.vaadin.ui.Button.ClickListener)
	 */
	@Override
	public Button createSubmitButton(String name, ClickListener listener) {
		return createButton(name,new SubmitButtonPainter(m_maduraSessionManager),listener);
	}

	/* (non-Javadoc)
	 * @see nz.co.senanque.vaadin.MaduraFieldGroup#createButton(java.lang.String, com.vaadin.ui.Button.ClickListener)
	 */
	@Override
	public Button createButton(String name, ClickListener listener) {
		return createButton(name,new SimpleButtonPainter(m_maduraSessionManager),listener);
	}

	/* (non-Javadoc)
	 * @see nz.co.senanque.vaadin.MaduraFieldGroup#createFieldButton(java.lang.String, java.lang.String, com.vaadin.ui.Button.ClickListener)
	 */
	@Override
	public Button createFieldButton(String name, String propertyId, ClickListener listener) {
		return createButton(name,new FieldButtonPainter(propertyId, m_maduraSessionManager),listener);
	}

	/* (non-Javadoc)
	 * @see nz.co.senanque.vaadin.MaduraFieldGroup#createSubmitButton(java.lang.String, java.lang.String, com.vaadin.ui.Button.ClickListener)
	 */
	@Override
	public Button createSubmitButton(String name, String permission, ClickListener listener) {
		return createButton(name,new SubmitButtonPainter(permission,m_maduraSessionManager),listener);
	}

	/* (non-Javadoc)
	 * @see nz.co.senanque.vaadin.MaduraFieldGroup#createButton(java.lang.String, java.lang.String, com.vaadin.ui.Button.ClickListener)
	 */
	@Override
	public Button createButton(String name, String permission, ClickListener listener) {
		return createButton(name,new SimpleButtonPainter(permission, m_maduraSessionManager),listener);
	}

	/* (non-Javadoc)
	 * @see nz.co.senanque.vaadin.MaduraFieldGroup#createFieldButton(java.lang.String, java.lang.String, java.lang.String, com.vaadin.ui.Button.ClickListener)
	 */
	@Override
	public Button createFieldButton(String name, String propertyId, String permission, ClickListener listener) {
		return createButton(name,new FieldButtonPainter(propertyId, permission, m_maduraSessionManager),listener);
	}

	public Button createButton(String name, ButtonPainter painter, ClickListener listener) {
		if (this.getItemDataSource() != null) {
			throw new RuntimeException("Do not create components after setItemDataSource");
		}
		Button ret = m_hints.getButtonField(name, m_messageSource);
		if (listener != null) {
			ret.addClickListener(listener);
		}
		if (painter != null)
		{
		    getMaduraSessionManager().register(ret, painter);
		    painter.setPropertiesSource(this);
		}
		m_myButtons.add(ret);
		return ret;
	}
	
	/* (non-Javadoc)
	 * @see nz.co.senanque.vaadin.MaduraFieldGroup#createMenuItemCommand(com.vaadin.ui.Button.ClickListener)
	 */
	@Override
	public CommandExt createMenuItemCommand(final ClickListener listener) {
		return createMenuItemCommandExt(new SimpleButtonPainter(m_maduraSessionManager),listener);
	}
	/* (non-Javadoc)
	 * @see nz.co.senanque.vaadin.MaduraFieldGroup#createMenuItemCommandSubmit(com.vaadin.ui.Button.ClickListener)
	 */
	@Override
	public CommandExt createMenuItemCommandSubmit(final ClickListener listener) {
		return createMenuItemCommandExt(new SubmitButtonPainter(m_maduraSessionManager),listener);
	}
	/* (non-Javadoc)
	 * @see nz.co.senanque.vaadin.MaduraFieldGroup#createMenuItemCommand(java.lang.String, com.vaadin.ui.Button.ClickListener)
	 */
	@Override
	public CommandExt createMenuItemCommand(final String permission, final ClickListener listener) {
		return createMenuItemCommandExt(new SimpleButtonPainter(permission,m_maduraSessionManager),listener);
	}
	/* (non-Javadoc)
	 * @see nz.co.senanque.vaadin.MaduraFieldGroup#createMenuItemCommandSubmit(java.lang.String, com.vaadin.ui.Button.ClickListener)
	 */
	@Override
	public CommandExt createMenuItemCommandSubmit(final String permission, final ClickListener listener) {
		return createMenuItemCommandExt(new SubmitButtonPainter(permission,m_maduraSessionManager),listener);
	}
	public CommandExt createMenuItemCommandExt(final MenuItemPainter painter,
			final ClickListener listener) {
		if (this.getItemDataSource() != null) {
			throw new RuntimeException("Do not create components after setItemDataSource or buildAndBindMemberFields");
		}
		final MaduraFieldGroupImpl me = this;
		CommandExt ret = new CommandExt() {
			MenuItemPainter m_menuItemPainter = painter;

			public void menuSelected(MenuItem selectedItem) {
				listener.buttonClick(null);
			}

			public MenuItemPainter getPainter() {
				m_menuItemPainter.setPropertiesSource(me);
				return m_menuItemPainter;
			}

			public MaduraSessionManager getMaduraSessionManager() {
				return m_maduraSessionManager;
			}
		};
		return ret;
	}
	/* (non-Javadoc)
	 * @see nz.co.senanque.vaadin.MaduraFieldGroup#bind(com.vaadin.ui.MenuBar.MenuItem)
	 */
	@Override
	public void bind(MenuItem field) {
		Command command = field.getCommand();
		if (command != null && command instanceof CommandExt) {
			MessageSourceAccessor messageSourceAccessor = new MessageSourceAccessor(m_messageSource);
			field.setText(messageSourceAccessor.getMessage(field.getText(), field.getText()));
			m_maduraSessionManager.register(field);
			m_menuItems.add(field);
		} else {
			throw new RuntimeException("Menu item command is not a CommandExt");
		}
		if (getItemDataSource() == null) {
			return;
		}
		configureMenuItem(field);
	}

	@Override
	public List getProperties() {
		return m_properties;
	}
	public MaduraPropertyWrapper findProperty(String propertyName) {
		return m_maduraSessionManager.findProperty(propertyName, getProperties());
	}

	public String getId() {
		return m_id;
	}

}