scripting

Class commonsdialog

java.lang.Object

scripting.commonsdialog

public class commonsdialog
extends java.lang.Object

Module with functions to show simple dialogs.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCEPT_CANCEL
static int	CANCEL
static int	DIRECTORIES_ONLY
static int	FILES_ONLY filechooser selectionMode
static int	FORBIDEN msgbox messagetypes
static int	IDEA
static int	NO
static int	OPEN_DIRECTORY
static int	OPEN_FILE filechooser options
static int	QUESTION
static int	SAVE_FILE
static int	WARNING
static int	YES Return values for confirmDialog
static int	YES_NO Confirmdialog optionType Options
static int	YES_NO_CANCEL

Constructor Summary

Constructors

Constructor and Description
commonsdialog()

Method Summary

Modifier and Type	Method and Description
static int	confirmDialog(java.lang.String prompt, java.lang.String title, int optionType, int messageType, javax.swing.JComponent root) Shows a dialog to request to the user an answer of YES, NO or CANCEL.
static java.lang.String[]	filechooser(int mode, java.lang.String title, java.lang.String initialPath, boolean multiselection, java.lang.String filter, boolean fileHidingEnabled, java.awt.Component root) Show an file or folder selector dialog.
static java.lang.String	inputbox(java.lang.String prompt, java.lang.String title, int messageType, java.lang.String initialValue, java.awt.Component root) Shows a dialog to request a input to the user.
static void	msgbox(java.lang.String message, java.lang.String title, int messageType, java.awt.Component root) Shows a message dialog with ok button only.
static java.lang.String[]	openFileDialog(java.lang.String title, java.lang.String initialPath, java.awt.Component root) Show a selector dialog for choose a file for reading.
static java.lang.String[]	openFolderDialog(java.lang.String title, java.lang.String initialPath, java.awt.Component root) Show a selector dialog for choose a folder.
static java.lang.String[]	saveFileDialog(java.lang.String title, java.lang.String initialPath, java.awt.Component root) Show a selector dialog for choose a file for writing.

Methods inherited from class java.lang.Object

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

Field Detail

FORBIDEN

public static final int FORBIDEN

msgbox messagetypes

See Also:

Constant Field Values

IDEA

public static final int IDEA

See Also:

Constant Field Values

WARNING

public static final int WARNING

See Also:

Constant Field Values

QUESTION

public static final int QUESTION

See Also:

Constant Field Values

YES_NO

public static final int YES_NO

Confirmdialog optionType Options

See Also:

Constant Field Values

YES_NO_CANCEL

public static final int YES_NO_CANCEL

See Also:

Constant Field Values

ACCEPT_CANCEL

public static final int ACCEPT_CANCEL

See Also:

Constant Field Values

YES

public static final int YES

Return values for confirmDialog

See Also:

Constant Field Values

NO

public static final int NO

See Also:

Constant Field Values

CANCEL

public static final int CANCEL

See Also:

Constant Field Values

OPEN_FILE

public static final int OPEN_FILE

filechooser options

See Also:

Constant Field Values

OPEN_DIRECTORY

public static final int OPEN_DIRECTORY

See Also:

Constant Field Values

SAVE_FILE

public static final int SAVE_FILE

See Also:

Constant Field Values

FILES_ONLY

public static final int FILES_ONLY

filechooser selectionMode

See Also:

Constant Field Values

DIRECTORIES_ONLY

public static final int DIRECTORIES_ONLY

See Also:

Constant Field Values

Constructor Detail

commonsdialog

public commonsdialog()

Method Detail

msgbox

public static void msgbox(java.lang.String message,
                          java.lang.String title,
                          int messageType,
                          java.awt.Component root)

Shows a message dialog with ok button only.
Valid values for messageType are:

• FORBIDEN
• IDEA
• WARNING
• QUESTION

Parameters:

message -

title, - optional, title of the dialog

messageType, - optional, default value is IDEA

root, - optional, parent Component for this dialog, default values is gvSIG main window.

inputbox

public static java.lang.String inputbox(java.lang.String prompt,
                                        java.lang.String title,
                                        int messageType,
                                        java.lang.String initialValue,
                                        java.awt.Component root)

Shows a dialog to request a input to the user.
Valid values for messageType are:

• FORBIDEN
• IDEA
• WARNING
• QUESTION

Parameters:

prompt -

title, - optional, title of the dialog

messageType, - optional, default value is IDEA

initialValue, - optional, default value is ""

root, - optional, parent Component for this dialog, default values is gvSIG main window.

Returns:

the string value entered by the user or None.

confirmDialog

public static int confirmDialog(java.lang.String prompt,
                                java.lang.String title,
                                int optionType,
                                int messageType,
                                javax.swing.JComponent root)

Shows a dialog to request to the user an answer of YES, NO or CANCEL.
Valid values for optionType are:

• YES_NO
• YES_NO_CANCEL
• ACCEPT_CANCEL

Valid values for messageType are:

• FORBIDEN
• IDEA
• WARNING
• QUESTION

Parameters:

prompt -

title, - optional, title of the dialog

optionType, - optional, default value is YES_NO

messageType, - optional, default value is IDEA

root, - optional, parent Component for this dialog, default values is gvSIG main window.

Returns:

YES, NO, CANCEL.

filechooser

public static java.lang.String[] filechooser(int mode,
                                             java.lang.String title,
                                             java.lang.String initialPath,
                                             boolean multiselection,
                                             java.lang.String filter,
                                             boolean fileHidingEnabled,
                                             java.awt.Component root)

Show an file or folder selector dialog. If multiselection is False, the default value, return the path-name of the selected file or folder. If is True, return a list of the selecteds path-names.
Return None if the user cancel the action.
Valid values for mode are:

• FILES_ONLY
• DIRECTORIES_ONLY

Parameters:

mode -

title, - optional, title of the dialog

initialPath, - optional, default value is None

multiselection, - optional, default value is False

filter, - optional, default value is None

fileHidingEnabled, - optional, default value is True

root, - optional, parent Component for this dialog, default values is gvSIG main window.

Returns:

the pathnames selected or None if user cancel.

openFileDialog

public static java.lang.String[] openFileDialog(java.lang.String title,
                                                java.lang.String initialPath,
                                                java.awt.Component root)

Show a selector dialog for choose a file for reading.
This is a utility function that call to filechooser.
Return None if the user cancel the action.

Parameters:

title, - optional, title of the dialog

initialPath, - optional, default value is None

root, - optional, parent Component for this dialog, default values is gvSIG main window.

Returns:

the pathnames selected or None if user cancel.

openFolderDialog

public static java.lang.String[] openFolderDialog(java.lang.String title,
                                                  java.lang.String initialPath,
                                                  java.awt.Component root)

Show a selector dialog for choose a folder.
This is a utility function that call to filechooser.
Return None if the user cancel the action.

Parameters:

title, - optional, title of the dialog

initialPath, - optional, default value is None

root, - optional, parent Component for this dialog, default values is gvSIG main window.

Returns:

the pathnames selected or None if user cancel.

saveFileDialog

public static java.lang.String[] saveFileDialog(java.lang.String title,
                                                java.lang.String initialPath,
                                                java.awt.Component root)

Show a selector dialog for choose a file for writing.
This is a utility function that call to filechooser.
Return None if the user cancel the action.

Parameters:

title, - optional, title of the dialog

initialPath, - optional, default value is None

root, - optional, parent Component for this dialog, default values is gvSIG main window.

Returns:

the pathnames selected or None if user cancel.