Package docking.widgets.dialogs
Class InputDialog
- java.lang.Object
-
- docking.DialogComponentProvider
-
- docking.widgets.dialogs.InputDialog
-
- All Implemented Interfaces:
ActionContextProvider
,StatusListener
,TaskListener
public class InputDialog extends DialogComponentProvider
A dialog that has text fields to get user input.
-
-
Field Summary
-
Fields inherited from class docking.DialogComponentProvider
applyButton, buttonPanel, cancelButton, dismissButton, okButton, rootPanel
-
-
Constructor Summary
Constructors Constructor Description InputDialog(java.lang.String dialogTitle, java.lang.String label)
Creates a provider for a generic input dialog with the specified title, a text field, labeled by the specified label.InputDialog(java.lang.String dialogTitle, java.lang.String[] labels, java.lang.String[] initialValues)
Creates a generic input dialog with the specified title, a text field, labeled by the specified label.InputDialog(java.lang.String dialogTitle, java.lang.String[] labels, java.lang.String[] initialValues, InputDialogListener listener)
Creates a generic input dialog with the specified title, a text field, labeled by the specified label.InputDialog(java.lang.String dialogTitle, java.lang.String label, java.lang.String initialValue)
Creates a generic input dialog with the specified title, a text field, labeled by the specified label.InputDialog(java.lang.String dialogTitle, java.lang.String label, java.lang.String initialValue, boolean isModal)
Creates a generic input dialog with the specified title, a text field, labeled by the specified label.InputDialog(java.lang.String dialogTitle, java.lang.String label, java.lang.String initialValue, InputDialogListener listener)
Creates a generic input dialog with the specified title, a text field, labeled by the specified label.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
cancelCallback()
The callback method for when the "Cancel" button is pressed.java.lang.String
getValue()
Return the value of the first (and maybe only) text fieldjava.lang.String[]
getValues()
Return the values for all the text field(s)boolean
isCanceled()
Returns if this dialog is cancelledprotected void
okCallback()
The callback method for when the "OK" button is pressed.void
setValue(java.lang.String text)
Sets the text of the primary text fieldvoid
setValue(java.lang.String text, int index)
Sets the text of the text field at the given index-
Methods inherited from class docking.DialogComponentProvider
addAction, addApplyButton, addButton, addCancelButton, addDismissButton, addOKButton, addWorkPanel, alertMessage, alertMessage, applyCallback, cancelCurrentTask, clearScheduledTask, clearStatusText, close, dialogClosed, dialogShown, dismissCallback, dispose, doInitialize, escapeCallback, executeProgressTask, getActionContext, getActions, getBackground, getBounds, getComponent, getDefaultButton, getDefaultSize, getDialogSize, getFocusComponent, getGlassPane, getHelpLocatdion, getId, getIntialLocation, getLocationOnScreen, getParent, getPreferredSize, getRemberSize, getRememberLocation, getStatusColor, getStatusLabel, getStatusText, getTaskMonitorComponent, getTaskScheduler, getTitle, getUseSharedLocation, hideTaskMonitorComponent, isApplyEnabled, isCancelEnabled, isModal, isOKEnabled, isResizeable, isRunningTask, isShowing, isTransient, isVisible, notifyContextChanged, removeAction, removeButton, removeWorkPanel, repack, setApplyEnabled, setApplyToolTip, setBackground, setCancelButtonText, setCancelEnabled, setCancelToolTip, setCursor, setDefaultButton, setDefaultSize, setDialogSize, setDismissToolTip, setFocusComponent, setGlassPane, setHelpLocation, setInitialLocation, setMinimumSize, setMinimumSize, setOkButtonText, setOkEnabled, setOkToolTip, setPreferredSize, setRememberLocation, setRememberSize, setResizable, setStatusJustification, setStatusText, setStatusText, setStatusText, setTitle, setTransient, setUseSharedLocation, showProgressBar, showTaskMonitorComponent, stopProgressTimer, taskCancelled, taskCompleted, toFront, toString, waitForCurrentTask
-
-
-
-
Constructor Detail
-
InputDialog
public InputDialog(java.lang.String dialogTitle, java.lang.String label)
Creates a provider for a generic input dialog with the specified title, a text field, labeled by the specified label. The user should check the value of "isCanceled()" to know whether or not the user canceled the operation. Otherwise, use the "getValue()" or "getValues()" to get the value(s) entered by the user. Use the tool's "showDialog()" to display the dialog.- Parameters:
dialogTitle
- used as the name of the dialog's title barlabel
- value to use for the label of the text field
-
InputDialog
public InputDialog(java.lang.String dialogTitle, java.lang.String label, java.lang.String initialValue)
Creates a generic input dialog with the specified title, a text field, labeled by the specified label. The user should check the value of "isCanceled()" to know whether or not the user canceled the operation. Otherwise, use the "getValue()" or "getValues()" to get the value(s) entered by the user. Use the tool's "showDialog()" to display the dialog.- Parameters:
dialogTitle
- used as the name of the dialog's title barlabel
- value to use for the label of the text fieldinitialValue
- initial value to use for the text field
-
InputDialog
public InputDialog(java.lang.String dialogTitle, java.lang.String label, java.lang.String initialValue, InputDialogListener listener)
Creates a generic input dialog with the specified title, a text field, labeled by the specified label. The user should check the value of "isCanceled()" to know whether or not the user canceled the operation. Otherwise, use the "getValue()" or "getValues()" to get the value(s) entered by the user. Use the tool's "showDialog()" to display the dialog.- Parameters:
dialogTitle
- used as the name of the dialog's title barlabel
- value to use for the label of the text fieldinitialValue
- initial value to use for the text fieldlistener
- the dialog listener (may be null)
-
InputDialog
public InputDialog(java.lang.String dialogTitle, java.lang.String label, java.lang.String initialValue, boolean isModal)
Creates a generic input dialog with the specified title, a text field, labeled by the specified label. The user should check the value of "isCanceled()" to know whether or not the user canceled the operation. Otherwise, use the "getValue()" or "getValues()" to get the value(s) entered by the user. Use the tool's "showDialog()" to display the dialog.- Parameters:
dialogTitle
- used as the name of the dialog's title barlabel
- value to use for the label of the text fieldinitialValue
- initial value to use for the text fieldisModal
- whether or not the dialog is to be modal
-
InputDialog
public InputDialog(java.lang.String dialogTitle, java.lang.String[] labels, java.lang.String[] initialValues)
Creates a generic input dialog with the specified title, a text field, labeled by the specified label. The user should check the value of "isCanceled()" to know whether or not the user canceled the operation. Otherwise, use the "getValue()" or "getValues()" to get the value(s) entered by the user. Use the tool's "showDialog()" to display the dialog.- Parameters:
dialogTitle
- used as the name of the dialog's title barlabels
- values to use for the labels of the text fieldsinitialValues
- initial values to use for the text fields
-
InputDialog
public InputDialog(java.lang.String dialogTitle, java.lang.String[] labels, java.lang.String[] initialValues, InputDialogListener listener)
Creates a generic input dialog with the specified title, a text field, labeled by the specified label. The user should check the value of "isCanceled()" to know whether or not the user canceled the operation. Otherwise, use the "getValue()" or "getValues()" to get the value(s) entered by the user. Use the tool's "showDialog()" to display the dialog.- Parameters:
dialogTitle
- used as the name of the dialog's title barlabels
- values to use for the labels of the text fieldsinitialValues
- initial values to use for the text fieldslistener
- listener that is called when the OK button is hit
-
-
Method Detail
-
okCallback
protected void okCallback()
Description copied from class:DialogComponentProvider
The callback method for when the "OK" button is pressed.- Overrides:
okCallback
in classDialogComponentProvider
-
cancelCallback
protected void cancelCallback()
Description copied from class:DialogComponentProvider
The callback method for when the "Cancel" button is pressed. The default behavior is to call setVisible(false) and dispose() on the dialog.- Overrides:
cancelCallback
in classDialogComponentProvider
-
isCanceled
public boolean isCanceled()
Returns if this dialog is cancelled- Returns:
- true if cancelled
-
getValue
public java.lang.String getValue()
Return the value of the first (and maybe only) text field- Returns:
- the text field value
-
setValue
public void setValue(java.lang.String text)
Sets the text of the primary text field- Parameters:
text
- the text
-
setValue
public void setValue(java.lang.String text, int index)
Sets the text of the text field at the given index- Parameters:
text
- the textindex
- the index of the text field
-
getValues
public java.lang.String[] getValues()
Return the values for all the text field(s)- Returns:
- the text field values
-
-