gumbo.interact
Class StatusAdapter

java.lang.Object
  |
  +--gumbo.interact.StatusAdapter

public class StatusAdapter

extends java.lang.Object

Base class for status feedback adapters. Converts discrete control events into a target interactor state (see InteractorFlags.STATUS_???). Can work multiple targets, but relies on input events to do any cleanup before switching to a new target.

Version:

$Revision: 1.1 $

Author:

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

Constructor Summary

StatusAdapter()
Creates an instance that recognizes all targets.

StatusAdapter(java.util.Collection targets)
Creates an instance that recognizes a group of dynamic targets.

StatusAdapter(Interactor target)
Creates an instance that recognizes a single static target.

Method Summary

BooleanField.EventIn	getDisableIn() True while the control is disabled.
BooleanField.EventIn	getDiscommendIn() True while control use is discommended.
BooleanField.EventIn	getInactiveIn() True while the control is inactive (because window is inactive).
BooleanField.EventIn	getRecommendIn() True while control use is recommended.
InteractorField.EventIn	getTargetIn() The current target.
void	setNoPickTarget(Interactor target) Sets the feedback target corresponding to NO_PICK_TARGET target in.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StatusAdapter

public StatusAdapter()

Creates an instance that recognizes all targets.

StatusAdapter

public StatusAdapter(Interactor target)

Creates an instance that recognizes a single static target.

Parameters:

target - The recognized target. NO_PICK_TARGET for the no pick target. Never null.

StatusAdapter

public StatusAdapter(java.util.Collection targets)

Creates an instance that recognizes a group of dynamic targets. Master constructor.

Parameters:

targets - The group of recognized targets (Interactor). Live reference. Include NO_PICK_TARGET for the no pick target. Only affects new targets. If null, all targets are recognized.

Method Detail

setNoPickTarget

public void setNoPickTarget(Interactor target)

Sets the feedback target corresponding to NO_PICK_TARGET target in.

Parameters:

target - The feedback target. Null if none. The default is null.

getTargetIn

public InteractorField.EventIn getTargetIn()

The current target. None if null or not recognized.

getInactiveIn

public BooleanField.EventIn getInactiveIn()

True while the control is inactive (because window is inactive). Ignored if there is no target in.

getDisableIn

public BooleanField.EventIn getDisableIn()

True while the control is disabled. Ignored if there is no target in.

getRecommendIn

public BooleanField.EventIn getRecommendIn()

True while control use is recommended. Ignored if there is no target in.

getDiscommendIn

public BooleanField.EventIn getDiscommendIn()

True while control use is discommended. Ignored if there is no target in.