recyclerview-selection/src/main/java/androidx/recyclerview/selection/MouseCallbacks.java

/*
 * Copyright 2017 The Android Open Source Project
 *
 * 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 androidx.recyclerview.selection;

import static android.support.annotation.RestrictTo.Scope.LIBRARY_GROUP;

import android.support.annotation.RestrictTo;
import android.view.MotionEvent;

/**
 * Override methods in this class to connect specialized behaviors of the selection
 * code to the application environment.
 *
 * @hide
 */
@RestrictTo(LIBRARY_GROUP)
public abstract class MouseCallbacks {

    static final MouseCallbacks DUMMY = new MouseCallbacks() {
        @Override
        public boolean onContextClick(MotionEvent e) {
            return false;
        }
    };

    /**
     * Called when user performs a context click, usually via mouse pointer
     * right-click.
     *
     * @param e the event associated with the click.
     * @return true if the event was handled.
     */
    public abstract boolean onContextClick(MotionEvent e);
}