Interface DialogFactory

  • All Known Implementing Classes:
    AbstractDialogFactory, AutoCloseDialogFactory, DefaultDialogFactory

    public interface DialogFactory
    This is an interface for factory classes used for creating and showing various types of dialog boxes containing messages, information, questions, etc.
    Version:
    1.0
    Author:
    Ivan Pribela
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean askConfirmation​(java.awt.Component component, java.lang.String text)
      Displays confirmation message box containing desired message, and asking from the user to answer {code Yes} or No.
      java.lang.Boolean askConfirmationWithCancel​(java.awt.Component component, java.lang.String text)
      Displays confirmation message box containing desired message, and asking from the user to answer Yes, No or Cancel.
      LoginData askLogin​(java.awt.Component component, java.lang.String text)
      Displays login dialog box containing desired message, and asking for user name and password.
      LoginData askLogin​(java.awt.Component component, java.lang.String text, java.lang.String username)
      Displays login dialog box containing desired message, and asking for user name and password.
      char[] askPassword​(java.awt.Component component, java.lang.String text)
      Displays password dialog box containing desired message, and asking from the user to enter password.
      java.lang.String askQuestion​(java.awt.Component component, java.lang.String text)
      Displays question message box containing desired question, and asking the user to enter the answer.
      java.lang.Object askQuestion​(java.awt.Component component, java.lang.String text, java.lang.Object[] options, java.lang.Object defaultOption)
      Displays question message box containing desired question, and asking the user to choose one of the provided options.
      java.lang.String askQuestion​(java.awt.Component component, java.lang.String text, java.lang.String answer)
      Displays question message box containing desired question, and asking the user to enter the answer.
      javax.swing.Icon getIcon​(java.lang.String type)
      Returns a dialog icon of the desired type.
      boolean showDialog​(java.awt.Component component, java.awt.Component content, java.lang.String title, javax.swing.Icon icon)
      Displays a dialog with the given icon and title containing the supplied component.
      <T> T showDialog​(java.awt.Component component, DialogContent<T> content, java.lang.String title, javax.swing.Icon icon)
      Displays a dialog with the given icon and title containing the supplied content.
      void showError​(java.awt.Component component, java.lang.String text)
      Displays error message box containing desired message.
      void showError​(java.awt.Component component, java.lang.String text, java.lang.Throwable th)
      Displays error message box containing desired message and optionally stack-trace of the supplied exception.
      void showException​(java.awt.Component component, java.lang.Throwable th)
      Displays error message box containing stack-trace of the supplied exception.
      void showInformation​(java.awt.Component component, java.lang.String text)
      Displays informational message box containing desired message.
      void showMessage​(java.awt.Component component, java.lang.String text)
      Displays message box containing desired message.
      void showWarning​(java.awt.Component component, java.lang.String text)
      Displays warning message box containing desired message.
    • Method Detail

      • showMessage

        void showMessage​(java.awt.Component component,
                         java.lang.String text)
        Displays message box containing desired message.
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        text - text which will be displayed in the message box.
      • showInformation

        void showInformation​(java.awt.Component component,
                             java.lang.String text)
        Displays informational message box containing desired message.
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        text - text which will be displayed in the message box.
      • showWarning

        void showWarning​(java.awt.Component component,
                         java.lang.String text)
        Displays warning message box containing desired message.
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        text - text which will be displayed in the message box.
      • showError

        void showError​(java.awt.Component component,
                       java.lang.String text)
        Displays error message box containing desired message.
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        text - text which will be displayed in the message box.
      • showError

        void showError​(java.awt.Component component,
                       java.lang.String text,
                       java.lang.Throwable th)
        Displays error message box containing desired message and optionally stack-trace of the supplied exception.
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        text - text which will be displayed in the message box.
        th - exception which is used to build up the stack-trace information.
      • showException

        void showException​(java.awt.Component component,
                           java.lang.Throwable th)
        Displays error message box containing stack-trace of the supplied exception.
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        th - exception which is used to build up the stack-trace information.
      • askConfirmation

        boolean askConfirmation​(java.awt.Component component,
                                java.lang.String text)
        Displays confirmation message box containing desired message, and asking from the user to answer {code Yes} or No.
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        text - text which will be displayed in the message box.
        Returns:
        true if user answered yes; false otherwise.
      • askConfirmationWithCancel

        java.lang.Boolean askConfirmationWithCancel​(java.awt.Component component,
                                                    java.lang.String text)
        Displays confirmation message box containing desired message, and asking from the user to answer Yes, No or Cancel.
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        text - text which will be displayed in the message box.
        Returns:
        true if user answered yes; false if user answered no; and null otherwise.
      • askQuestion

        java.lang.String askQuestion​(java.awt.Component component,
                                     java.lang.String text)
        Displays question message box containing desired question, and asking the user to enter the answer.
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        text - text which will be displayed in the message box.
        Returns:
        String containing text that user entered; null if user has chosen not to answer.
      • askQuestion

        java.lang.String askQuestion​(java.awt.Component component,
                                     java.lang.String text,
                                     java.lang.String answer)
        Displays question message box containing desired question, and asking the user to enter the answer.
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        text - text which will be displayed in the message box.
        answer - the initial answer for user to modify.
        Returns:
        String containing text that user entered; null if user has chosen not to answer.
      • askQuestion

        java.lang.Object askQuestion​(java.awt.Component component,
                                     java.lang.String text,
                                     java.lang.Object[] options,
                                     java.lang.Object defaultOption)
        Displays question message box containing desired question, and asking the user to choose one of the provided options.
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        text - text which will be displayed in the message box.
        options - list of available options for the user to choose from.
        defaultOption - initial option that is to be selected.
        Returns:
        one of the options provided or null if user has chosen not to answer.
      • askPassword

        char[] askPassword​(java.awt.Component component,
                           java.lang.String text)
        Displays password dialog box containing desired message, and asking from the user to enter password.
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        text - text which will be displayed in the dialog box.
        Returns:
        password entered by the user as an array of char; null if user has chosen not to enter the password.
      • askLogin

        LoginData askLogin​(java.awt.Component component,
                           java.lang.String text)
        Displays login dialog box containing desired message, and asking for user name and password.
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        text - text which will be displayed in the dialog box.
        Returns:
        user data (user name and password) stored in LoginData object; null if user has chosen not to enter login data.
      • askLogin

        LoginData askLogin​(java.awt.Component component,
                           java.lang.String text,
                           java.lang.String username)
        Displays login dialog box containing desired message, and asking for user name and password.
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        text - text which will be displayed in the dialog box.
        username - default user name.
        Returns:
        user data (user name and password) stored in LoginData object; null if user has chosen not to enter login information.
      • showDialog

        boolean showDialog​(java.awt.Component component,
                           java.awt.Component content,
                           java.lang.String title,
                           javax.swing.Icon icon)
        Displays a dialog with the given icon and title containing the supplied component.
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        content - the component to display on the dialog
        title - title of the dialog
        icon - icon to display on the dialog
        Returns:
        true if user answered ok; false otherwise.
      • showDialog

        <T> T showDialog​(java.awt.Component component,
                         DialogContent<T> content,
                         java.lang.String title,
                         javax.swing.Icon icon)
        Displays a dialog with the given icon and title containing the supplied content.
        Type Parameters:
        T - type of dialog content
        Parameters:
        component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used.
        content - the component to display on the dialog
        title - title of the dialog
        icon - icon to display on the dialog
        Returns:
        The object retrieved from the content component if user answered ok; null otherwise.
      • getIcon

        javax.swing.Icon getIcon​(java.lang.String type)
        Returns a dialog icon of the desired type.
        Parameters:
        type - determines which icon to return: "question", "warning", "error", or other
        Returns:
        Returns a dialog icon of the given type.