io.guise.framework.event.AbstractGestureInputEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation

Guise™ Internet application framework.

There is a newer version: 0.5.3

/*
 * Copyright © 2005-2008 GlobalMentor, Inc. 
 *
 * 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 io.guise.framework.event;

import java.util.Set;

import io.guise.framework.input.Key;

import static java.util.Collections.*;
import static java.util.Objects.*;
import static com.globalmentor.java.Enums.*;

/**
 * An abstract event providing information on input from a user gesture.
 * @author Garret Wilson
 */
public abstract class AbstractGestureInputEvent extends AbstractInputEvent implements GestureInputEvent {

	/** The keys that were pressed when this event was generated. */
	private final Set keys;

	@Override
	public Set getKeys() {
		return keys;
	}

	@Override
	public boolean hasAltKey() {
		return getKeys().contains(Key.ALT_LEFT) || getKeys().contains(Key.ALT_RIGHT); //see if an Alt key is included in the key set
	}

	@Override
	public boolean hasControlKey() {
		return getKeys().contains(Key.CONTROL_LEFT) || getKeys().contains(Key.CONTROL_RIGHT); //see if a Control key is included in the key set
	}

	@Override
	public boolean hasShiftKey() {
		return getKeys().contains(Key.SHIFT_LEFT) || getKeys().contains(Key.SHIFT_RIGHT); //see if a Shift key is included in the key set
	}

	/**
	 * Source constructor.
	 * @param source The object on which the event initially occurred.
	 * @param keys The keys that were pressed when this event was generated.
	 * @throws NullPointerException if the given source and/or keys is null.
	 */
	public AbstractGestureInputEvent(final Object source, final Key... keys) {
		super(source); //construct the parent class
		this.keys = unmodifiableSet(createEnumSet(Key.class, requireNonNull(keys, "Keys cannot be null."))); //save a read-only set of the keys
	}

}