All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.vaadin.event.SelectionEvent Maven / Gradle / Ivy

    /*
 * Vaadin Framework 7
 *
 * Copyright (C) 2000-2024 Vaadin Ltd
 *
 * This program is available under Vaadin Commercial License and Service Terms.
 *
 * See  for the full
 * license.
 */
package com.vaadin.event;

import java.io.Serializable;
import java.util.Collection;
import java.util.Collections;
import java.util.EventObject;
import java.util.LinkedHashSet;
import java.util.Set;

/**
 * An event that specifies what in a selection has changed, and where the
 * selection took place.
 *
 * @since 7.4
 * @author Vaadin Ltd
 */
public class SelectionEvent extends EventObject {

    private LinkedHashSet oldSelection;
    private LinkedHashSet newSelection;

    public SelectionEvent(Object source, Collection oldSelection,
            Collection newSelection) {
        super(source);
        this.oldSelection = new LinkedHashSet(oldSelection);
        this.newSelection = new LinkedHashSet(newSelection);
    }

    /**
     * A {@link Collection} of all the itemIds that became selected.
     * 
    
     * Note: this excludes all itemIds that might have been previously
     * selected.
     *
     * @return a Collection of the itemIds that became selected
     */
    public Set getAdded() {
        return setDifference(newSelection, oldSelection);
    }

    /**
     * A {@link Collection} of all the itemIds that became deselected.
     * 
    
     * Note: this excludes all itemIds that might have been previously
     * deselected.
     *
     * @return a Collection of the itemIds that became deselected
     */
    public Set getRemoved() {
        return setDifference(oldSelection, newSelection);
    }

    /**
     * Slightly optimized set difference that can return the original set or a
     * modified one.
     *
     * @param set1
     *            original set
     * @param set2
     *            the set to subtract
     * @return the difference set
     */
    private static  Set setDifference(Set set1, Set set2) {
        if (set2.isEmpty()) {
            return set1;
        } else {
            LinkedHashSet set = new LinkedHashSet(set1);
            set.removeAll(set2);
            return set;
        }
    }

    /**
     * A {@link Collection} of all the itemIds that are currently selected.
     *
     * @return a Collection of the itemIds that are currently selected
     */
    public Set getSelected() {
        return Collections.unmodifiableSet(newSelection);
    }

    /**
     * The listener interface for receiving {@link SelectionEvent
     * SelectionEvents}.
     */
    public interface SelectionListener extends Serializable {
        /**
         * Notifies the listener that the selection state has changed.
         *
         * @param event
         *            the selection change event
         */
        void select(SelectionEvent event);
    }

    /**
     * The interface for adding and removing listeners for {@link SelectionEvent
     * SelectionEvents}.
     */
    public interface SelectionNotifier extends Serializable {
        /**
         * Registers a new selection listener
         *
         * @param listener
         *            the listener to register
         */
        void addSelectionListener(SelectionListener listener);

        /**
         * Removes a previously registered selection change listener
         *
         * @param listener
         *            the listener to remove
         */
        void removeSelectionListener(SelectionListener listener);
    }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy