org.dellroad.stuff.vaadin7.EnumComboBox Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dellroad-stuff-vaadin7 Show documentation
DellRoad Stuff classes related to the Vaadin GUI framework.
There is a newer version: 2.6.1
Show newest version

/*
 * Copyright (C) 2022 Archie L. Cobbs. All rights reserved.
 */

package org.dellroad.stuff.vaadin7;

import com.vaadin.shared.ui.combobox.FilteringMode;
import com.vaadin.ui.AbstractSelect.ItemCaptionMode;
import com.vaadin.ui.ComboBox;

/**
 * {@link ComboBox} that chooses an {@link Enum} value.
 *
 * @see EnumContainer
 */
@SuppressWarnings("serial")
public class EnumComboBox extends ComboBox {

    /**
     * Default constructor.
     *
     * 
     * Caller must separately invoke {@link #setEnumDataSource}.
     */
    public EnumComboBox() {
        this(null);
    }

    /**
     * Convenience constructor.
     *
     * 

     * Equivalent to:
     *  

     *  EnumComboBox(enumClass, EnumContainer.TO_STRING_PROPERTY.getName(), true);
     *  
     *
     * @param enumClass enum type, or null to leave data source unset
     * @param  enum type
     */
    public > EnumComboBox(Class enumClass) {
        this(enumClass, true);
    }

    /**
     * Convenience constructor.
     *
     * 
     * Equivalent to:
     *  

     *  EnumComboBox(enumClass, EnumContainer.TO_STRING_PROPERTY, allowNull);
     *  
     *
     * @param enumClass enum type, or null to leave data source unset
     * @param allowNull true to allow a null selection, false otherwise
     * @param  enum type
     */
    public > EnumComboBox(Class enumClass, boolean allowNull) {
        this(enumClass, EnumContainer.TO_STRING_PROPERTY, allowNull);
    }

    /**
     * Convenience constructor.
     *
     * 
     * Equivalent to:
     *  

     *  EnumComboBox(enumClass, displayPropertyName, false);
     *  
     *
     * @param enumClass enum type
     * @param displayPropertyName container property to display in the combo box
     * @param  enum type
     */
    public > EnumComboBox(Class enumClass, String displayPropertyName) {
        this(enumClass, displayPropertyName, false);
    }

    /**
     * Convenience constructor.
     *
     * 
     * Equivalent to:
     *  

     *  EnumComboBox(enumClass != null ? new EnumContainer<T>(enumClass) : null, displayPropertyName, allowNull);
     *  
     *
     * @param enumClass enum type, or null to leave data source unset
     * @param displayPropertyName container property to display in the combo box
     * @param allowNull true to allow a null selection, false otherwise
     * @param  enum type
     */
    public > EnumComboBox(Class enumClass, String displayPropertyName, boolean allowNull) {
        this(enumClass != null ? new EnumContainer<>(enumClass) : null, displayPropertyName, allowNull);
    }

    /**
     * Primary constructor.
     *
     * 
     * This instance is configured for item caption {@link ItemCaptionMode#PROPERTY} mode, with
     * {@code displayPropertyName} as the {@linkplain #setItemCaptionPropertyId item caption property}.
     *
     * @param container container data source, or null to leave data source unset
     * @param displayPropertyName container property to display in the combo box
     * @param allowNull true to allow a null selection, false otherwise
     */
    public EnumComboBox(EnumContainer container, String displayPropertyName, boolean allowNull) {
        if (container != null)
            this.setContainerDataSource(container);
        this.setNewItemsAllowed(false);
        this.setFilteringMode(FilteringMode.CONTAINS);
        this.setItemCaptionMode(ItemCaptionMode.PROPERTY);
        this.setItemCaptionPropertyId(displayPropertyName);

        // Set up whether null selection is allowed
        this.setNullSelectionAllowed(allowNull);
        if (!allowNull && !this.getContainerDataSource().getItemIds().isEmpty())
            this.setValue(this.getContainerDataSource().getItemIds().iterator().next());
    }

    /**
     * Set the {@link Enum} type whose instances serve as this instance's data source.
     *
     * @param enumClass enum class instance
     * @param  enum type
     * @throws IllegalArgumentException if {@code enumClass} is null
     */
    public > void setEnumDataSource(Class enumClass) {
        this.setContainerDataSource(new EnumContainer<>(enumClass));
        if (!this.isNullSelectionAllowed() && !this.getContainerDataSource().getItemIds().isEmpty())
            this.setValue(this.getContainerDataSource().getItemIds().iterator().next());
    }
}