Package com.gargoylesoftware.base.gui
Class AbstractUIController
java.lang.Object
com.gargoylesoftware.base.gui.AbstractUIController
An abstract superclass for GUI controller classes.
Swing uses an architecture similar to Model-View-Controller (MVC) in which the model, view and controller components are kept seperate from each other. This class provides some common behaviour that is useful for controller objects. This includes support for:
- Starting and managing worker threads. See
startTask(WorkerTask)
,taskComplete(WorkerTask)
,taskSuccessful(WorkerTask)
,taskExceptionThrown(WorkerTask,Exception)
,taskErrorThrown(WorkerTask,Throwable)
- Simple support for localization. See
setLocale(Locale)
,getLocale()
,localeChanged(Locale)
- Version:
- $Revision: 1.6 $
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected final void
assertNotNull
(String fieldName, Object object) Throw an exception if the specified object is nullfinal Locale
Return the current locale.protected abstract void
localeChanged
(Locale locale) The current locale has changed - update all locale specific information.final void
run()
The main entry point into this controllerprotected abstract void
runImpl()
Subclasses will override this to provide the run logicfinal void
Set the current localeprotected final void
startTask
(WorkerTask task) Start a WorkerTask.protected void
taskComplete
(WorkerTask task) A callback that will be invoked when a task has completed whether it was successful or not.protected void
taskErrorThrown
(WorkerTask task, Throwable throwable) A callback that will be invoked when a system error is thrown during the processing of a WorkerTask.protected void
taskExceptionThrown
(WorkerTask task, Exception exception) A callback that will be invoked when an exception is thrown during the processing of a WorkerTask.protected void
taskSuccessful
(WorkerTask task) A callback that will be invoked when a task completed successfully.
-
Field Details
-
locale_
-
-
Constructor Details
-
AbstractUIController
public AbstractUIController()Create a new controller.
-
-
Method Details
-
setLocale
Set the current locale- Parameters:
locale
- the new locale
-
getLocale
Return the current locale.- Returns:
- The current locale
-
run
public final void run()The main entry point into this controller -
runImpl
protected abstract void runImpl()Subclasses will override this to provide the run logic -
startTask
Start a WorkerTask. This involves running some code on a background thread and then some more on the ui thread. See WorkerTask for more details.When the task has completed, one of the following callbacks will be called based on the success of the task.
- If the task completed without error then
taskSuccessful()
will be called - If an exception was thrown during processing of the task then
taskExceptionThrown()
will be called - If an error was thrown during processing of the task then
taskErrorThrown()
will be called
Finally, the methodtaskSuccessful()
will be called will be called to signal the completion of the task- Parameters:
task
- The WorkerTask that is about to execute.
- If the task completed without error then
-
taskExceptionThrown
A callback that will be invoked when an exception is thrown during the processing of a WorkerTask. Note that errors and other throwables will processed by the methodtaskErrorThrown(WorkerTask,Throwable)
.The default behaviour is to print the stack trace of the caught exception to System.out. Override this method to provide custom error handling.
- Parameters:
task
- The task that failedexception
- The exception that was caught.
-
taskErrorThrown
A callback that will be invoked when a system error is thrown during the processing of a WorkerTask. System errors are any throwable objects not descended from Exception. Typically, only system level code will be concerned by the errors handled by this method. Application code should only be concerned with the errors handled bytaskExceptionThrown(WorkerTask,Exception)
. The default behaviour is to print the stack trace of the caught error to System.out. Override this method to provide custom error handling.- Parameters:
task
- The task that failedthrowable
- The throwable object that was caught
-
taskSuccessful
A callback that will be invoked when a task completed successfully. Override this method to provide custom handling on completion of a task.The default behaviour is to do nothing. Override this to provide custom behaviour.
- Parameters:
task
- The task that just finished.
-
taskComplete
A callback that will be invoked when a task has completed whether it was successful or not. Override this method to provide custom handling on completion of a task. The default behaviour is to do nothing. Override this to provide custom behaviour.- Parameters:
task
- The task that just finished.
-
localeChanged
The current locale has changed - update all locale specific information. All logic that sets locale sensitive information should be executed in this method.- Parameters:
locale
- The new locale
-
assertNotNull
Throw an exception if the specified object is null- Parameters:
fieldName
- The name of the paremeter we are checkingobject
- The value of the parameter we are checking
-