com.vaadin.event.SortEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vaadin-server Show documentation
Vaadin server
There is a newer version: 8.7.2
/*
 * Copyright 2000-2014 Vaadin Ltd.
 * 
 * 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.vaadin.event;

import java.io.Serializable;
import java.util.List;

import com.vaadin.data.sort.SortOrder;
import com.vaadin.ui.Component;

/**
 * Event describing a change in sorting of a {@link Container}. Fired by
 * {@link SortNotifier SortNotifiers}.
 * 
 * @see SortListener
 * 
 * @since 7.4
 * @author Vaadin Ltd
 */
public class SortEvent extends Component.Event {

    private final List sortOrder;
    private final boolean userOriginated;

    /**
     * Creates a new sort order change event with a sort order list.
     * 
     * @param source
     *            the component from which the event originates
     * @param sortOrder
     *            the new sort order list
     * @param userOriginated
     *            true if event is a result of user interaction,
     *            false if from API call
     */
    public SortEvent(Component source, List sortOrder,
            boolean userOriginated) {
        super(source);
        this.sortOrder = sortOrder;
        this.userOriginated = userOriginated;
    }

    /**
     * Gets the sort order list.
     * 
     * @return the sort order list
     */
    public List getSortOrder() {
        return sortOrder;
    }

    /**
     * Returns whether this event originated from actions done by the user.
     * 
     * @return true if sort event originated from user interaction
     */
    public boolean isUserOriginated() {
        return userOriginated;
    }

    /**
     * Listener for sort order change events.
     */
    public interface SortListener extends Serializable {
        /**
         * Called when the sort order has changed.
         * 
         * @param event
         *            the sort order change event
         */
        public void sort(SortEvent event);
    }

    /**
     * The interface for adding and removing listeners for {@link SortEvent
     * SortEvents}.
     */
    public interface SortNotifier extends Serializable {
        /**
         * Adds a sort order change listener that gets notified when the sort
         * order changes.
         * 
         * @param listener
         *            the sort order change listener to add
         */
        public void addSortListener(SortListener listener);

        /**
         * Removes a sort order change listener previously added using
         * {@link #addSortListener(SortListener)}.
         * 
         * @param listener
         *            the sort order change listener to remove
         */
        public void removeSortListener(SortListener listener);
    }
}