001package jmri.jmrit.signalling;
002
003import javax.annotation.CheckForNull;
004import javax.annotation.Nonnull;
005
006import jmri.InstanceManager;
007import jmri.SignalMast;
008import jmri.SignalMastLogicManager;
009import jmri.util.JmriJFrame;
010import jmri.util.swing.JmriJOptionPane;
011
012/**
013 * @author Kevin Dickerson Copyright (C) 2011
014 */
015public class SignallingGuiTools {
016
017    private SignallingGuiTools() {
018    }
019
020    /**
021     * Display a message to the user asking them to
022     * confirm they wish to update the Signal Mast Logic from the old signal
023     * mast to the new one.
024     *
025     * @param frame the frame initiating the dialog
026     * @param oldMast original signal mast (object) for this SML
027     * @param newMast new main signal mast (object) to attach to SML
028     */
029    public static void updateSignalMastLogic(@CheckForNull JmriJFrame frame,
030            @Nonnull SignalMast oldMast, @Nonnull SignalMast newMast) {
031        Object[] options = {Bundle.getMessage("ButtonUpdate"), Bundle.getMessage("LeaveButton")};
032        int n = JmriJOptionPane.showOptionDialog(frame,
033                java.text.MessageFormat.format(Bundle.getMessage("UpdateLogic"),  // NOI18N
034                        new Object[]{oldMast.getDisplayName(), newMast.getDisplayName()}),
035                Bundle.getMessage("UpdateLogicTitle"),
036                JmriJOptionPane.DEFAULT_OPTION,
037                JmriJOptionPane.QUESTION_MESSAGE,
038                null,
039                options,
040                options[0]);
041        if (n == 0) { // array position 0, ButtonUpdate 
042            InstanceManager.getDefault(SignalMastLogicManager.class).replaceSignalMast(oldMast, newMast);
043        }
044    }
045
046    /**
047     * Display a message to the user asking them to confirm they wish to update
048     * the Signal Mast Logic by swapping two signal masts.
049     *
050     * @param frame the frame initiating the dialog
051     * @param oldMast signal mast (object) #1
052     * @param newMast signal mast (object) #2
053     */
054    public static void swapSignalMastLogic(@CheckForNull JmriJFrame frame,
055            @Nonnull SignalMast oldMast, @Nonnull SignalMast newMast) {
056        Object[] options = {Bundle.getMessage("ButtonUpdate"), Bundle.getMessage("LeaveButton")};
057        int n = JmriJOptionPane.showOptionDialog(frame,
058                java.text.MessageFormat.format(Bundle.getMessage("SwapLogic"),  // NOI18N
059                        new Object[]{oldMast.getDisplayName(), newMast.getDisplayName()}),
060                Bundle.getMessage("UpdateLogicTitle"),  // NOI18N
061                JmriJOptionPane.DEFAULT_OPTION,
062                JmriJOptionPane.QUESTION_MESSAGE,
063                null,
064                options,
065                options[0]);
066        if (n == 0) { // array position 0, ButtonUpdate
067            InstanceManager.getDefault(SignalMastLogicManager.class).swapSignalMasts(oldMast, newMast);
068        }
069    }
070
071    /**
072     * Display a message to the user asking them to
073     * confirm they wish to remove the Signal Mast Logic for a given signal.
074     *
075     * @param frame the frame initiating the dialog
076     * @param mast the main signal mast (object) selected on that frame
077     * @return true if user confirmed delete request
078     */
079    public static boolean removeSignalMastLogic(@CheckForNull JmriJFrame frame, @Nonnull SignalMast mast) {
080        Object[] options = {Bundle.getMessage("RemoveButton"), Bundle.getMessage("LeaveButton")};
081        int n = JmriJOptionPane.showOptionDialog(frame,
082                java.text.MessageFormat.format(Bundle.getMessage("RemoveLogic"),  // NOI18N
083                        new Object[]{mast.getDisplayName()}),
084                Bundle.getMessage("RemoveLogicTitle"),  // NOI18N
085                JmriJOptionPane.DEFAULT_OPTION,
086                JmriJOptionPane.QUESTION_MESSAGE,
087                null,
088                options,
089                options[0]);
090        if (n == 0) { // array position 0, RemoveButton
091            InstanceManager.getDefault(SignalMastLogicManager.class).removeSignalMast(mast);
092            return true;
093        }
094        return false;
095    }
096
097    /**
098     * Display a message to the user asking them to
099     * confirm they wish to remove the Signal Mast Logic for a given Signal Mast.
100     * <p>
101     * This is the same as removeSignalMastLogic, but with different text.
102     *
103     * @param frame the frame initiating the dialog
104     * @param mast the main signal mast (object) selected on that frame
105     */
106    public static void removeAlreadyAssignedSignalMastLogic(@CheckForNull JmriJFrame frame, @Nonnull SignalMast mast) {
107        Object[] options = {Bundle.getMessage("RemoveButton"),  // NOI18N
108            Bundle.getMessage("LeaveButton")};  // NOI18N
109        int n = JmriJOptionPane.showOptionDialog(frame,
110                java.text.MessageFormat.format(Bundle.getMessage("RemoveAlreadyAssignedLogic"),  // NOI18N
111                        new Object[]{mast.getDisplayName()}),
112                Bundle.getMessage("RemoveLogicTitle"),  // NOI18N
113                JmriJOptionPane.DEFAULT_OPTION,
114                JmriJOptionPane.QUESTION_MESSAGE,
115                null,
116                options,
117                options[0]);
118        if (n == 0) { // array position 0, RemoveButton
119            InstanceManager.getDefault(SignalMastLogicManager.class).removeSignalMast(mast);
120        }
121    }
122}