Package com.zerog.ia.auto.project.console

Class ShowMessageConsole

  • All Implemented Interfaces:
    Referenceable
    public final class ShowMessageConsole
extends Action
    Displays a message and request the end user to take a decision. The decision options are customizable and the option selected by the user is stored in a custom variable.

    To define the number of options to display, set the optionsToDisplay property. To customize the labels and actions of each option, set the corresponding property (e.g. option0Label, option0Action, option1Label, ...)

    • Constructor Detail

      • ShowMessageConsole

        public ShowMessageConsole()

    • Method Detail

      • setTitle

        public void setTitle​(java.lang.String title)
        Defines the title of the panel.

      • getTitle

        public java.lang.String getTitle()
        Returns the title of the panel.

      • setMessage

        public void setMessage​(java.lang.String message)
        Defines the message to be displayed to the end user.

      • getMessage

        public java.lang.String getMessage()
        Returns the message to be displayed to the end user.

      • setOptionsToDisplay

        public void setOptionsToDisplay​(DialogButtons buttonsToDisplay)
        Defines the set of options to display. The panel can display 1, 2 or 3 options.

      • getOptionsToDisplay

        public DialogButtons getOptionsToDisplay()
        Returns the set of options to display.

      • setOption0Label

        public void setOption0Label​(java.lang.String label)
        The label of option 0. Default is "OK".

      • getOption0Label

        public java.lang.String getOption0Label()
        The label of option 0.

      • setOption0Action

        public void setOption0Action​(DialogButtonAction action)
        The action to take if end user chooses the option 0.

      • getOption0Action

        public DialogButtonAction getOption0Action()
        The action to take if end user chooses the option 0.

      • setOption1Label

        public void setOption1Label​(java.lang.String label)
        The label of option 1. Default is "Cancel".

      • getOption1Label

        public java.lang.String getOption1Label()
        The label of option 1.

      • setOption1Action

        public void setOption1Action​(DialogButtonAction action)
        The action to take if end user chooses the option 1.

      • getOption1Action

        public DialogButtonAction getOption1Action()
        The action to take if end user chooses the option 1.

      • setOption2Label

        public void setOption2Label​(java.lang.String label)
        The label of option 2. Default is "Details...".

      • getOption2Label

        public java.lang.String getOption2Label()
        The label of option 2.

      • setOption2Action

        public void setOption2Action​(DialogButtonAction action)
        The action to take if end user chooses the option 2.

      • getOption2Action

        public DialogButtonAction getOption2Action()
        The action to take if end user chooses the option 2.

      • setResultsVariable

        public void setResultsVariable​(java.lang.String resultsVariable)
        Defines the name of the variable where to store the option chose by the end user. Default is "$PROMPT_USER_CHOSEN_OPTION$".

      • getResultsVariable

        public java.lang.String getResultsVariable()
        Returns the name of the variable where to store the option chose by the end user.