/**
   * Displays an information bubble that alerts the user that a mandatory operator parameter was not
   * set and had no default value. The bubble is located at the operator and the process view will
   * change to said operator. This method is used after the error occurred during process execution.
   *
   * @param op the operator for which to display the error
   * @param param the parameter for which to display the error
   * @param i18nKey the i18n key which defines the title, text and button label for the bubble.
   *     Format is "gui.bubble.{i18nKey}.title", "gui.bubble.{i18nKey}.body" and
   *     "gui.bubble.{i18nKey}.button.label".
   * @param isError if {@code true}, an error bubble will be shown; otherwise a warning bubble is
   *     displayed
   * @param arguments optional i18n arguments
   * @return the {@link OperatorInfoBubble} instance, never {@code null}
   */
  private static OperatorInfoBubble displayMissingMandatoryParameterInformation(
      final Operator op,
      final ParameterType param,
      final boolean isError,
      final String i18nKey,
      final Object... arguments) {
    final JButton ackButton =
        new JButton(I18N.getGUIMessage("gui.bubble." + i18nKey + ".button.label", arguments));
    ackButton.setToolTipText(I18N.getGUIMessage("gui.bubble." + i18nKey + ".button.tip"));

    ParameterErrorBubbleBuilder builder =
        new ParameterErrorBubbleBuilder(
            RapidMinerGUI.getMainFrame(),
            op,
            param,
            "mandatory_parameter_decoration",
            i18nKey,
            arguments);
    final OperatorInfoBubble missingParameterBubble =
        builder
            .setHideOnDisable(true)
            .setAlignment(AlignedSide.BOTTOM)
            .setStyle(isError ? BubbleStyle.ERROR : BubbleStyle.WARNING)
            .setEnsureVisible(true)
            .hideCloseButton()
            .setHideOnProcessRun(true)
            .setAdditionalComponents(new JComponent[] {ackButton})
            .build();

    ackButton.addActionListener(
        new ActionListener() {

          @Override
          public void actionPerformed(ActionEvent e) {
            missingParameterBubble.killBubble(true);
          }
        });

    missingParameterBubble.setVisible(true);
    return missingParameterBubble;
  }
  /**
   * Displays an information bubble pointing to an operator to indicate a {@link UserError} was
   * thrown by that operator.
   *
   * @param error the error instance
   * @param i18nKey the i18n key which defines the title, text and button label for the bubble.
   *     Format is "gui.bubble.{i18nKey}.title", "gui.bubble.{i18nKey}.body" and
   *     "gui.bubble.{i18nKey}.button.label".
   * @return the {@link OperatorInfoBubble} instance, never {@code null}
   */
  private static OperatorInfoBubble displayGenericUserError(
      final UserError error, final String i18nKey) {
    final JButton ackButton =
        new JButton(I18N.getGUIMessage("gui.bubble." + i18nKey + ".button.label"));
    ackButton.setToolTipText(I18N.getGUIMessage("gui.bubble." + i18nKey + ".button.tip"));

    final BubbleDelegator bubbleDelegator = new BubbleDelegator();
    final String message = removeTerminationCharacters(error.getMessage());
    final JPanel linkPanel = new JPanel();
    LinkButton showDetailsButton =
        new LinkButton(
            new ResourceAction(i18nKey + ".button_show_details") {

              private static final long serialVersionUID = 1L;

              @Override
              public void actionPerformed(final ActionEvent e) {
                BubbleWindow bubble = bubbleDelegator.getBubble();
                if (bubble != null) {
                  String text =
                      I18N.getMessage(
                          I18N.getGUIBundle(),
                          "gui.bubble." + i18nKey + ".body",
                          message,
                          error.getDetails());
                  bubble.setMainText(text);

                  linkPanel.removeAll();
                  bubble.pack();
                }
              }
            });
    showDetailsButton.setToolTipText(
        I18N.getGUIMessage("gui.action." + i18nKey + ".button_show_details.tip"));
    linkPanel.add(showDetailsButton);

    OperatorBubbleBuilder builder =
        new OperatorBubbleBuilder(
            RapidMinerGUI.getMainFrame(), error.getOperator(), i18nKey, message, "");
    // if no operator or root operator, show in middle, otherwise below
    AlignedSide prefSide =
        error.getOperator() == null || error.getOperator() instanceof ProcessRootOperator
            ? AlignedSide.MIDDLE
            : AlignedSide.BOTTOM;
    final OperatorInfoBubble userErrorBubble =
        builder
            .setHideOnDisable(true)
            .setAlignment(prefSide)
            .setStyle(BubbleStyle.ERROR)
            .setEnsureVisible(true)
            .hideCloseButton()
            .setHideOnProcessRun(true)
            .setAdditionalComponents(new JComponent[] {ackButton, linkPanel})
            .build();
    ackButton.addActionListener(
        new ActionListener() {

          @Override
          public void actionPerformed(ActionEvent e) {
            userErrorBubble.killBubble(true);
          }
        });
    bubbleDelegator.setBubbleWindow(userErrorBubble);

    userErrorBubble.setVisible(true);
    return userErrorBubble;
  }
  /**
   * Displays a warning bubble that alerts the user that a mandatory parameter of an operator has no
   * value and no default value. The bubble is located at the operator and the process view will
   * change to said port.
   *
   * @param op the operator for which to display the warning
   * @param param the parameter for which to display the warning
   * @param i18nKey the i18n key which defines the title, text and button label for the bubble.
   *     Format is "gui.bubble.{i18nKey}.title", "gui.bubble.{i18nKey}.body" and
   *     "gui.bubble.{i18nKey}.button.label".
   * @param isError if {@code true}, an error bubble will be shown; otherwise a warning bubble is
   *     displayed
   * @param arguments optional i18n arguments
   * @return the {@link OperatorInfoBubble} instance, never {@code null}
   */
  private static OperatorInfoBubble displayPrecheckMissingParameterWarning(
      final Operator op,
      final ParameterType param,
      final boolean isError,
      final String i18nKey,
      final Object... arguments) {
    final BubbleDelegator bubbleDelegator = new BubbleDelegator();
    ResourceAction runAnywayAction =
        new ResourceAction(i18nKey + ".button_run_anyway", "F11") {

          private static final long serialVersionUID = 1L;

          @Override
          public void actionPerformed(final ActionEvent e) {
            BubbleWindow bubble = bubbleDelegator.getBubble();
            if (bubble != null) {
              bubble.killBubble(true);
            }

            // run process without checking for problems
            RapidMinerGUI.getMainFrame().runProcess(false);
          }
        };
    LinkButton runAnywayButton = new LinkButton(runAnywayAction);
    runAnywayButton.setToolTipText(
        I18N.getGUIMessage("gui.bubble." + i18nKey + ".button_run_anyway.tip"));
    runAnywayButton.registerKeyboardAction(
        runAnywayAction,
        KeyStroke.getKeyStroke(KeyEvent.VK_F11, 0),
        JComponent.WHEN_IN_FOCUSED_WINDOW);

    final JButton ackButton =
        new JButton(I18N.getGUIMessage("gui.bubble." + i18nKey + ".button.label", arguments));
    ackButton.setToolTipText(I18N.getGUIMessage("gui.bubble." + i18nKey + ".button.tip"));

    ParameterErrorBubbleBuilder builder =
        new ParameterErrorBubbleBuilder(
            RapidMinerGUI.getMainFrame(),
            op,
            param,
            "mandatory_parameter_decoration",
            i18nKey,
            arguments);
    final OperatorInfoBubble missingParameterBubble =
        builder
            .setHideOnDisable(true)
            .setAlignment(AlignedSide.BOTTOM)
            .setStyle(isError ? BubbleStyle.ERROR : BubbleStyle.WARNING)
            .setEnsureVisible(true)
            .hideCloseButton()
            .setHideOnProcessRun(true)
            .setAdditionalComponents(new JComponent[] {ackButton, runAnywayButton})
            .build();
    ackButton.addActionListener(
        new ActionListener() {

          @Override
          public void actionPerformed(ActionEvent e) {
            missingParameterBubble.killBubble(true);
          }
        });
    bubbleDelegator.setBubbleWindow(missingParameterBubble);

    missingParameterBubble.setVisible(true);
    return missingParameterBubble;
  }
  /**
   * Displays an information bubble pointing to an ExecuteProcess operator to indicate a {@link
   * UserError} occurred inside the process executed by the operator.
   *
   * @param error the error instance
   * @param i18nKey the i18n key which defines the title, text and button label for the bubble.
   *     Format is "gui.bubble.{i18nKey}.title", "gui.bubble.{i18nKey}.body" and
   *     "gui.bubble.{i18nKey}.button.label".
   * @param arguments optional i18n arguments
   * @return the {@link OperatorInfoBubble} instance, never {@code null}
   */
  private static OperatorInfoBubble displayUserErrorInExecutedProcess(
      final ProcessExecutionUserErrorError error, final String i18nKey, final Object... arguments) {
    final JButton ackButton =
        new JButton(I18N.getGUIMessage("gui.bubble." + i18nKey + ".button.label", arguments));
    ackButton.setToolTipText(I18N.getGUIMessage("gui.bubble." + i18nKey + ".button.tip"));

    final BubbleDelegator bubbleDelegator = new BubbleDelegator();
    LinkButton showDetailsButton =
        new LinkButton(
            new ResourceAction(i18nKey + ".button_show_details") {

              private static final long serialVersionUID = 1L;

              @Override
              public void actionPerformed(final ActionEvent e) {
                if (RapidMinerGUI.getMainFrame().close(true)) {
                  // kill bubble
                  BubbleWindow bubble = bubbleDelegator.getBubble();
                  if (bubble != null) {
                    bubble.killBubble(true);
                  }

                  // open process which caused the error
                  Operator op = error.getUserError().getOperator();
                  final Process causingProcess = op.getProcess();
                  RapidMinerGUI.getMainFrame()
                      .setOpenedProcess(
                          causingProcess, false, causingProcess.getProcessLocation().toString());

                  // show new error bubble in the newly opened process
                  displayBubbleForUserError(error.getUserError());
                }
              }
            });
    showDetailsButton.setToolTipText(
        I18N.getGUIMessage("gui.action." + i18nKey + ".button_show_details.tip"));

    OperatorBubbleBuilder builder =
        new OperatorBubbleBuilder(
            RapidMinerGUI.getMainFrame(), error.getOperator(), i18nKey, arguments);
    final OperatorInfoBubble userErrorBubble =
        builder
            .setHideOnDisable(true)
            .setHideOnProcessRun(true)
            .setAlignment(AlignedSide.BOTTOM)
            .setStyle(BubbleStyle.ERROR)
            .setEnsureVisible(true)
            .hideCloseButton()
            .setHideOnProcessRun(true)
            .setAdditionalComponents(new JComponent[] {ackButton, showDetailsButton})
            .build();
    ackButton.addActionListener(
        new ActionListener() {

          @Override
          public void actionPerformed(ActionEvent e) {
            userErrorBubble.killBubble(true);
          }
        });
    bubbleDelegator.setBubbleWindow(userErrorBubble);

    userErrorBubble.setVisible(true);
    return userErrorBubble;
  }