wtk/src/org/apache/pivot/wtk/ListViewSelectionListener.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you 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 org.apache.pivot.wtk;

import org.apache.pivot.collections.Sequence;

/**
 * List view selection listener interface.
 */
public interface ListViewSelectionListener {
    /**
     * List view selection listener adapter.
     */
    public static class Adapter implements ListViewSelectionListener {
        @Override
        public void selectedRangeAdded(ListView listView, int rangeStart, int rangeEnd) {
            // empty block
        }

        @Override
        public void selectedRangeRemoved(ListView listView, int rangeStart, int rangeEnd) {
            // empty block
        }

        @Override
        public void selectedRangesChanged(ListView listView, Sequence<Span> previousSelectedRanges) {
            // empty block
        }

        @Override
        public void selectedItemChanged(ListView listView, Object previousSelectedItem) {
            // empty block
        }
    }

    /**
     * Called when a range has been added to a list view's selection.
     *
     * @param listView The source of the event.
     * @param rangeStart The start index of the range that was added, inclusive.
     * @param rangeEnd The end index of the range that was added, inclusive.
     */
    public void selectedRangeAdded(ListView listView, int rangeStart, int rangeEnd);

    /**
     * Called when a range has been removed from a list view's selection.
     *
     * @param listView The source of the event.
     * @param rangeStart The starting index of the range that was removed,
     * inclusive.
     * @param rangeEnd The starting index of the range that was removed,
     * inclusive.
     */
    public void selectedRangeRemoved(ListView listView, int rangeStart, int rangeEnd);

    /**
     * Called when a list view's selection state has changed.
     *
     * @param listView The source of the event.
     * @param previousSelectedRanges If the selection changed directly, contains
     * the ranges that were previously selected. If the selection changed
     * indirectly as a result of a model change, contains the current selection.
     * Otherwise, contains <tt>null</tt>.
     */
    public void selectedRangesChanged(ListView listView, Sequence<Span> previousSelectedRanges);

    /**
     * Called when a list view's selected item has changed.
     *
     * @param listView The source of the event.
     * @param previousSelectedItem The item that was previously selected.
     */
    public void selectedItemChanged(ListView listView, Object previousSelectedItem);
}