- All Implemented Interfaces:
public class SwingShutDownTask extends AbstractShutDownTaskProvides a base for using Swing to ask if shutdown should conditionally continue.
- checkPromptNeeded determines if ready to shutdown. If so, return ready.
- Issue a prompt, asking if the user wants to continue or do something else
- Recheck until something decided.
If no "action" name is provided, only the continue and cancel options are shown.
Constructors Constructor Description
SwingShutDownTask(java.lang.String name, java.lang.String warning, java.lang.String action, java.awt.Component component)Constructor specifies the warning message and action to take
All Methods Instance Methods Concrete Methods Modifier and Type Method Description
call()Ask if shut down is allowed.
checkPromptNeeded()Provide a subclass-specific check as to whether it's OK to shutdown.
didPrompt()Handle the request to address a potential blocker to stopping.
doPrompt()Handle the request to address a potential blocker to stopping.
run()Take the necessary action.
Methods inherited from class jmri.implementation.AbstractShutDownTask
getName, isDoRun, propertyChange, setDoRun, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public SwingShutDownTask(java.lang.String name, java.lang.String warning, java.lang.String action, java.awt.Component component)Constructor specifies the warning message and action to take
name- the name of the task (used in logs)
warning- the prompt to display
action- the action button to display
component- the parent component of the dialog
public final java.lang.Boolean call()Ask if shut down is allowed.
The shut down manager calls this method first on all the tasks before starting to execute the method
ShutDownTask.run()on the tasks.
If this method returns false on any task, the shut down process must be aborted. This implementation merely sets the "doRun" property to true, and should be overridden for any real checking. Note that overriding implementations should call
AbstractShutDownTask.setDoRun(boolean)correctly. This implementation displays a dialog allowing a user continue stopping the app, abort stopping the app, or take a custom action. Closing the dialog without choosing any button is treated as aborting stopping the app.
public void run()Take the necessary action. This method cannot abort the shutdown, and must not require user interaction to complete successfully. This method will be run in parallel to other ShutDownTasks. This implementation calls
didPrompt()if the user took the prompt action.
protected boolean checkPromptNeeded()Provide a subclass-specific check as to whether it's OK to shutdown. If not, issue a prompt before continuing. Default implementation never passes, causing message to be emitted.
- true if ready to shutdown, and no prompt needed. false to present dialog before shutdown proceeds
protected void didPrompt()Handle the request to address a potential blocker to stopping. This method is called in
run()and must not interact with the user.
This is a dummy implementation, intended to be overloaded.