From a539b4cd7becbd1aa370f9502e4f85912d7c2844 Mon Sep 17 00:00:00 2001 From: Teemu Suo-Anttila Date: Fri, 12 Dec 2014 15:30:24 +0200 Subject: Rename SelectionChangeEvent and SortOrderChangeEvent (#13334) Also renames related listeners and notifiers. Change-Id: I96bfdae8173a1c691623938cc7dbcddee7198e46 --- .../src/com/vaadin/event/SelectionChangeEvent.java | 110 -------------------- server/src/com/vaadin/event/SelectionEvent.java | 104 +++++++++++++++++++ server/src/com/vaadin/event/SortEvent.java | 110 ++++++++++++++++++++ .../src/com/vaadin/event/SortOrderChangeEvent.java | 111 --------------------- 4 files changed, 214 insertions(+), 221 deletions(-) delete mode 100644 server/src/com/vaadin/event/SelectionChangeEvent.java create mode 100644 server/src/com/vaadin/event/SelectionEvent.java create mode 100644 server/src/com/vaadin/event/SortEvent.java delete mode 100644 server/src/com/vaadin/event/SortOrderChangeEvent.java (limited to 'server/src/com/vaadin/event') diff --git a/server/src/com/vaadin/event/SelectionChangeEvent.java b/server/src/com/vaadin/event/SelectionChangeEvent.java deleted file mode 100644 index adc7b13d49..0000000000 --- a/server/src/com/vaadin/event/SelectionChangeEvent.java +++ /dev/null @@ -1,110 +0,0 @@ -/* - * 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.Collection; -import java.util.EventObject; -import java.util.LinkedHashSet; -import java.util.Set; - -import com.google.gwt.thirdparty.guava.common.collect.Sets; - -/** - * An event that specifies what in a selection has changed, and where the - * selection took place. - * - * @since - * @author Vaadin Ltd - */ -public class SelectionChangeEvent extends EventObject { - - private LinkedHashSet oldSelection; - private LinkedHashSet newSelection; - - public SelectionChangeEvent(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 Sets.difference(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 Sets.difference(oldSelection, newSelection); - } - - /** - * The listener interface for receiving {@link SelectionChangeEvent - * SelectionChangeEvents}. - * - * @since - * @author Vaadin Ltd - */ - public interface SelectionChangeListener extends Serializable { - /** - * Notifies the listener that the selection state has changed. - * - * @param event - * the selection change event - */ - void selectionChange(SelectionChangeEvent event); - } - - /** - * The interface for adding and removing listeners for - * {@link SelectionChangeEvent SelectionChangeEvents}. - * - * @since - * @author Vaadin Ltd - */ - public interface SelectionChangeNotifier extends Serializable { - /** - * Registers a new selection change listener - * - * @param listener - * the listener to register - */ - void addSelectionChangeListener(SelectionChangeListener listener); - - /** - * Removes a previously registered selection change listener - * - * @param listener - * the listener to remove - */ - void removeSelectionChangeListener(SelectionChangeListener listener); - } -} diff --git a/server/src/com/vaadin/event/SelectionEvent.java b/server/src/com/vaadin/event/SelectionEvent.java new file mode 100644 index 0000000000..f852ea0949 --- /dev/null +++ b/server/src/com/vaadin/event/SelectionEvent.java @@ -0,0 +1,104 @@ +/* + * 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.Collection; +import java.util.EventObject; +import java.util.LinkedHashSet; +import java.util.Set; + +import com.google.gwt.thirdparty.guava.common.collect.Sets; + +/** + * An event that specifies what in a selection has changed, and where the + * selection took place. + * + * @since + * @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 Sets.difference(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 Sets.difference(oldSelection, 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); + } +} diff --git a/server/src/com/vaadin/event/SortEvent.java b/server/src/com/vaadin/event/SortEvent.java new file mode 100644 index 0000000000..968d2f6d83 --- /dev/null +++ b/server/src/com/vaadin/event/SortEvent.java @@ -0,0 +1,110 @@ +/* + * 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 + * @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 removeSortistener(SortListener listener); + } +} diff --git a/server/src/com/vaadin/event/SortOrderChangeEvent.java b/server/src/com/vaadin/event/SortOrderChangeEvent.java deleted file mode 100644 index fdf604a034..0000000000 --- a/server/src/com/vaadin/event/SortOrderChangeEvent.java +++ /dev/null @@ -1,111 +0,0 @@ -/* - * 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 SortOrderChangeNotifier SortOrderChangeNotifiers}. - * - * @see SortOrderChangeListener - * - * @since - * @author Vaadin Ltd - */ -public class SortOrderChangeEvent 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 SortOrderChangeEvent(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 SortOrderChangeListener extends Serializable { - /** - * Called when the sort order has changed. - * - * @param event - * the sort order change event - */ - public void sortOrderChange(SortOrderChangeEvent event); - } - - /** - * The interface for adding and removing listeners for - * {@link SortOrderChangeEvent SortOrderChangeEvents}. - */ - public interface SortOrderChangeNotifier 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 addSortOrderChangeListener(SortOrderChangeListener listener); - - /** - * Removes a sort order change listener previously added using - * {@link #addSortOrderChangeListener(SortOrderChangeListener)}. - * - * @param listener - * the sort order change listener to remove - */ - public void removeSortOrderChangeListener( - SortOrderChangeListener listener); - } -} -- cgit v1.2.3