org.gwt.advanced.client.ui.widget.combo.ComboBoxChangeEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of advanced-gwt Show documentation

The set of useful GWT components

There is a newer version: 2.0.9

/*
 * Copyright 2008-2012 Sergey Skladchikov
 *
 * 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 org.gwt.advanced.client.ui.widget.combo;

import com.google.gwt.event.dom.client.ChangeEvent;

/**
 * This event extends the standard ChangeEvent class to provide more information about how
 * the event was produced.
 * It's fired by the {@link org.gwt.advanced.client.ui.widget.ComboBox} and subclasses.
 * 
 * @author Sergey Skladchikov
 * @since 2.0.1
 */
public class ComboBoxChangeEvent extends ChangeEvent {
    /** selected row number */
    private int row;
    /** an input device originally initiated the event */
    private ChangeEventInputDevice inputDevice;

    /**
     * Creates an instance of this class and initalized internal variables.
     *
     * @param row is a row number.
     * @param inputDevice is an original input device initiated the event.
     */
    public ComboBoxChangeEvent(int row, ChangeEventInputDevice inputDevice) {
        this.row = row;
        this.inputDevice = inputDevice;
    }

    public int getRow() {
        return row;
    }

    public ChangeEventInputDevice getInputDevice() {
        return inputDevice;
    }

    /**
     * This enum describes possible devices that can initiate the event.
     */
    public enum ChangeEventInputDevice {
        /** keyboard device (or virtual keyboard) */
        KEYBOARD,
        /** mouse device (or touch screen) */
        MOUSE
    }
}