Class InputDialog

    • 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 bar
        label - 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 bar
        label - value to use for the label of the text field
        initialValue - 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 bar
        label - value to use for the label of the text field
        initialValue - initial value to use for the text field
        listener - 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 bar
        label - value to use for the label of the text field
        initialValue - initial value to use for the text field
        isModal - 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 bar
        labels - values to use for the labels of the text fields
        initialValues - 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 bar
        labels - values to use for the labels of the text fields
        initialValues - initial values to use for the text fields
        listener - listener that is called when the OK button is hit
    • Method Detail

      • 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 class DialogComponentProvider
      • 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 text
        index - 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