story.scheherazade.virgil
Interface SCHSelector

All Known Subinterfaces:

SCHSelectorWithBrowser

All Known Implementing Classes:

AssertionSelector, BooleanSelector, BrowsableSelector, GroupSelector, ManualSelector, NameSelector, PredicateSelector, PrepositionSelector, PropositionTypeSelector, TypeSelector, VirgilLauncher

public interface SCHSelector

An interface for those classes which offer GUI elements for letting the user make selections from among narrative symbols, i.e., picking a character, or constructing a new Action.

Method Summary

javax.swing.JComponent	getPanel() Get the JComponent of the GUI front-end of the selector.
java.lang.Object	getSelection() Return the value of this selector.
SCHVariableType	getType()
void	redoLayout() Reconstruct the GUI for this selector.
boolean	selectionReady() Returns whether a value has been properly set.
void	setSelection(java.lang.Object selection) Set the selection.
void	subSelectorCancelling() Indicates to the selector that a subordinate selector (such as the parameters within a ConditionSelector) has been told by the user to cancel the selection process.
void	subSelectorSet(SCHSelector selectorSet) Inform the Selector that a subordinate selector (such as a sub-selector of PredicateSelector has had a value set.
void	subSelectorSubmitting() Indicates to the selector that a subordinate selector (such as the parameters within a ConditionSelector) has been told by the user that their value is final.

Method Detail

getPanel

javax.swing.JComponent getPanel()

Get the JComponent of the GUI front-end of the selector.

subSelectorSet

void subSelectorSet(SCHSelector selectorSet)

Inform the Selector that a subordinate selector (such as a sub-selector of PredicateSelector has had a value set.

getSelection

java.lang.Object getSelection()
                              throws Scheherexception

Return the value of this selector. Will throw an exception if no value has yet been properly set.

Throws:

Scheherexception

selectionReady

boolean selectionReady()

Returns whether a value has been properly set.

redoLayout

void redoLayout()

Reconstruct the GUI for this selector.

subSelectorSubmitting

void subSelectorSubmitting()

Indicates to the selector that a subordinate selector (such as the parameters within a ConditionSelector) has been told by the user that their value is final.

subSelectorCancelling

void subSelectorCancelling()

Indicates to the selector that a subordinate selector (such as the parameters within a ConditionSelector) has been told by the user to cancel the selection process.

This is ONLY ever triggered when the PredicateSelector is initialized with the CANCEL_BUTTON parameter set to true (and, of course, the user chooses to click that button).

setSelection

void setSelection(java.lang.Object selection)
                  throws Scheherexception

Set the selection. Throws an exception if the selection is not valid for the selector.

Throws:

Scheherexception

getType

SCHVariableType getType()
                        throws Scheherexception

Throws:

Scheherexception