Project CASUAL
API for CASUAL
 All Classes Namespaces Functions Variables
Classes | Public Member Functions | List of all members
CASCADEGUI.CASCADEGUI Class Reference
Inheritance diagram for CASCADEGUI.CASCADEGUI:
CASUAL.iCASUALUI

Public Member Functions

 CASCADEGUI ()
 
boolean saveCASPAC () throws HeadlessException
 
boolean saveCASUAL () throws HeadlessException
 
void StartButtonActionPerformed ()
 
void setCASPAC (Caspac caspac)
 
void setInformationScrollBorderText (String title)
 
void setProgressBar (int value)
 
void setProgressBarMax (int value)
 
void setScript (Script s)
 
void setStartButtonText (String text)
 
void setUserSubMessage (String text)
 
void setWindowBannerText (String text)
 
void deviceConnected (String string)
 
void deviceDisconnected ()
 
void deviceMultipleConnected (int i)
 
String displayMessage (CASUALMessageObject messageObject)
 
boolean isReady ()
 
void setReady (boolean ready)
 
boolean isDummyGUI ()
 
boolean setControlStatus (boolean status, int number, String mode)
 
void setBlocksUnzipped (String i)
 
void sendString (String string)
 
void sendProgress (String data)
 
void setUserMainMessage (String text)
 
- Public Member Functions inherited from CASUAL.iCASUALUI
void dispose ()
 
void setVisible (boolean b)
 

Additional Inherited Members

- Public Attributes inherited from CASUAL.iCASUALUI
final int INTERACTION_TIME_OUT = 0
 
final int INTERACTION_ACTION_REUIRED = 1
 
final int INTERACTION_USER_CANCEL_OPTION = 2
 
final int INTERACTION_USER_NOTIFICATION = 3
 
final int INTERACTION_SHOW_INFORMATION = 4
 
final int INTERACTION_SHOW_ERROR = 5
 
final int INTERACTION_SHOW_YES_NO = 6
 
final int INTERACTION_INPUT_DIALOG = 7
 
final int INTERACTION_COMMAND_NOTIFICATION = 8
 

Detailed Description

CASCADEGUI is CASUAL's Automated Scripting Action Development Environment GUI. It can create, load and execute CASPACs for the CASUAL environment.

Author
adamoutler

Constructor & Destructor Documentation

CASCADEGUI.CASCADEGUI.CASCADEGUI ( )

initializes window

Member Function Documentation

void CASCADEGUI.CASCADEGUI.deviceConnected ( String  string)

dummy method used to implement iCASUALUI for the purpose of allowing CASUAL to throw notifications.

  @param string dummy method used to implement iCASUALUI
void CASCADEGUI.CASCADEGUI.deviceDisconnected ( )

dummy method used to implement iCASUALUI for the purpose of allowing CASUAL to throw notifications.

void CASCADEGUI.CASCADEGUI.deviceMultipleConnected ( int  i)

dummy method used to implement iCASUALUI for the purpose of allowing CASUAL to throw notifications.

  @param i dummy method used to implement iCASUALUI
String CASCADEGUI.CASCADEGUI.displayMessage ( CASUALMessageObject  messageObject)

Takes a message object and displays to user. To properly implement this class the displayMessage should, at a minimum handle both CASUALMessageObject.title and CASUALMessageObject.messageText.

Parameters
messageObjectdefined by CASUAL
Returns
string value which must be interpereted

Implements CASUAL.iCASUALUI.

boolean CASCADEGUI.CASCADEGUI.isDummyGUI ( )

returns true if the UI is a dummy UI. Dummy UI is used for testing and for running CASPACs with a UI from the command line. This is useful for situations when you want to run an automated UI on a loop.

Returns
true if dummy ui.

Implements CASUAL.iCASUALUI.

boolean CASCADEGUI.CASCADEGUI.isReady ( )

returns true if the UI is ready.

Returns
true if ui is ready

Implements CASUAL.iCASUALUI.

boolean CASCADEGUI.CASCADEGUI.saveCASPAC ( ) throws HeadlessException

Saves the active CASPAC from values in the IDE to disk.

