gumbo.interact
Class InteractorFlags

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

public final class InteractorFlags
extends java.lang.Object

Constants and utilities related to interactor flags (see InteractorFlag). Specifically contains pre-defined state flags and masks (state values).

Version:
$Revision: 1.3 $
Author:
Jon Barrilleaux (jonb@jmbaai.com) of JMB and Associates Inc.

Field Summary
static ActionFlag ACTION_FOCUS
          Action: The keyboard cursor is on the interactor, signifying keyboard focus.
static ActionFlag ACTION_GROUP_FOCUS
          Action: The interactor is a member of a group that the keyboard cursor is on.
static ActionFlag ACTION_GROUP_IDENTIFY
          Action: The interactor is a member of a group with identifying feedback.
static java.util.Set ACTION_GROUP_MASK
          Action: All predefined group action flags.
static ActionFlag ACTION_GROUP_OVER
          Action: The interactor is a member of a group that the mouse is over.
static ActionFlag ACTION_GROUP_SIGNIFY
          Action: The interactor is a member of a group with signifying feedback.
static ActionFlag ACTION_IDENTIFY
          Action: Interactor has identifying feedback (manifested by tooltip or verbal message).
static java.util.Set ACTION_MASK
          Action: All predefined control action flags.
static ActionFlag ACTION_NONE
          Action: Uninitialized and invalid action state.
static ActionFlag ACTION_OVER
          Action: The mouse cursor is over the interactor.
static ActionFlag ACTION_SIGNIFY
          Action: Interactor has signifying feedback (manifested by highlighting or sound effect).
static java.util.Set ACTION_SINGLE_MASK
          Action: All predefined non-group action flags.
static ControlFlag CONTROL_ARMED
          Control: Control is armed for firing (such as when a mouse button is pressed while over a control button).
static java.util.Set CONTROL_ARMED_FLAGS
          Control: Singleton set containing the CONTROL_ARMED exclusive flag.
static ControlFlag CONTROL_CANCEL
          Control: Control capture is being canceled (such as when the escape key is pressed while a control button is down).
static java.util.Set CONTROL_CANCEL_FLAGS
          Control: Singleton set containing the CONTROL_CANCEL exclusive flag.
static ControlFlag CONTROL_CAPTURE
          Control: Control is captured for rearming or firing (such as when a mouse button remains down whether or not over a control button), or for cancel.
static java.util.Set CONTROL_CAPTURE_FLAGS
          Control: Singleton set containing the CONTROL_CAPTURE exclusive flag.
static ControlFlag CONTROL_FIRE
          Control: Control is firing or has fired (such as when a mouse button is released while over an armed control button).
static java.util.Set CONTROL_FIRE_FLAGS
          Control: Singleton set containing the CONTROL_FIRE exclusive flag.
static java.util.Set CONTROL_MASK
          Control: All predefined control flags.
static ControlFlag CONTROL_NONE
          Control: Uninitialized and invalid control state.
static java.util.Set CONTROL_XOR_MASK
          Status: Predefined control flags that are exclusive-or (none or one).
static java.util.Set MASK
          Interaction mask: All pre-defined interaction flags.
static java.util.Set NONE_MASK
          Interaction none: All "none" interaction flags.
static SelectFlag SELECT_ASPECT
          Selection: Default flag for a selected aspect member.
static SelectFlag SELECT_COMMAND
          Selection: Default flag for a selected command target.
static java.util.Set SELECT_MASK
          Selection: All predefined selection flags.
static SelectFlag SELECT_NONE
          Selection: Uninitialized and invalid selection state.
static java.util.Set SELECT_TYPES
          Selection: Set of select flag types.
static StatusFlag STATUS_AUTO
          Status: Control was automatically manipulated (activated, selected) by the system.
static StatusFlag STATUS_DISABLE
          Status: Control is disabled.
static java.util.Set STATUS_DISABLE_FLAGS
          Status: Singleton set containing the STATUS_DISABLE exclusive flag.
