Package org.processmining.framework.util.ui.widgets.helper

Class ProMUIHelper

  • public class ProMUIHelper
extends java.lang.Object
    Commonly used functionality for the ProM UI as static helper methods. All methods throw UserCancelledException when the user presses the cancel button.
    Author:
    F. Mannhardt

    • Constructor Summary

      Constructors 
      Constructor Description
      ProMUIHelper()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static double queryForDouble​(java.awt.Component view, java.lang.String query)  
      static double queryForDouble​(java.awt.Component view, java.lang.String query, double min, double max, double defaultValue)  
      static double queryForDouble​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query)
      Displays a configuration dialog asking the user to enter a Double, uses Double.parseDouble(String) to convert the user input.
      static double queryForDouble​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query, double min, double max, double defaultValue)
      Displays a configuration dialog asking the user to select a double value.
      static double queryForDoubleZeroOne​(java.awt.Component view, java.lang.String query)  
      static double queryForDoubleZeroOne​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query)
      Displays a configuration dialog asking the user to select a double value between 0.0 and 1.0 (both inclusive).
      static float queryForFloat​(java.awt.Component view, java.lang.String query)  
      static float queryForFloat​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query)
      Displays a configuration dialog asking the user to enter a Float, uses Float.parseFloat(String) to convert the user input.
      static int[] queryForIntArray​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query)
      Shows a dialog asking the user to enter an ordered list of integers separated by comma.
      static int queryForInteger​(java.awt.Component view, java.lang.String query)  
      static int queryForInteger​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query)
      Displays a configuration dialog asking the user to enter a Integer, uses Integer.parseInt(String) to convert the user input.
      static java.lang.String queryForMultilineString​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String queryCaption)
      Shows a dialog with a multi-line text area, and returns the entered value.
      static java.lang.String queryForMultilineString​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String queryCaption, java.lang.String defaultText)
      Shows a dialog with a multi-line text area, and returns the entered value.
      static <T> T queryForObject​(java.awt.Component view, java.lang.String query, java.lang.Iterable<T> choices)  
      static <T> T queryForObject​(java.awt.Component view, java.lang.String query, T[] choices)  
      static <T> T queryForObject​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query, java.lang.Iterable<T> choices)
      Shows a dialog with a combo box containing the choices, and returns the selected value.
      static <T> T queryForObject​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query, T[] choices)
      Shows a dialog with a combo box containing the choices, and returns the selected value.
      static <T> java.util.List<T> queryForObjects​(java.awt.Component view, java.lang.String query, java.lang.Iterable<T> choices)  
      static <T> java.util.List<T> queryForObjects​(java.awt.Component view, java.lang.String query, T[] choices)  
      static <T> java.util.List<T> queryForObjects​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query, java.lang.Iterable<T> choices)
      Shows a dialog with a selection list that allow multi-selection.
      static <T> java.util.List<T> queryForObjects​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query, T[] choices)
      Shows a dialog with a selection list that allow multi-selection.
      static java.lang.String queryForString​(java.awt.Component view, java.lang.String queryCaption)  
      static java.lang.String queryForString​(java.awt.Component view, java.lang.String query, java.lang.Iterable<java.lang.String> choices)  
      static java.lang.String queryForString​(java.awt.Component view, java.lang.String queryCaption, java.lang.String queryText)  
      static java.lang.String queryForString​(java.awt.Component view, java.lang.String query, java.lang.String[] choices)  
      static java.lang.String queryForString​(java.awt.Component view, java.lang.String queryCaption, java.lang.String queryText, java.lang.String defaultValue)  
      static java.lang.String queryForString​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String queryCaption)
      Displays a configuration dialog asking the user to enter a String literal.
      static java.lang.String queryForString​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query, java.lang.Iterable<java.lang.String> choices)
      Shows a dialog with a combo box containing the choices, and returns the selected value.
      static java.lang.String queryForString​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String queryCaption, java.lang.String queryText)
      Displays a configuration dialog asking the user to enter a String literal
      static java.lang.String queryForString​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query, java.lang.String[] choices)
      Shows a dialog with a combo box containing the choices, and returns the selected value.
      static java.lang.String queryForString​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String queryCaption, java.lang.String queryText, java.lang.String defaultValue)
      Displays a configuration dialog asking the user to enter a String literal
      static java.util.List<java.lang.String> queryForStrings​(java.awt.Component view, java.lang.String query, java.lang.Iterable<java.lang.String> choices)  
      static java.util.List<java.lang.String> queryForStrings​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query, java.lang.Iterable<java.lang.String> choices)
      Shows a dialog with a selection list that allow multi-selection.
      static java.util.List<java.lang.String> queryForStrings​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query, java.lang.String[] choices)
      Shows a dialog with a selection list that allow multi-selection.
      static <S,​T>
      java.util.Map<S,​T>      		 queryMapToObject​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query, java.lang.Iterable<S> keys, java.lang.Iterable<T> values)
      Shows a dialog to the user with a two-column table.
      static <S,​T>
      java.util.Map<S,​T>      		 queryMapToObject​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query, java.lang.Iterable<S> keys, java.lang.Iterable<T> values, java.util.Map<S,​T> defaultMap)
      Shows a dialog to the user with a two-column table.
      static <T> java.util.Map<T,​java.lang.String> queryMapToString​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query, java.lang.Iterable<T> keys)
      Shows a dialog to the user with a two-column table.
      static <T> java.util.Map<T,​java.lang.String> queryMapToString​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query, java.lang.Iterable<T> keys, java.util.Map<T,​java.lang.String> defaultValues)
      Shows a dialog to the user with a two-column table.
      static <T> java.util.Map<T,​java.lang.String> queryMapToString​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query, T[] keys)
      Shows a dialog to the user with a two-column table.
      static <T> java.util.Map<T,​java.lang.String> queryMapToString​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String query, T[] keys, java.util.Map<T,​java.lang.String> defaultValues)
      Shows a dialog to the user with a two-column table.
      static void showErrorMessage​(java.awt.Component component, java.lang.String errorMessage, java.lang.String errorTitle)
      Displays an error message in a 'modal' pop-up using the specified Component as parent.
      static void showErrorMessage​(java.awt.Component component, java.lang.String errorMessage, java.lang.String errorTitle, java.lang.Throwable e)  
      static void showErrorMessage​(java.lang.String errorMessage, java.lang.String errorTitle)
      Displays an error message in a 'modal' pop-up using a default JFrame.
      static void showErrorMessage​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String errorMessage, java.lang.String errorTitle)
      Displays an error message in a 'modal' pop-up using the global UI as parent JFrame.
      static void showWarningMessage​(java.awt.Component component, java.lang.String warnMessage, java.lang.String warnTitle)
      Displays an warning message in a 'modal' pop-up using using the specified Component as parent.
      static void showWarningMessage​(java.lang.String warnMessage, java.lang.String warnTitle)
      Displays an warning message in a 'modal' pop-up using a default JFrame.
      static void showWarningMessage​(org.processmining.contexts.uitopia.UIPluginContext context, java.lang.String warnMessage, java.lang.String warnTitle)
      Displays an warning message in a 'modal' pop-up using the global UI as parent JFrame.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ProMUIHelper

        public ProMUIHelper()

    • Method Detail

      • showErrorMessage

        public static void showErrorMessage​(org.processmining.contexts.uitopia.UIPluginContext context,
                                    java.lang.String errorMessage,
                                    java.lang.String errorTitle)
        Displays an error message in a 'modal' pop-up using the global UI as parent JFrame.
        Parameters:
        context -
        errorMessage -
        errorTitle -

      • showErrorMessage

        public static void showErrorMessage​(java.lang.String errorMessage,
                                    java.lang.String errorTitle)
        Displays an error message in a 'modal' pop-up using a default JFrame.
        Parameters:
        errorMessage -
        errorTitle -

      • showErrorMessage

        public static void showErrorMessage​(java.awt.Component component,
                                    java.lang.String errorMessage,
                                    java.lang.String errorTitle)
        Displays an error message in a 'modal' pop-up using the specified Component as parent.
        Parameters:
        component -
        errorMessage -
        errorTitle -

      • showErrorMessage

        public static void showErrorMessage​(java.awt.Component component,
                                    java.lang.String errorMessage,
                                    java.lang.String errorTitle,
                                    java.lang.Throwable e)

      • showWarningMessage

        public static void showWarningMessage​(org.processmining.contexts.uitopia.UIPluginContext context,
                                      java.lang.String warnMessage,
                                      java.lang.String warnTitle)
        Displays an warning message in a 'modal' pop-up using the global UI as parent JFrame.
        Parameters:
        context -
        warnMessage -
        warnTitle -

      • showWarningMessage

        public static void showWarningMessage​(java.lang.String warnMessage,
                                      java.lang.String warnTitle)
        Displays an warning message in a 'modal' pop-up using a default JFrame.
        Parameters:
        warnMessage -
        warnTitle -

      • showWarningMessage

        public static void showWarningMessage​(java.awt.Component component,
                                      java.lang.String warnMessage,
                                      java.lang.String warnTitle)
        Displays an warning message in a 'modal' pop-up using using the specified Component as parent.
        Parameters:
        component -
        warnMessage -
        warnTitle -

      • queryForString

        public static java.lang.String queryForString​(org.processmining.contexts.uitopia.UIPluginContext context,
                                              java.lang.String queryCaption)
                                       throws UserCancelledException
        Displays a configuration dialog asking the user to enter a String literal.
        Parameters:
        context -
        queryCaption -
        Returns:
        Throws:
        UserCancelledException

      • queryForString

        public static java.lang.String queryForString​(org.processmining.contexts.uitopia.UIPluginContext context,
                                              java.lang.String queryCaption,
                                              java.lang.String queryText)
                                       throws UserCancelledException
        Displays a configuration dialog asking the user to enter a String literal
        Parameters:
        context -
        queryCaption -
        queryText -
        Returns:
        Throws:
        UserCancelledException

      • queryForString

        public static java.lang.String queryForString​(org.processmining.contexts.uitopia.UIPluginContext context,
                                              java.lang.String queryCaption,
                                              java.lang.String queryText,
                                              java.lang.String defaultValue)
                                       throws UserCancelledException
        Displays a configuration dialog asking the user to enter a String literal
        Parameters:
        context -
        queryCaption -
        queryText -
        defaultValue -
        Returns:
        Throws:
        UserCancelledException

      • queryForString

        public static java.lang.String queryForString​(java.awt.Component view,
                                              java.lang.String queryCaption,
                                              java.lang.String queryText,
                                              java.lang.String defaultValue)
                                       throws UserCancelledException
        Throws:
        UserCancelledException

      • queryForInteger

        public static int queryForInteger​(org.processmining.contexts.uitopia.UIPluginContext context,
                                  java.lang.String query)
                           throws java.lang.NumberFormatException,
                                  UserCancelledException
        Displays a configuration dialog asking the user to enter a Integer, uses Integer.parseInt(String) to convert the user input.
        Parameters:
        context -
        query -
        Returns:
        Throws:
        java.lang.NumberFormatException
        UserCancelledException

      • queryForInteger

        public static int queryForInteger​(java.awt.Component view,
                                  java.lang.String query)
                           throws java.lang.NumberFormatException,
                                  UserCancelledException
        Throws:
        java.lang.NumberFormatException
        UserCancelledException

      • queryForFloat

        public static float queryForFloat​(org.processmining.contexts.uitopia.UIPluginContext context,
                                  java.lang.String query)
                           throws java.lang.NumberFormatException,
                                  UserCancelledException
        Displays a configuration dialog asking the user to enter a Float, uses Float.parseFloat(String) to convert the user input.
        Parameters:
        context -
        query -
        Returns:
        Throws:
        java.lang.NumberFormatException
        UserCancelledException

      • queryForFloat

        public static float queryForFloat​(java.awt.Component view,
                                  java.lang.String query)
                           throws java.lang.NumberFormatException,
                                  UserCancelledException
        Throws:
        java.lang.NumberFormatException
        UserCancelledException

      • queryForDouble

        public static double queryForDouble​(org.processmining.contexts.uitopia.UIPluginContext context,
                                    java.lang.String query)
                             throws java.lang.NumberFormatException,
                                    UserCancelledException
        Displays a configuration dialog asking the user to enter a Double, uses Double.parseDouble(String) to convert the user input.
        Parameters:
        context -
        query -
        Returns:
        Throws:
        java.lang.NumberFormatException
        UserCancelledException

      • queryForDouble

        public static double queryForDouble​(java.awt.Component view,
                                    java.lang.String query)
                             throws java.lang.NumberFormatException,
                                    UserCancelledException
        Throws:
        java.lang.NumberFormatException
        UserCancelledException

      • queryForDoubleZeroOne

        public static double queryForDoubleZeroOne​(org.processmining.contexts.uitopia.UIPluginContext context,
                                           java.lang.String query)
                                    throws UserCancelledException
        Displays a configuration dialog asking the user to select a double value between 0.0 and 1.0 (both inclusive). The default value is 1.0.
        Parameters:
        context -
        query -
        Returns:
        Throws:
        java.lang.NumberFormatException
        UserCancelledException

      • queryForDouble

        public static double queryForDouble​(org.processmining.contexts.uitopia.UIPluginContext context,
                                    java.lang.String query,
                                    double min,
                                    double max,
                                    double defaultValue)
                             throws UserCancelledException
        Displays a configuration dialog asking the user to select a double value.
        Parameters:
        context -
        query -
        Returns:
        Throws:
        UserCancelledException

      • queryForIntArray

        public static int[] queryForIntArray​(org.processmining.contexts.uitopia.UIPluginContext context,
                                     java.lang.String query)
                              throws java.lang.NumberFormatException,
                                     UserCancelledException
        Shows a dialog asking the user to enter an ordered list of integers separated by comma.
        Parameters:
        context -
        query -
        Returns:
        Throws:
        java.lang.NumberFormatException
        UserCancelledException

      • queryForObject

        public static <T> T queryForObject​(org.processmining.contexts.uitopia.UIPluginContext context,
                                   java.lang.String query,
                                   T[] choices)
                            throws UserCancelledException
        Shows a dialog with a combo box containing the choices, and returns the selected value.
        Parameters:
        context -
        query -
        choices -
        Returns:
        Throws:
        UserCancelledException

      • queryForObject

        public static <T> T queryForObject​(org.processmining.contexts.uitopia.UIPluginContext context,
                                   java.lang.String query,
                                   java.lang.Iterable<T> choices)
                            throws UserCancelledException
        Shows a dialog with a combo box containing the choices, and returns the selected value.
        Parameters:
        context -
        query -
        choices -
        Returns:
        Throws:
        UserCancelledException

      • queryForString

        public static java.lang.String queryForString​(org.processmining.contexts.uitopia.UIPluginContext context,
                                              java.lang.String query,
                                              java.lang.String[] choices)
                                       throws UserCancelledException
        Shows a dialog with a combo box containing the choices, and returns the selected value.
        Parameters:
        context -
        query -
        choices -
        Returns:
        Throws:
        UserCancelledException

      • queryForString

        public static java.lang.String queryForString​(org.processmining.contexts.uitopia.UIPluginContext context,
                                              java.lang.String query,
                                              java.lang.Iterable<java.lang.String> choices)
                                       throws UserCancelledException
        Shows a dialog with a combo box containing the choices, and returns the selected value.
        Parameters:
        context -
        query -
        choices -
        Returns:
        Throws:
        UserCancelledException

      • queryForString

        public static java.lang.String queryForString​(java.awt.Component view,
                                              java.lang.String query,
                                              java.lang.Iterable<java.lang.String> choices)
                                       throws UserCancelledException
        Throws:
        UserCancelledException

      • queryForMultilineString

        public static java.lang.String queryForMultilineString​(org.processmining.contexts.uitopia.UIPluginContext context,
                                                       java.lang.String queryCaption)
                                                throws UserCancelledException
        Shows a dialog with a multi-line text area, and returns the entered value.
        Parameters:
        context -
        queryCaption -
        Returns:
        Throws:
        UserCancelledException

      • queryForMultilineString

        public static java.lang.String queryForMultilineString​(org.processmining.contexts.uitopia.UIPluginContext context,
                                                       java.lang.String queryCaption,
                                                       java.lang.String defaultText)
                                                throws UserCancelledException
        Shows a dialog with a multi-line text area, and returns the entered value.
        Parameters:
        context -
        queryCaption - that is shown on top of the dialog
        defaultText - that is shown in the text area
        Returns:
        Throws:
        UserCancelledException

      • queryForObjects

        public static <T> java.util.List<T> queryForObjects​(org.processmining.contexts.uitopia.UIPluginContext context,
                                                    java.lang.String query,
                                                    T[] choices)
                                             throws UserCancelledException
        Shows a dialog with a selection list that allow multi-selection.
        Parameters:
        context -
        query -
        choices -
        Returns:
        Throws:
        UserCancelledException

      • queryForObjects

        public static <T> java.util.List<T> queryForObjects​(org.processmining.contexts.uitopia.UIPluginContext context,
                                                    java.lang.String query,
                                                    java.lang.Iterable<T> choices)
                                             throws UserCancelledException
        Shows a dialog with a selection list that allow multi-selection.
        Parameters:
        context -
        query -
        choices -
        Returns:
        Throws:
        UserCancelledException

      • queryForStrings

        public static java.util.List<java.lang.String> queryForStrings​(org.processmining.contexts.uitopia.UIPluginContext context,
                                                               java.lang.String query,
                                                               java.lang.Iterable<java.lang.String> choices)
                                                        throws UserCancelledException
        Shows a dialog with a selection list that allow multi-selection.
        Parameters:
        context -
        query -
        choices -
        Returns:
        Throws:
        UserCancelledException

      • queryForStrings

        public static java.util.List<java.lang.String> queryForStrings​(java.awt.Component view,
                                                               java.lang.String query,
                                                               java.lang.Iterable<java.lang.String> choices)
                                                        throws UserCancelledException
        Throws:
        UserCancelledException

      • queryForStrings

        public static java.util.List<java.lang.String> queryForStrings​(org.processmining.contexts.uitopia.UIPluginContext context,
                                                               java.lang.String query,
                                                               java.lang.String[] choices)
                                                        throws UserCancelledException
        Shows a dialog with a selection list that allow multi-selection.
        Parameters:
        context -
        query -
        choices -
        Returns:
        Throws:
        UserCancelledException

      • queryMapToString

        public static <T> java.util.Map<T,​java.lang.String> queryMapToString​(org.processmining.contexts.uitopia.UIPluginContext context,
                                                                           java.lang.String query,
                                                                           java.lang.Iterable<T> keys)
                                                                    throws UserCancelledException
        Shows a dialog to the user with a two-column table. The first column contains the supplied keys. In the second column the user can enter the desired values. The mapping is returned as a Map.
        Parameters:
        context -
        query -
        keys -
        Returns:
        Throws:
        UserCancelledException

      • queryMapToString

        public static <T> java.util.Map<T,​java.lang.String> queryMapToString​(org.processmining.contexts.uitopia.UIPluginContext context,
                                                                           java.lang.String query,
                                                                           T[] keys)
                                                                    throws UserCancelledException
        Shows a dialog to the user with a two-column table. The first column contains the supplied keys. In the second column the user can enter the desired values. The mapping is returned as a Map.
        Parameters:
        context -
        query -
        keys -
        Returns:
        Throws:
        UserCancelledException

      • queryMapToString

        public static <T> java.util.Map<T,​java.lang.String> queryMapToString​(org.processmining.contexts.uitopia.UIPluginContext context,
                                                                           java.lang.String query,
                                                                           java.lang.Iterable<T> keys,
                                                                           java.util.Map<T,​java.lang.String> defaultValues)
                                                                    throws UserCancelledException
        Shows a dialog to the user with a two-column table. The first column contains the supplied keys. In the second column the user can enter the desired values. The mapping is returned as a Map.
        Parameters:
        context -
        query -
        keys -
        defaultValues -
        Returns:
        Throws:
        UserCancelledException

      • queryMapToString

        public static <T> java.util.Map<T,​java.lang.String> queryMapToString​(org.processmining.contexts.uitopia.UIPluginContext context,
                                                                           java.lang.String query,
                                                                           T[] keys,
                                                                           java.util.Map<T,​java.lang.String> defaultValues)
                                                                    throws UserCancelledException
        Shows a dialog to the user with a two-column table. The first column contains the supplied keys. In the second column the user can enter the desired values. The mapping is returned as a Map.
        Parameters:
        context -
        query -
        keys -
        defaultValues -
        Returns:
        Throws:
        UserCancelledException

      • queryMapToObject

        public static <S,​T> java.util.Map<S,​T> queryMapToObject​(org.processmining.contexts.uitopia.UIPluginContext context,
                                                                    java.lang.String query,
                                                                    java.lang.Iterable<S> keys,
                                                                    java.lang.Iterable<T> values)
                                                             throws UserCancelledException
        Shows a dialog to the user with a two-column table. The first column contains the supplied keys. In the second column the user can choose from a list of values. The mapping is returned as a Map.
        Parameters:
        context -
        query -
        keys -
        values -
        Returns:
        Throws:
        UserCancelledException

      • queryMapToObject

        public static <S,​T> java.util.Map<S,​T> queryMapToObject​(org.processmining.contexts.uitopia.UIPluginContext context,
                                                                    java.lang.String query,
                                                                    java.lang.Iterable<S> keys,
                                                                    java.lang.Iterable<T> values,
                                                                    java.util.Map<S,​T> defaultMap)
                                                             throws UserCancelledException
        Shows a dialog to the user with a two-column table. The first column contains the supplied keys. In the second column the user can choose from a list of values. The mapping is returned as a Map.
        Parameters:
        context -
        query -
        keys -
        values -
        defaultMap -
        Returns:
        Throws:
        UserCancelledException