com.vaadin.event.SortEvent 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.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);
}
}