ucot.ui
Interface UIInterface

All Superinterfaces:
ModulePropertyInterface
All Known Implementing Classes:
DummyUI, GraphicalUI

public interface UIInterface
extends ModulePropertyInterface

Interface for the UI. A means for the core component to notify UI that certain actions have been taken. For example that file has been loaded, use cases have been loaded or the ControlInterface has been changed.

In practice any user interface designed for UCOT program should implement this interface because these methods are used for the interclass communication and the core component uses these methods to control the user interface on some level and to inform user about certain things happening on a lower level of the program.

Author:
vevijopi, tujupien

Method Summary
 void analyzeModelLoaded()
          Method for signaling the user interface that the analyze model has been (successfully) loaded.
 void exportDone()
          Method for signaling the user interface that the analyze model has been (successfully) exported.
 ProgressBarInterface getProgressBar()
          Method for getting a new progressbar for showing the current progress status to the user and halting all other usage of the model editor.
 void printError(java.lang.String errorMessage)
           
 void printError(java.lang.String errorMessage, java.lang.String errorTitle)
          Prints an error message to the screen.
 void printWarning(java.lang.String warningMessage)
           
 void printWarning(java.lang.String warningMessage, java.lang.String warningTitle)
          Prints a warning to the screen.
 void setControlInterface(ControlInterface a)
          Set a new control interface for the user interface to use.
 void useCaseAdded(int foundEntities, int addedEntities)
          Core signals user interface that usecases have been parsed, ran heuristic on and been added to given analyze model.
 void useCasesLoaded()
          Method for signaling user interface that use cases have been (successfully) loaded from file.
 
Methods inherited from interface ucot.ModulePropertyInterface
applyProperties, getProperties, loadDefaultProperties, loadProperties, saveProperties, setProperties
 

Method Detail

exportDone

void exportDone()

Method for signaling the user interface that the analyze model has been (successfully) exported.


analyzeModelLoaded

void analyzeModelLoaded()

Method for signaling the user interface that the analyze model has been (successfully) loaded.


useCasesLoaded

void useCasesLoaded()

Method for signaling user interface that use cases have been (successfully) loaded from file.


useCaseAdded

void useCaseAdded(int foundEntities,
                  int addedEntities)

Core signals user interface that usecases have been parsed, ran heuristic on and been added to given analyze model.

Parameters:
foundEntities - How many entities the parser found.
addedEntities - How many entities were added.

setControlInterface

void setControlInterface(ControlInterface a)

Set a new control interface for the user interface to use.

Parameters:
a - ControlInterface to the UCOT core.

printError

void printError(java.lang.String errorMessage,
                java.lang.String errorTitle)

Prints an error message to the screen.

Parameters:
errorMessage - Description of the error.
errorTitle - Title of the dialog.

printError

void printError(java.lang.String errorMessage)

printWarning

void printWarning(java.lang.String warningMessage,
                  java.lang.String warningTitle)

Prints a warning to the screen.

Parameters:
warningMessage - Description of the warning.
warningTitle - Title of the dialog.

printWarning

void printWarning(java.lang.String warningMessage)

getProgressBar

ProgressBarInterface getProgressBar()

Method for getting a new progressbar for showing the current progress status to the user and halting all other usage of the model editor.

Returns:
ProgressBar interface to the progress bar.