gumbo.interact.button
Interface ButtonGesture

All Superinterfaces:

ButtonTrigger

All Known Implementing Classes:

AbstractButtonGesture

public interface ButtonGesture

extends ButtonTrigger

Base interface for button gestures, which involve gesture targets and trigger buttons.

Version:

$Revision: 1.3 $

Author:

Jon Barrilleaux (jonb@jmbaai.com) of JMB and Associates Inc.

Method Summary

java.util.Collection	getGestureTargets() Gets an immutable view of the recognized pick targets (Interactor).
InteractorField.EventIn	getPickIn() The input pick, which may be NO_PICK_TARGET or null.
InteractorField.EventOut	getPickOut() The output pick, which is the value of the gesture target when the trigger fires.
InteractorField.EventOut	getTargetOut() The gesture target.

Methods inherited from interface gumbo.interact.button.ButtonTrigger

getActiveIn, getArmedOut, getButtonsIn, getCancelIn, getCancelOut, getCaptureOut, getChordButtons, getDomainButtons, getEnableIn, getFireableIn, getFireNotifyOut, getFireOut, getResetIn, getTriggerButtons

Method Detail

getGestureTargets

public java.util.Collection getGestureTargets()

Gets an immutable view of the recognized pick targets (Interactor). May include NO_PICK_TARGET for no target; null entries are ignored. Null if all input targets, including no target, are recognized.

getPickIn

public InteractorField.EventIn getPickIn()

The input pick, which may be NO_PICK_TARGET or null. Typically the mouse over, keyboard focus, or selected interactor.

getTargetOut

public InteractorField.EventOut getTargetOut()

The gesture target. Null if none recognized. May be NO_PICK_TARGET (see getGestureTargets()). Valid during any output events. Trigger inputs are blocked while the target is null. If this gesture is monitoring more than one target the state of the old target is cleared (button trigger cancelled and reset) before target out changes.

getPickOut

public InteractorField.EventOut getPickOut()

The output pick, which is the value of the gesture target when the trigger fires.