Returns
true if successful.
Exceptions
HeadlessException
boolean CASCADEGUI.CASCADEGUI.saveCASUAL ( ) throws HeadlessException

Saves CASPAC and then uses CASPACkager to create a CASUAL.

Returns
true if successful
Exceptions
HeadlessException
void CASCADEGUI.CASCADEGUI.sendProgress ( String  data)

sends a bit of data at a time, such as a character from a terminal command. b should backspace. should erase line.

Parameters
datadata to be sent to UI

Implements CASUAL.iCASUALUI.

void CASCADEGUI.CASCADEGUI.sendString ( String  string)

sends a message to the user console

Parameters
stringString to send

Implements CASUAL.iCASUALUI.

void CASCADEGUI.CASCADEGUI.setBlocksUnzipped ( String  value)

used during unzip as a progress indicator

Parameters
valuenumber of blocks unzipped.

Implements CASUAL.iCASUALUI.

void CASCADEGUI.CASCADEGUI.setCASPAC ( Caspac  caspac)

dummy method used to implement iCASUALUI for the purpose of allowing CASUAL to throw notifications.

  @param caspac dummy method used to implement iCASUALUI

Implements CASUAL.iCASUALUI.

boolean CASCADEGUI.CASCADEGUI.setControlStatus ( boolean  status,
int  numberOfDevicesConnected,
String  mode 
)

sets controls status

Parameters
statuscommanded value
numberOfDevicesConnectedis the number of connected devices.
modestring value representing mode of checking for devices.
Returns
true if successful

Implements CASUAL.iCASUALUI.

void CASCADEGUI.CASCADEGUI.setInformationScrollBorderText ( String  title)

dummy method used to implement iCASUALUI for the purpose of allowing CASUAL to throw notifications.

  @param title title to set

Implements CASUAL.iCASUALUI.

void CASCADEGUI.CASCADEGUI.setProgressBar ( int  value)

dummy method used to implement iCASUALUI for the purpose of allowing CASUAL to throw notifications.

  @param value dummy method used to implement iCASUALUI

Implements CASUAL.iCASUALUI.

void CASCADEGUI.CASCADEGUI.setProgressBarMax ( int  value)

dummy method used to implement iCASUALUI for the purpose of allowing CASUAL to throw notifications.

  @param value dummy method used to implement iCASUALUI

Implements CASUAL.iCASUALUI.

void CASCADEGUI.CASCADEGUI.setReady ( boolean  ready)

provides a setter for UI. Normally unused, but this is for test purposes.

Parameters
readyGUI has all parts established and is ready for operations.

Implements CASUAL.iCASUALUI.

void CASCADEGUI.CASCADEGUI.setScript ( Script  s)

dummy method used to implement iCASUALUI for the purpose of allowing CASUAL to throw notifications.

  @param s dummy method used to implement iCASUALUI

Implements CASUAL.iCASUALUI.

void CASCADEGUI.CASCADEGUI.setStartButtonText ( String  text)

dummy method used to implement iCASUALUI for the purpose of allowing CASUAL to throw notifications.

  @param text dummy method used to implement iCASUALUI

Implements CASUAL.iCASUALUI.

void CASCADEGUI.CASCADEGUI.setUserMainMessage ( String  text)

This message provides a topical overview of what is happening to the user. It should be used sparingly... eg.. pushing files, flashing devices...

Parameters
texttitle to set

Implements CASUAL.iCASUALUI.

void CASCADEGUI.CASCADEGUI.setUserSubMessage ( String  text)

dummy method used to implement iCASUALUI for the purpose of allowing CASUAL to throw notifications.

  @param text dummy method used to implement iCASUALUI

Implements CASUAL.iCASUALUI.

void CASCADEGUI.CASCADEGUI.setWindowBannerText ( String  text)

dummy method used to implement iCASUALUI for the purpose of allowing CASUAL to throw notifications.

  @param text dummy method used to implement iCASUALUI

Implements CASUAL.iCASUALUI.

void CASCADEGUI.CASCADEGUI.StartButtonActionPerformed ( )

dummy method used to implement iCASUALUI for the purpose of allowing CASUAL to throw notifications.

Implements CASUAL.iCASUALUI.


The documentation for this class was generated from the following file: