design/designer-base/src/main/java/com/fr/design/dialog/UIDialog.java

package com.fr.design.dialog;

import com.fr.base.i18n.BidiUtils;
import com.fr.design.gui.ibutton.UIButton;
import com.fr.design.layout.FRGUIPaneFactory;
import com.fr.design.utils.gui.GUICoreUtils;
import com.fr.log.FineLoggerFactory;

import javax.swing.AbstractAction;
import javax.swing.ActionMap;
import javax.swing.BorderFactory;
import javax.swing.InputMap;
import javax.swing.JComponent;
import javax.swing.JDialog;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.KeyStroke;
import java.awt.BorderLayout;
import java.awt.Dialog;
import java.awt.FlowLayout;
import java.awt.Frame;
import java.awt.Window;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.KeyEvent;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.util.ArrayList;


public abstract class UIDialog extends JDialog {
    public static final String OK_BUTTON = "basic_ok";
    public static final String CANCEL_BUTTON = "basic_cancel";
    private UIButton okButton, cancelButton;
    private BasicPane pane;
    private java.util.List<DialogActionListener> listeners = new ArrayList<DialogActionListener>();
    private boolean isDoOKSucceed;
    private boolean needExceptionCheck = true;


    public UIDialog(Frame parent) {
        super(parent);
    }

    public UIDialog(Dialog parent) {
        super(parent);
    }

    public UIDialog(Window parent) {
        super(parent);
    }


    public UIDialog(Frame parent, BasicPane pane) {
        this(parent, pane, true);
    }

    public UIDialog(Dialog parent, BasicPane pane) {
        this(parent, pane, true);
    }


    public UIDialog(Frame parent, BasicPane pane, boolean isNeedButtonPane) {
        super(parent);
        this.pane = pane;
        initComponents(isNeedButtonPane);
    }

    public UIDialog(Dialog parent, BasicPane pane, boolean isNeedButtonPane) {
        super(parent);
        this.pane = pane;
        initComponents(isNeedButtonPane);
    }

    public void setDoOKSucceed(boolean isOk) {
        isDoOKSucceed = isOk;
    }

    private void initComponents(boolean isNeedButtonPane) {
        JPanel contentPane = (JPanel) this.getContentPane();
        contentPane.setBorder(BorderFactory.createEmptyBorder(2, 4, 4, 4));
        contentPane.setLayout(new BorderLayout(0, 4));
        this.applyClosingAction();
        this.applyEscapeAction();
        contentPane.add(pane, BorderLayout.CENTER);
        if (isNeedButtonPane) {
            contentPane.add(this.createControlButtonPane(), BorderLayout.SOUTH);
        }
        this.setName(pane.title4PopupWindow());
        this.setModal(true);

        GUICoreUtils.centerWindow(this);
        BidiUtils.applyOrientationByLocale(contentPane);
    }

    private JPanel createControlButtonPane() {
        JPanel controlPane = FRGUIPaneFactory.createBorderLayout_S_Pane();

        JPanel buttonsPane = new JPanel(new FlowLayout(FlowLayout.LEADING, 10, 0));
        controlPane.add(buttonsPane, BorderLayout.LINE_END);

        //增加一个自定义按钮, 可以用于eg: 设为全局配置
        addCustomButton(buttonsPane);
        //确定
        addOkButton(buttonsPane);
        //取消
        addCancelButton(buttonsPane);

        return controlPane;
    }

    protected void addCustomButton(JPanel buttonsPane) {

    }

    private void addCancelButton(JPanel buttonsPane) {
        cancelButton = new UIButton(com.fr.design.i18n.Toolkit.i18nText("Fine-Design_Basic_Cancel"));
        cancelButton.setName(CANCEL_BUTTON);
        cancelButton.setMnemonic('C');
        buttonsPane.add(cancelButton);
        cancelButton.addActionListener(new ActionListener() {

            public void actionPerformed(ActionEvent evt) {
                doCancel();
            }
        });

        applyEnterAction();
    }

