Package VASSAL.tools

Class ProblemDialog

java.lang.Object

VASSAL.tools.ProblemDialog

public class ProblemDialog
extends Object

Since:

3.1.0

Author:

Joel Uckelman

Method Summary

Modifier and Type	Method	Description
static Future<?>	show(int messageType, Component parent, String messageKey, Object... args)
static Future<?>	show(int messageType, Component parent, Throwable thrown, String messageKey, Object... args)
static Future<?>	show(int messageType, Component parent, Throwable thrown, String title, String heading, String message)
static Future<?>	show(int messageType, String messageKey, Object... args)
static Future<?>	show(int messageType, Throwable thrown, String messageKey, Object... args)
static Future<?>	showDeprecated(String date)	Display a warning about the use of deprecated code in custom modules showDeprecated is called once for each use of a Deprecated Vassal method that has been marked for removal by the VASSAL development team.
static Future<?>	showDetails(int messageType, Component parent, String details, String messageKey, Object... args)
static Future<?>	showDetails(int messageType, Component parent, Throwable thrown, String details, String messageKey, Object... args)
static Future<?>	showDetails(int messageType, Component parent, Throwable thrown, String details, String title, String heading, String message)
static Future<?>	showDetails(int messageType, String details, String messageKey, Object... args)
static Future<?>	showDetails(int messageType, Throwable thrown, String details, String messageKey, Object... args)
static Future<?>	showDetailsDisableable(int messageType, Component parent, String details, Object key, String messageKey, Object... args)
static Future<?>	showDetailsDisableable(int messageType, Component parent, Throwable thrown, String details, Object key, String messageKey, Object... args)
static Future<?>	showDetailsDisableable(int messageType, Component parent, Throwable thrown, String details, Object key, String title, String heading, String message)
static Future<?>	showDetailsDisableable(int messageType, String details, Object key, String messageKey, Object... args)
static Future<?>	showDetailsDisableable(int messageType, Throwable thrown, String details, Object key, String messageKey, Object... args)
static Future<?>	showDisableable(int messageType, Component parent, Object key, String messageKey, Object... args)
static Future<?>	showDisableable(int messageType, Component parent, Throwable thrown, Object key, String messageKey, Object... args)
static Future<?>	showDisableable(int messageType, Component parent, Throwable thrown, Object key, String title, String heading, String message)
static Future<?>	showDisableable(int messageType, Object key, String messageKey, Object... args)
static Future<?>	showDisableable(int messageType, Throwable thrown, Object key, String messageKey, Object... args)
static Future<?>	showDisableableNoI18N(int messageType, Throwable thrown, Object key, String title, String heading, String message)
static Future<?>	showFileOverwriteFailure(int messageType, Component parent, FileSystemException thrown, String details, String messageKey, Object... args)
static Future<?>	showFileOverwriteFailure(int messageType, FileSystemException thrown, String details, String messageKey, Object... args)
static Future<?>	showOutdatedModule(String usage)	Used when SequenceEncoder#next_token runs out of data when it was expecting more.
static Future<?>	showOutdatedUsage(String usage)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

show

public static Future<?> show(int messageType,
 String messageKey,
 Object... args)

show

public static Future<?> show(int messageType,
 Component parent,
 String messageKey,
 Object... args)

show

public static Future<?> show(int messageType,
 Throwable thrown,
 String messageKey,
 Object... args)

show

public static Future<?> show(int messageType,
 Component parent,
 Throwable thrown,
 String messageKey,
 Object... args)

show

public static Future<?> show(int messageType,
 Component parent,
 Throwable thrown,
 String title,
 String heading,
 String message)

showDisableable

public static Future<?> showDisableable(int messageType,
 Object key,
 String messageKey,
 Object... args)

showDisableable

public static Future<?> showDisableable(int messageType,
 Component parent,
 Object key,
 String messageKey,
 Object... args)

showDisableable

public static Future<?> showDisableable(int messageType,
 Throwable thrown,
 Object key,
 String messageKey,
 Object... args)

showDisableable

public static Future<?> showDisableable(int messageType,
 Component parent,
 Throwable thrown,
 Object key,
 String messageKey,
 Object... args)

showDisableable

public static Future<?> showDisableable(int messageType,
 Component parent,
 Throwable thrown,
 Object key,
 String title,
 String heading,
 String message)

showDisableableNoI18N

public static Future<?> showDisableableNoI18N(int messageType,
 Throwable thrown,
 Object key,
 String title,
 String heading,
 String message)

showDetails

public static Future<?> showDetails(int messageType,
 String details,
 String messageKey,
 Object... args)

showDetails

public static Future<?> showDetails(int messageType,
 Component parent,
 String details,
 String messageKey,
 Object... args)

showDetails

public static Future<?> showDetails(int messageType,
 Throwable thrown,
 String details,
 String messageKey,
 Object... args)

showFileOverwriteFailure

public static Future<?> showFileOverwriteFailure(int messageType,
 FileSystemException thrown,
 String details,
 String messageKey,
 Object... args)

showDetails

public static Future<?> showDetails(int messageType,
 Component parent,
 Throwable thrown,
 String details,
 String messageKey,
 Object... args)

showFileOverwriteFailure

public static Future<?> showFileOverwriteFailure(int messageType,
 Component parent,
 FileSystemException thrown,
 String details,
 String messageKey,
 Object... args)

showDetails

public static Future<?> showDetails(int messageType,
 Component parent,
 Throwable thrown,
 String details,
 String title,
 String heading,
 String message)

showDetailsDisableable

public static Future<?> showDetailsDisableable(int messageType,
 String details,
 Object key,
 String messageKey,
 Object... args)

showDetailsDisableable

public static Future<?> showDetailsDisableable(int messageType,
 Component parent,
 String details,
 Object key,
 String messageKey,
 Object... args)

showDetailsDisableable

public static Future<?> showDetailsDisableable(int messageType,
 Throwable thrown,
 String details,
 Object key,
 String messageKey,
 Object... args)

showDetailsDisableable

public static Future<?> showDetailsDisableable(int messageType,
 Component parent,
 Throwable thrown,
 String details,
 Object key,
 String messageKey,
 Object... args)

showDetailsDisableable

public static Future<?> showDetailsDisableable(int messageType,
 Component parent,
 Throwable thrown,
 String details,
 Object key,
 String title,
 String heading,
 String message)

showDeprecated

public static Future<?> showDeprecated(String date)

Display a warning about the use of deprecated code in custom modules showDeprecated is called once for each use of a Deprecated Vassal method that has been marked for removal by the VASSAL development team. We handle the warnings as follows: 1. The Player will only see the first Deprecated warning message. It is displayed in the Chatter and does not contain details, it refers to the Error log for more detail 2. The first warning message for EACH deprecated method is logged in error log with full details. 3. After the initial warning period (6 months after deprecation), the initial user message will be displayed as a Disable-able dialog instead of in the Chatter.

Parameters:

date - YYYYMMDD date the method was deprecated

Returns:

A Future to allow closing of the Dialog box to be tracked.

showOutdatedUsage

public static Future<?> showOutdatedUsage(String usage)

showOutdatedModule

public static Future<?> showOutdatedModule(String usage)

Used when SequenceEncoder#next_token runs out of data when it was expecting more.

Parameters:

usage - - information about what was being sequenced

Returns:

Future - Call the get() method of the return value to wait for dialog to close.