static StatusFlag STATUS_DISCOMMEND
          Status: Control use is discommended.
static java.util.Set STATUS_DISCOMMEND_FLAGS
          Status: Singleton set containing the STATUS_DISCOMMEND exclusive flag.
static StatusFlag STATUS_INACTIVE
          Status: Control is inactive (because window is inactive).
static java.util.Set STATUS_MASK
          Status: All predefined control status flags.
static StatusFlag STATUS_NONE
          Status: Uninitialized and invalid status state.
static StatusFlag STATUS_RECOMMEND
          Status: Control use is recommended.
static java.util.Set STATUS_RECOMMEND_FLAGS
          Status: Singleton set containing the STATUS_RECOMMEND exclusive flag.
static java.util.Set STATUS_XOR_MASK
          Status: Predefined control status flags that are exclusive-or (none or one) .
 
Method Summary
static java.util.List sortFlags(java.util.Collection state, java.lang.Class type, java.util.List retVal)
          Returns a list of flags of a given type, sorted by natural order, lowest to highest.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACTION_NONE

public static final ActionFlag ACTION_NONE
Action: Uninitialized and invalid action state. No action flags specified.


ACTION_OVER

public static final ActionFlag ACTION_OVER
Action: The mouse cursor is over the interactor.


ACTION_GROUP_OVER

public static final ActionFlag ACTION_GROUP_OVER
Action: The interactor is a member of a group that the mouse is over.


ACTION_FOCUS

public static final ActionFlag ACTION_FOCUS
Action: The keyboard cursor is on the interactor, signifying keyboard focus.


ACTION_GROUP_FOCUS

public static final ActionFlag ACTION_GROUP_FOCUS
Action: The interactor is a member of a group that the keyboard cursor is on.


ACTION_SIGNIFY

public static final ActionFlag ACTION_SIGNIFY
Action: Interactor has signifying feedback (manifested by highlighting or sound effect).


ACTION_GROUP_SIGNIFY

public static final ActionFlag ACTION_GROUP_SIGNIFY
Action: The interactor is a member of a group with signifying feedback.


ACTION_IDENTIFY

public static final ActionFlag ACTION_IDENTIFY
Action: Interactor has identifying feedback (manifested by tooltip or verbal message).


ACTION_GROUP_IDENTIFY

public static final ActionFlag ACTION_GROUP_IDENTIFY
Action: The interactor is a member of a group with identifying feedback.


ACTION_SINGLE_MASK

public static final java.util.Set ACTION_SINGLE_MASK
Action: All predefined non-group action flags.


ACTION_GROUP_MASK

public static final java.util.Set ACTION_GROUP_MASK
Action: All predefined group action flags.


ACTION_MASK

public static final java.util.Set ACTION_MASK
Action: All predefined control action flags.


CONTROL_NONE

public static final ControlFlag CONTROL_NONE
Control: Uninitialized and invalid control state. No action flags specified.


CONTROL_CAPTURE

public static final ControlFlag CONTROL_CAPTURE
Control: Control is captured for rearming or firing (such as when a mouse button remains down whether or not over a control button), or for cancel.


CONTROL_ARMED

public static final ControlFlag CONTROL_ARMED
Control: Control is armed for firing (such as when a mouse button is pressed while over a control button).


CONTROL_FIRE

public static final ControlFlag CONTROL_FIRE
Control: Control is firing or has fired (such as when a mouse button is released while over an armed control button).


CONTROL_CANCEL

public static final ControlFlag CONTROL_CANCEL
Control: Control capture is being canceled (such as when the escape key is pressed while a control button is down).


CONTROL_CAPTURE_FLAGS

public static final java.util.Set CONTROL_CAPTURE_FLAGS
Control: Singleton set containing the CONTROL_CAPTURE exclusive flag.


CONTROL_ARMED_FLAGS

public static final java.util.Set CONTROL_ARMED_FLAGS
Control: Singleton set containing the CONTROL_ARMED exclusive flag.