    protected void applyEnterAction() {
        JPanel defaultPane = (JPanel) this.getContentPane();
        InputMap inputMapAncestor = defaultPane.getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);
        ActionMap actionMap = defaultPane.getActionMap();

        // transfer focus to CurrentEditor
        inputMapAncestor.put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, 0), "dialogOK");
        actionMap.put("dialogOK", new AbstractAction() {
            @Override
            public void actionPerformed(ActionEvent evt) {
                if (!okButton.isEnabled()) {
                    return;
                }
                doOK();
            }
        });
    }

    private void addOkButton(JPanel buttonsPane) {
        okButton = new UIButton(com.fr.design.i18n.Toolkit.i18nText("Fine-Design_Report_OK"));
        okButton.setName(OK_BUTTON);
        okButton.setMnemonic('O');
        buttonsPane.add(okButton);
        okButton.addActionListener(new ActionListener() {

            public void actionPerformed(ActionEvent evt) {
                doOK();
            }
        });
    }

    public void setNeedExceptionCheck(boolean needExceptionCheck) {
        this.needExceptionCheck = needExceptionCheck;
    }


    /**
     * 添加监听器
     *
     * @param l 监听器
     */
    public void addDialogActionListener(DialogActionListener l) {
        listeners.add(l);
    }

    /**
     * 清除所有监听器
     */
    public void clearDialogActionListeners() {
        listeners.clear();
    }

    /**
     * 确定操作
     */
    public void doOK() {
        //由于checkValid不可以加入自定义的弹窗以及操作，添加一个接口
        if (!confirmContinueBeforeDoOK()) {
            return;
        }

        try {
            checkValid();
        } catch (Exception exp) {
            if (needExceptionCheck) {
                FineJOptionPane.showMessageDialog(
                        this,
                        exp.getMessage(),
                        com.fr.design.i18n.Toolkit.i18nText("Fine-Design_Basic_Tool_Tips"),
                        JOptionPane.WARNING_MESSAGE);
            }
            return;
        }

        synchronized (this) {
            // dialogExit();august:怎么能这儿exit呢,dispose了就是释放了对话框的线程锁了,
            // 那么下面的doOk和原来的派遣线程就会竞争执行,万一派遣线程依赖doOk的结果、而doOK又是后执行的，那么就会出错了
            // 这Bug实在是太隐蔽了！
            isDoOKSucceed = true;
            for (DialogActionListener l : listeners) {
                try {
                    l.doOk();
                } catch (RuntimeException e) {
                    isDoOKSucceed = false;
                    FineLoggerFactory.getLogger().error(e.getMessage(), e);
                }
            }
            if (isDoOKSucceed) {
                dialogExit();
            }
        }
    }

    /**
     * 取消操作
     */
    public void doCancel() {

        for (DialogActionListener l : listeners) {
            l.doCancel();
        }
        dialogExit();
    }

    /**
     * Dialog exit.
     */
    protected void dialogExit() {
        this.setVisible(false);
        this.dispose();
    }

    protected void applyClosingAction() {
        addWindowListener(new WindowAdapter() {

            public void windowClosing(WindowEvent e) {
                doCancel();
            }
        });
    }

    protected void applyEscapeAction() {
        // default pane.
        JPanel defaultPane = (JPanel) this.getContentPane();

        // esp.
        InputMap inputMapAncestor = defaultPane.getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);
        ActionMap actionMap = defaultPane.getActionMap();

        // transfer focus to CurrentEditor
        inputMapAncestor.put(KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), "dialogExit");
        actionMap.put("dialogExit", new AbstractAction() {

            public void actionPerformed(ActionEvent evt) {
                doCancel();
            }
        });
    }

    /**
     * 检测结果是否合法
     */
    public abstract void checkValid() throws Exception;

    public boolean confirmContinueBeforeDoOK() {
        return true;
    }

    public void setButtonEnabled(boolean b) {
        this.okButton.setEnabled(b);
    }
}