gumbo.interact.select
Interface SelectMapper

All Superinterfaces:

PickMapper

All Known Implementing Classes:

AbstractSelectMapper

public interface SelectMapper

extends PickMapper

A pick mapper that maps members of a selction group to the group. Includes the ability to update membership in the group.

Version:

$Revision: 1.4 $

Author:

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

Method Summary

BooleanField.EventIn	getActiveIn() If false, input events are ignored and the selection group cannot be changed.
CollectionField.EventIn	getAddAllIn() Adds a group of members (Interactor) to the selection group and syncs their state.
InteractorField.EventIn	getAddIn() Adds a member to the selection group and syncs its state.
InteractorField.EventOut	getAddOut() Sends the interactor after it is added to the selection group.
NotifyNode.EventIn	getClearIn() Removes all members from the selection group and desyncs their state.
InteractorField.EventOut	getGroupOut() Sends an immutable view of the interactor group (InteractorGroup) after it may have been modified.
CollectionField.EventIn	getRemoveAllIn() Removes a group of members (Interactor) from the selection group and desyncs their state.
InteractorField.EventIn	getRemoveIn() Removes a member from the selection group and desyncs its state.
InteractorField.EventOut	getRemoveOut() Sends the interactor after it is removed from the selection group.
InteractorGroup	getSelectGroup() Returns the selection group managed by this select mapper.

Methods inherited from interface gumbo.interact.PickMapper

getPickIn, getPickOut

Method Detail

getSelectGroup

public InteractorGroup getSelectGroup()

Returns the selection group managed by this select mapper. Clients can directly modify its state, but not its membership.

Returns:

Reference to the group. Never null.

getActiveIn

public BooleanField.EventIn getActiveIn()

If false, input events are ignored and the selection group cannot be changed. Defaults to true.

getAddAllIn

public CollectionField.EventIn getAddAllIn()

Adds a group of members (Interactor) to the selection group and syncs their state. Ignored if null. Throws an exception if a non-null member is not an Interactor; otherwise, members are handled as per getAddIn().

getRemoveAllIn

public CollectionField.EventIn getRemoveAllIn()

Removes a group of members (Interactor) from the selection group and desyncs their state. Ignored if null. Throws an exception if a non-null member is not an Interactor; otherwise, members are handled as per getRemoveIn().

getAddIn

public InteractorField.EventIn getAddIn()

Adds a member to the selection group and syncs its state. Ignored if null, duplicate, or NO_PICK_TARGET. Throws an exception if the member is the selection group.

getRemoveIn

public InteractorField.EventIn getRemoveIn()

Removes a member from the selection group and desyncs its state. Ignored if null or missing.

getClearIn

public NotifyNode.EventIn getClearIn()

Removes all members from the selection group and desyncs their state.

getAddOut

public InteractorField.EventOut getAddOut()

Sends the interactor after it is added to the selection group. An input event may produce none or more events (an add all input event will produce an output event for each added member).

getRemoveOut

public InteractorField.EventOut getRemoveOut()

Sends the interactor after it is removed from the selection group. An input event may produce none or more events (a remove all input event will produce an output event for each added member).

getGroupOut

public InteractorField.EventOut getGroupOut()

Sends an immutable view of the interactor group (InteractorGroup) after it may have been modified. May be empty but never null. An input event should produce none or one event.