Package standup.clouds

This package provides the implementation for the STANDUP user interface.

See:
          Description

Interface Summary
Entity  
EntityAnimated  
 

Class Summary
AnimatorCloudButton An instance of AnimatorCloudButton defines a type of animation that can be applied to a CloudButton.
AnimatorCloudButtonMoveIn Animates a CloudButton to move from its position as a peripheral child to the centre.
AnimatorCloudButtonMoveOut Animates a CloudButton to move from the centre to its position as a peripheral child.
AnimatorCloudButtonResize Animates a CloudButton to grow/shrink at a given position.
AnimatorCloudButtonRotateLeft Animates a CloudButton to rotate 360 degrees to the left, eventually returning to its starting position.
AnimatorCloudButtonRotateRight Animates a CloudButton to rotate 360 degrees to the right, eventually returning to its starting position.
AnimatorCloudButtonStayPut "Animates" a CloudButton to stay in its current position.
AnimatorLock An object that is used to control synchronization between different animation routines.
AnyLock An object that is used to control synchronization between different threads.
BubbleLabelSegmentString  
ClipboardJokeText A class representing the joke of a text, which is copied to the Windows clipboard when displayed in the STANDUP user interface.
CloudButton A CloudButton is a GUI button that appears inside a PanelCloudButtonMenu, i.e.
CloudButtonAddToFavourites A CloudButton that, when selected by the user, adds the current joke to the current user profile's "favourite" jokes.
CloudButtonJokeGetter A CloudButton that, when selected by the user, presents the option of getting a NEW joke or seeing OLD jokes.
CloudButtonJokeTypeChooser A CloudButton that, when selected by the user, presents a selection of the various available JokeTypes.
CloudButtonLogin A CloudButton that presents the initial login menu.
CloudButtonNewJoke A CloudButton that, when selected by the user, calls the Backend to get a new joke that satisfies the current user profile's joke constraints.
CloudButtonNewJokeAny A CloudButton that, when selected by the user, calls the Backend to get any new joke that satisfies the current user profile's joke constraints.
CloudButtonNewJokeLexeme A CloudButton that, when selected by the user, calls the Backend to get a new joke using a specific sense of a word that satisfies the current user profile's joke constraints.
CloudButtonNewJokeTopic A CloudButton that, when selected by the user, calls the Backend to get a new joke on a specific topic that satisfies the current user profile's joke constraints.
CloudButtonNewJokeType A CloudButton that, when selected by the user, calls the Backend to get a new joke of a specific type that satisfies the current user profile's joke constraints.
CloudButtonNewJokeWord A CloudButton that, when selected by the user, calls the Backend to get a new joke using a specific word that satisfies the current user profile's joke constraints.
CloudButtonOldJoke A CloudButton that, when selected by the user, displays a previously generated joke.
CloudButtonOldJokes A CloudButton that, when selected by the user, displays a set of previously generated jokes that satisfy the current user profile's joke constraints.
CloudButtonOldJokesAll A CloudButton that, when selected by the user, displays a set of all previously generated jokes that satisfy the current user profile's joke constraints.
CloudButtonOldJokesFavourites A CloudButton that, when selected by the user, displays the user's favourite jokes that satisfy the current user profile's joke constraints.
CloudButtonOldJokesLexeme A CloudButton that, when selected by the user, displays a set of all previously generated jokes using a specific sense of a word that satisfies the current user profile's joke constraints.
CloudButtonOldJokesTopic A CloudButton that, when selected by the user, displays a set of all previously generated jokes about a specific topic that satisfies the current user profile's joke constraints.
CloudButtonOldJokesType A CloudButton that, when selected by the user, displays a set of all previously generated jokes of a specific type that satisfies the current user profile's joke constraints.
CloudButtonOldJokesWord A CloudButton that, when selected by the user, displays a set of all previously generated jokes using a specific word that satisfies the current user profile's joke constraints.
CloudButtonProfile A CloudButton that, when selected by the user, loads a user's existing profile, prepares all necessary data structures, and then displays the main menu.
CloudButtonProfileChooser A CloudButton that, when selected by the user, displays a selection of the various known user profiles on disk.
CloudButtonProfileTypeIn A CloudButton that, when selected by the user, asks for a new user's name, creates a new default profile, uses it, and finally presents the main menu.
CloudButtonRepeatJoke A CloudButton that, when selected by the user, repeats the display of the current joke.
CloudButtonSenseChooser A CloudButton that, when selected by the user, displays the various senses of a given word (i.e.
CloudButtonTellJoke A CloudButton that, when selected by the user, displays the various joke-telling options.
CloudButtonTellJokeSpeak A CloudButton that, when selected by the user, puts up a dialog screen (i.e.
CloudButtonTopic A CloudButton that, when selected by the user, displays the various subtopics of a given Topic along the periphery, and an option to get jokes on said topic in the centre.
CloudButtonTopicWordChooser A CloudButton that, when selected by the user, displays the various subtopics of a given Topic along the periphery, and an option to see words about said topic in the centre.
CloudButtonWordClustered A CloudButton that, when selected by the user, displays a set of words, potentially clustered alphabetically to reduce the number of available choices.
CloudButtonWordModeChooser A CloudButton that, when selected by the user, displays various options of how to choose a word, i.e.
CloudButtonWordTrie A CloudButton that, when selected by the user, displays a choice of subsequent letters (or complete words) in spelling a word.
CloudButtonWordTrieClustered A variant of CloudButtonWordTrie that clusters letters together to reduce the number of options displayed.
CloudButtonWordTypeIn A CloudButton that, when selected by the user, puts up a dialog screen where the user can type in, or choose a word, from a JComboBox.
CloudDialog A modal dialog screen that can be used to either display a message or obtain input from the user.
CloudDialogButton A button that appears in a CloudDialog or CloudDialogNonModal.
CloudDialogNonModal A non-modal dialog screen that can be used to inform a user that a time-consuming operation is currently being executed.
CloudFrontend The main class that launches the STANDUP GUI and sets up all the various user interface components.
CloudLabel An instance of this class specifies the caption, layout, symbols, and speech of a label that can be associated with a Captionable element.
CloudLabelFactory This class defines all the user interface messages.
CloudLabelSegment  
ControlPanel  
EntityAnimatedInteractive  
EntityAnimatedInteractiveBubbleLabel  
EntityAnimatedInteractiveBubbleLabelStatic  
EntityImageStatic  
GUIGraphicsHandler Provides static methods for loading the GUI SVG files.
HelpCoordinator  
HistoryCoordinator  
Logger  
MessageWindowBubble  
Milestone  
MovingImage  
OptionsCloudFrontend  
OptionsGUICloudFrontend  
PanelCloudButtonMenu  
PanelMessageWindow  
PanelProgressMap  
PanelToolbar  
ProfileCloudFrontend This class stores all user parameters relating to the frontend.
ProgressMapCharacter  
ProgressMapCharacterOnly  
ProgressMapNode  
Scanner  
ScannerMyDialog  
ScrollerButton  
ShapeDetails  
SimpleSplash  
SimpleSplashDialog  
Skin  
SplashScreen  
SplashScreenMain  
STANDUPShape A STANDUPShape is an element that has a background image, can optionally be highlighted, and has space for a CloudLabel.
STANDUPShapeCloudButton  
STANDUPSpeakable  
STANDUPSpeaker JSAPI-based interface to the FreeTTS synthesizer.
StuffToRender  
SVGSpec  
SVGSpecIcon An SVGSpec for a GUI graphics file.
SVGSpecSymbol  
TalkingHeadRepeatable  
ToolbarButton  
WordTrie  
 

Enum Summary
CloudButton.LineMode  
CloudButtonOldJoke.OldJokeStatus  
CloudLabelJokeDisplay An enumeration of 3 modes of displaying a joke in a BubbleLabel: QUESTION: Only display the question ANSWER: Only display the answer QUESTION_AND_ANSWER: Display both the question and the answer
PanelProgressMap.ProgressMapStage  
PointingMethod  
Skin.ToolbarDisplay  
 

Package standup.clouds Description

This package provides the implementation for the STANDUP user interface.

Overview

The main class that launches the STANDUP GUI is the CloudFrontend. It is configurable for individual user profiles (it implements Profileable -- see standup.profiling package documentation for more details). User profiles are stored as instances of the ProfileCloudFrontend class.

The various components that make up the GUI are as follows: There are also various non-visible classes that handle various aspects of the user interface, i.e.: Additionally, a CloudFrontend also contains a Backend field to handle joke generation requests.

Extending functionality

To extend functionality of the STANDUP GUI, create new instances of CloudButton and override/replace existing ones.

The standup.clouds.executeClick() method is the most important one to be overriden. It is called when the user selects the corresponding button. It should execute whatever functionality it represents, and set up its submenu (i.e. "child" CloudButtons) and call the appropriate animations.