gumbo.interact
Class InteractorFeedback

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

Direct Known Subclasses:

DataFeedback

public class InteractorFeedback

extends java.lang.Object

Intended for use by interactors to provide interaction feedback presentations. The default implementation provides only visual feedback in the form of color change.

Version:

$Revision: 1.1 $

Author:

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

Field Summary

static java.awt.Color	COLOR_ARMED
static java.awt.Color	COLOR_ASPECT
static java.awt.Color	COLOR_ASPECT_GROUP_OVER
static java.awt.Color	COLOR_ASPECT_OVER
static java.awt.Color	COLOR_CANCEL
static java.awt.Color	COLOR_CANCEL_BG
static java.awt.Color	COLOR_CAPTURE
static java.awt.Color	COLOR_COMMAND
static java.awt.Color	COLOR_COMMAND_ASPECT
static java.awt.Color	COLOR_COMMAND_ASPECT_GROUP_OVER
static java.awt.Color	COLOR_COMMAND_ASPECT_OVER
static java.awt.Color	COLOR_COMMAND_GROUP_OVER
static java.awt.Color	COLOR_COMMAND_OVER
static java.awt.Color	COLOR_GROUP_OVER
static java.awt.Color	COLOR_GROUP_OVER_BG
static java.awt.Color	COLOR_NORMAL
static java.awt.Color	COLOR_NORMAL_BG
static java.awt.Color	COLOR_OVER
static java.awt.Color	COLOR_OVER_BG
static InteractorFeedback	INSTANCE Default singleton instance.

Constructor Summary

protected

InteractorFeedback() Creates an instance.

Method Summary

java.awt.Color	aspectColor(InteractorState state) Returns the custom aspect color corresponding to the specified interaction state.
java.awt.Color	feedbackColor(InteractorState state) Returns the feedback color corresponding to the specified interaction state.
java.awt.Color	textBackgroundColor(InteractorState state) Returns the text background color corresponding to the specified interaction state.
java.awt.Color	textForegroundColor(InteractorState state) Returns the text foreground color corresponding to the specified interaction state.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final InteractorFeedback INSTANCE

Default singleton instance.

COLOR_NORMAL

public static final java.awt.Color COLOR_NORMAL

COLOR_OVER

public static final java.awt.Color COLOR_OVER

COLOR_GROUP_OVER

public static final java.awt.Color COLOR_GROUP_OVER

COLOR_ARMED

public static final java.awt.Color COLOR_ARMED

COLOR_CAPTURE

public static final java.awt.Color COLOR_CAPTURE

COLOR_CANCEL

public static final java.awt.Color COLOR_CANCEL

COLOR_COMMAND

public static final java.awt.Color COLOR_COMMAND

COLOR_COMMAND_OVER

public static final java.awt.Color COLOR_COMMAND_OVER

COLOR_COMMAND_GROUP_OVER

public static final java.awt.Color COLOR_COMMAND_GROUP_OVER

COLOR_ASPECT

public static final java.awt.Color COLOR_ASPECT

COLOR_ASPECT_OVER

public static final java.awt.Color COLOR_ASPECT_OVER

COLOR_ASPECT_GROUP_OVER

public static final java.awt.Color COLOR_ASPECT_GROUP_OVER

COLOR_COMMAND_ASPECT

public static final java.awt.Color COLOR_COMMAND_ASPECT

COLOR_COMMAND_ASPECT_OVER

public static final java.awt.Color COLOR_COMMAND_ASPECT_OVER

COLOR_COMMAND_ASPECT_GROUP_OVER

public static final java.awt.Color COLOR_COMMAND_ASPECT_GROUP_OVER

COLOR_NORMAL_BG

public static final java.awt.Color COLOR_NORMAL_BG

COLOR_OVER_BG

public static final java.awt.Color COLOR_OVER_BG

COLOR_GROUP_OVER_BG

public static final java.awt.Color COLOR_GROUP_OVER_BG

COLOR_CANCEL_BG

public static final java.awt.Color COLOR_CANCEL_BG

Constructor Detail

InteractorFeedback

protected InteractorFeedback()

Creates an instance.

Method Detail

textForegroundColor

public java.awt.Color textForegroundColor(InteractorState state)

Returns the text foreground color corresponding to the specified interaction state. Intended for use by text labels. Default implementation: Returns the inverted (255-color) value of textBackgroundColor().

Returns:

The color. Never null.

textBackgroundColor

public java.awt.Color textBackgroundColor(InteractorState state)

Returns the text background color corresponding to the specified interaction state. Intended for use by text labels. Default implementation: Returns feedbackColor() with substitution of the ???_BG colors.

Returns:

The color. Never null.

feedbackColor

public java.awt.Color feedbackColor(InteractorState state)

Returns the feedback color corresponding to the specified interaction state. Intended for general use, such as for graph edge line and vertex border color. Default implementation: In order of flag group priority, checks for trigger flags (cancel, armed, capture), standard command and aspect flags, custom aspect flags, then no flag. Within each group, checks for over, then group over flags. If no flags are set returns COLOR_NORMAL. Custom aspect flags are checked by aspectColor().

Returns:

The color. Never null.

aspectColor

public java.awt.Color aspectColor(InteractorState state)

Returns the custom aspect color corresponding to the specified interaction state. Default implementation: Returns null.

Returns:

The color. Null if no custom aspect flags are in the interactor state.