com.rapiddweller.common.ui.swing.SimpleDialog Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rd-lib-common Show documentation
'rapiddweller Common' is an open source Java library forked from Databene Commons by Volker Bergmann. It provides extensions to the Java core library by utility classes, abstract concepts and concrete implementations.
There is a newer version: 2.0.1-jdk-11
Show newest version
/*
 * Copyright (C) 2004-2015 Volker Bergmann ([email protected]).
 * All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.rapiddweller.common.ui.swing;

import javax.swing.AbstractAction;
import javax.swing.Box;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JDialog;
import javax.swing.KeyStroke;
import javax.swing.border.EmptyBorder;
import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.event.ActionEvent;
import java.awt.event.KeyEvent;

/**
 * {@link JDialog} which applies useful standard behaviour.
 * Created: 22.08.2012 07:31:08
 *
 * @param  the component type to display in the dialog window
 * @author Volker Bergmann
 * @since 0.5.18
 */
@SuppressWarnings("serial")
public class SimpleDialog extends JDialog {

  /**
   * The Main component.
   */
  protected E mainComponent;
  /**
   * The Cancellable.
   */
  protected boolean cancellable;
  private final Component parentComponent;

  /**
   * The Cancelled.
   */
  protected boolean cancelled;

  /**
   * The Button bar.
   */
  protected Box buttonBar;
  /**
   * The Completed.
   */
  protected boolean completed;
  /**
   * The Cancel action.
   */
  protected AbstractAction cancelAction;
  /**
   * The Ok action.
   */
  protected AbstractAction okAction;

  /**
   * Instantiates a new Simple dialog.
   *
   * @param parentComponent the parent component
   * @param title           the title
   * @param modal           the modal
   * @param cancellable     the cancellable
   * @param mainComponent   the main component
   */
  public SimpleDialog(Component parentComponent, String title, boolean modal, boolean cancellable, E mainComponent) {
    super(SwingUtil.getWindowForComponent(parentComponent), title, (modal ? ModalityType.APPLICATION_MODAL : ModalityType.MODELESS));
    this.parentComponent = parentComponent;
    this.cancellable = cancellable;
    this.completed = false;
    this.cancelled = false;

    // Set up main component
    this.mainComponent = mainComponent;
    add(mainComponent, BorderLayout.CENTER);

    // setup actions
    this.cancelAction = new AbstractAction("Cancel") {
      @Override
      public void actionPerformed(ActionEvent e) {
        cancelled = true;
        setVisible(false);
      }
    };
    this.okAction = new AbstractAction("OK") {
      @Override
      public void actionPerformed(ActionEvent e) {
        if (handleOkClick()) {
          cancelled = false;
          setVisible(false);
        }
      }

    };
    this.buttonBar = Box.createHorizontalBox();
    add(this.buttonBar, BorderLayout.SOUTH);

    // assure that the dialog is closed if the user hits Escape
    getRootPane().registerKeyboardAction(cancelAction,
        KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0),
        JComponent.WHEN_IN_FOCUSED_WINDOW);
  }

  @Override
  public void setVisible(boolean visible) {
    if (visible) {
      this.cancelled = false;
      if (!completed) {
        completeButtonBar();
      }
    }
    super.setVisible(visible);
  }

  /**
   * Show modal dialog t.
   *
   * @param              the type parameter
   * @param mainComponent   the main component
   * @param title           the title
   * @param cancellable     the cancellable
   * @param parentComponent the parent component
   * @return the t
   */
  public static  T showModalDialog(T mainComponent, String title, boolean cancellable, Component parentComponent) {
    SimpleDialog dialog = new SimpleDialog<>(parentComponent, title, true, cancellable, mainComponent);
    dialog.setVisible(true);
    dialog.dispose();
    return (dialog.wasCancelled() ? null : dialog.getMainComponent());
  }

  /**
   * Gets main component.
   *
   * @return the main component
   */
  public E getMainComponent() {
    return mainComponent;
  }

  /**
   * Was cancelled boolean.
   *
   * @return the boolean
   */
  public boolean wasCancelled() {
    return cancelled;
  }

  /**
   * Add button.
   *
   * @param action the action
   */
  public void addButton(AbstractAction action) {
    buttonBar.add(new JButton(action));
  }

  /**
   * Handle ok click boolean.
   *
   * @return the boolean
   */
  protected boolean handleOkClick() {
    return true;
  }


  // private helpers -------------------------------------------------------------------------------------------------

  private void completeButtonBar() {
    buttonBar.setBorder(new EmptyBorder(8, 8, 8, 8));
    buttonBar.add(Box.createHorizontalGlue());
    if (cancellable) {
      addButton(cancelAction);
      buttonBar.add(Box.createHorizontalStrut(8));
    }
    JButton okButton = new JButton(okAction);
    buttonBar.add(okButton);
    getRootPane().setDefaultButton(okButton);
    // pack and position the dialog
    setResizable(false);
    pack();
    setLocationRelativeTo(parentComponent);
    this.completed = true;
  }

}