facets.core.app
Class Dialogs

java.lang.Object
  facets.util.Tracer
      facets.core.app.Dialogs

public abstract class Dialogs
extends Tracer

Builds and launches modal dialogs on behalf of an AppSurface.

Dialogs launches dialogs of two kinds:

• general-purpose input dialogs
• dialogs hosting client-defined DialogSurfaces as described for launchSurfaced(Surfacer, String, DialogSurface.DialogActions, DialogSurface.Contenter...)

Dialogs instances will be created by subclasses of AppSurface.

Nested Class Summary

static class	Dialogs.ExceptionTexts Parameter object for warningException(ExceptionTexts, Exception, boolean).
static class	Dialogs.Response Type-safe definitions of possible dialog responses.
static class	Dialogs.Surfacer Creates the DialogSurface to expose a set of SContenters.

Field Summary

AppSurface	app
static java.lang.String	DEBUG_RESIZABLE
static java.lang.String	KEYTOP_BOUNDS
static java.lang.String	KEYTOP_NATURE_SIZE

Constructor Summary

protected

Dialogs(AppSurface app)

Method Summary

abstract java.io.File	confirmGetFile(java.lang.String title, java.lang.String path)
abstract Dialogs.Response	confirmOKCancel(java.lang.String title, java.lang.String rubric)
abstract Dialogs.Response	confirmYesNo(java.lang.String title, java.lang.String rubric)
int	deleteDirFiles(java.lang.String title, java.io.File dir, FileSpecifier specifier)
boolean	dialogOpen() Is a dialog surface already open?
abstract void	errorMessage(java.lang.String title, java.lang.String rubric)
abstract java.lang.String	getTextInput(java.lang.String title, java.lang.String rubric, java.lang.String proposal)
abstract void	htmlPane(java.lang.String title, java.lang.String path)
abstract void	infoMessage(java.lang.String title, java.lang.String rubric)
void	launchSurfaced(Dialogs.Surfacer surfacer, java.lang.String title, DialogSurface.DialogActions actions, DialogSurface.Contenter... contents) Launches a modal dialog, building its surface where required.
protected abstract DialogHost	newHost() Enables concrete subclasses to create an appropriate DialogHost for use by launchSurfaced(Surfacer, String, DialogSurface.DialogActions, DialogSurface.Contenter...)
abstract java.io.File	openFile(FileSpecifier[] filters)
abstract java.io.File	saveFile(java.io.File proposed, FileSpecifier[] filters)
abstract void	textPane(java.lang.String title, java.lang.String rubric, int rows, int cols)
abstract Dialogs.Response	warningException(Dialogs.ExceptionTexts tt, java.lang.Exception e, boolean inOpen)
abstract Dialogs.Response	warningYesNo(java.lang.String title, java.lang.String rubric)
abstract Dialogs.Response	warningYesNoCancel(java.lang.String title, java.lang.String rubric)

Methods inherited from class facets.util.Tracer

trace, trace, trace, trace, trace, traceDebug, traceDebug, traceObjectText, traceOutput, traceOutputWithClass

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG_RESIZABLE

public static final java.lang.String DEBUG_RESIZABLE

See Also:

Constant Field Values

KEYTOP_NATURE_SIZE

public static final java.lang.String KEYTOP_NATURE_SIZE

See Also:

Constant Field Values

KEYTOP_BOUNDS

public static final java.lang.String KEYTOP_BOUNDS

See Also:

Constant Field Values

app

public final AppSurface app

Constructor Detail

Dialogs

protected Dialogs(AppSurface app)

Method Detail

launchSurfaced

public final void launchSurfaced(Dialogs.Surfacer surfacer,
                                 java.lang.String title,
                                 DialogSurface.DialogActions actions,
                                 DialogSurface.Contenter... contents)

Launches a modal dialog, building its surface where required.

The surface built by the Dialogs.Surfacer on the first invocation for the DialogSurface.Contenter[] array is stored for use in subsequent invocations with equivalent arrays.

Parameters:

surfacer - constructs the surface on first invocation

title - passed to the surfacer

actions - passed to the surfacer

contents - passed either to the surfacer or to DialogSurface.replaceContents(DialogSurface.Contenter[]) in a previously-built surface

dialogOpen

public boolean dialogOpen()

Is a dialog surface already open?

Only applies to dialogs launched with launchSurfaced(Surfacer, String, DialogSurface.DialogActions, DialogSurface.Contenter...)

newHost

protected abstract DialogHost newHost()

Enables concrete subclasses to create an appropriate DialogHost for use by launchSurfaced(Surfacer, String, DialogSurface.DialogActions, DialogSurface.Contenter...)

confirmOKCancel

public abstract Dialogs.Response confirmOKCancel(java.lang.String title,
                                                 java.lang.String rubric)

confirmYesNo

public abstract Dialogs.Response confirmYesNo(java.lang.String title,
                                              java.lang.String rubric)

warningYesNo

public abstract Dialogs.Response warningYesNo(java.lang.String title,
                                              java.lang.String rubric)

warningYesNoCancel

public abstract Dialogs.Response warningYesNoCancel(java.lang.String title,
                                                    java.lang.String rubric)

warningException

public abstract Dialogs.Response warningException(Dialogs.ExceptionTexts tt,
                                                  java.lang.Exception e,
                                                  boolean inOpen)

infoMessage

public abstract void infoMessage(java.lang.String title,
                                 java.lang.String rubric)

errorMessage

public abstract void errorMessage(java.lang.String title,
                                  java.lang.String rubric)

getTextInput

public abstract java.lang.String getTextInput(java.lang.String title,
                                              java.lang.String rubric,
                                              java.lang.String proposal)

openFile

public abstract java.io.File openFile(FileSpecifier[] filters)

saveFile

public abstract java.io.File saveFile(java.io.File proposed,
                                      FileSpecifier[] filters)

confirmGetFile

public abstract java.io.File confirmGetFile(java.lang.String title,
                                            java.lang.String path)

textPane

public abstract void textPane(java.lang.String title,
                              java.lang.String rubric,
                              int rows,
                              int cols)

htmlPane

public abstract void htmlPane(java.lang.String title,
                              java.lang.String path)

deleteDirFiles

public final int deleteDirFiles(java.lang.String title,
                                java.io.File dir,
                                FileSpecifier specifier)