CONTROL_FIRE_FLAGS

public static final java.util.Set CONTROL_FIRE_FLAGS
Control: Singleton set containing the CONTROL_FIRE exclusive flag.


CONTROL_CANCEL_FLAGS

public static final java.util.Set CONTROL_CANCEL_FLAGS
Control: Singleton set containing the CONTROL_CANCEL exclusive flag.


CONTROL_XOR_MASK

public static final java.util.Set CONTROL_XOR_MASK
Status: Predefined control flags that are exclusive-or (none or one).


CONTROL_MASK

public static final java.util.Set CONTROL_MASK
Control: All predefined control flags.


STATUS_NONE

public static final StatusFlag STATUS_NONE
Status: Uninitialized and invalid status state. No status flags specified.


STATUS_INACTIVE

public static final StatusFlag STATUS_INACTIVE
Status: Control is inactive (because window is inactive).


STATUS_DISABLE

public static final StatusFlag STATUS_DISABLE
Status: Control is disabled.


STATUS_RECOMMEND

public static final StatusFlag STATUS_RECOMMEND
Status: Control use is recommended.


STATUS_DISCOMMEND

public static final StatusFlag STATUS_DISCOMMEND
Status: Control use is discommended.


STATUS_AUTO

public static final StatusFlag STATUS_AUTO
Status: Control was automatically manipulated (activated, selected) by the system.


STATUS_DISABLE_FLAGS

public static final java.util.Set STATUS_DISABLE_FLAGS
Status: Singleton set containing the STATUS_DISABLE exclusive flag.


STATUS_RECOMMEND_FLAGS

public static final java.util.Set STATUS_RECOMMEND_FLAGS
Status: Singleton set containing the STATUS_RECOMMEND exclusive flag.


STATUS_DISCOMMEND_FLAGS

public static final java.util.Set STATUS_DISCOMMEND_FLAGS
Status: Singleton set containing the STATUS_DISCOMMEND exclusive flag.


STATUS_XOR_MASK

public static final java.util.Set STATUS_XOR_MASK
Status: Predefined control status flags that are exclusive-or (none or one) .


STATUS_MASK

public static final java.util.Set STATUS_MASK
Status: All predefined control status flags.


SELECT_NONE

public static final SelectFlag SELECT_NONE
Selection: Uninitialized and invalid selection state. No select command flags specified. Contains a null role object and the lowest possible selection order (Integer.MIN_VALUE).


SELECT_ASPECT

public static final SelectFlag SELECT_ASPECT
Selection: Default flag for a selected aspect member. Contains a null role object and the second lowest possible selection order (Integer.MIN_VALUE - 1).


SELECT_COMMAND

public static final SelectFlag SELECT_COMMAND
Selection: Default flag for a selected command target. Contains a null role object and the third lowest possible selection order (Integer.MIN_VALUE - 2).


SELECT_TYPES

public static final java.util.Set SELECT_TYPES
Selection: Set of select flag types.


SELECT_MASK

public static final java.util.Set SELECT_MASK
Selection: All predefined selection flags.


MASK

public static final java.util.Set MASK
Interaction mask: All pre-defined interaction flags.


NONE_MASK

public static final java.util.Set NONE_MASK
Interaction none: All "none" interaction flags.

Method Detail

sortFlags

public static java.util.List sortFlags(java.util.Collection state,
                                       java.lang.Class type,
                                       java.util.List retVal)
Returns a list of flags of a given type, sorted by natural order, lowest to highest. The flag type must implement Comparable. If more than one flag has the same sort order, only one will be retained, and that one is arbitrary. Typically used to sort concrete select flags, such as AspectModelFlag, by select order.

Parameters:
state - A group of state flags (Comparable). Never null.
type - The type of state flags to be sorted and output. Never null.
retVal - Return value object. The sorted list. Possibly empty but never null.
Returns:
Reference to retVal. Never null.