001package jmri.jmrit.operations.rollingstock.engines.tools;
002
003import java.util.ArrayList;
004import java.util.List;
005
006import javax.swing.JTable;
007
008import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
009import jmri.jmrit.operations.rollingstock.engines.Engine;
010import jmri.jmrit.operations.rollingstock.engines.gui.*;
011import jmri.util.swing.JmriJOptionPane;
012
013/**
014 * Frame for user to modify a group of engines on the layout
015 *
016 * @author Dan Boudreau Copyright (C) 2024
017 */
018public class EnginesSetFrame extends EngineSetFrame {
019
020    EnginesTableModel _enginesTableModel;
021    JTable _enginesTable;
022
023    public EnginesSetFrame() {
024        super();
025    }
026
027    // Ignore checkbox states
028    private static boolean ignoreStatusCheckBoxSelected = true;
029    private static boolean ignoreLocationCheckBoxSelected = true;
030    private static boolean ignoreConsistCheckBoxSelected = true;
031    private static boolean ignoreDestinationCheckBoxSelected = true;
032    private static boolean ignoreTrainCheckBoxSelected = true;
033
034    public void initComponents(JTable enginesTable) {
035        _enginesTable = enginesTable;
036        _enginesTableModel = (EnginesTableModel) enginesTable.getModel();
037
038        super.initComponents("package.jmri.jmrit.operations.Operations_SetEngines");
039
040        setTitle(Bundle.getMessage("TitleSetEngines"));
041        // modify Save button text to "Apply";
042        saveButton.setText(Bundle.getMessage("ButtonApply"));
043
044        // show ignore checkboxes
045        ignoreStatusCheckBox.setVisible(true);
046        ignoreLocationCheckBox.setVisible(true);
047        ignoreConsistCheckBox.setVisible(true);
048        ignoreDestinationCheckBox.setVisible(true);
049        ignoreTrainCheckBox.setVisible(true);
050        ignoreAllButton.setVisible(true);
051
052        // set the last state
053        ignoreStatusCheckBox.setSelected(ignoreStatusCheckBoxSelected);
054        ignoreLocationCheckBox.setSelected(ignoreLocationCheckBoxSelected);
055        ignoreConsistCheckBox.setSelected(ignoreConsistCheckBoxSelected);
056        ignoreDestinationCheckBox.setSelected(ignoreDestinationCheckBoxSelected);
057        ignoreTrainCheckBox.setSelected(ignoreTrainCheckBoxSelected);
058
059        // first engine in the list becomes the master
060        int rows[] = _enginesTable.getSelectedRows();
061        if (rows.length > 0) {
062            Engine engine = _enginesTableModel.getEngineAtIndex(_enginesTable.convertRowIndexToModel(rows[0]));
063            super.load(engine);
064        } else {
065            enableComponents(true);
066            showMessageDialogWarning();
067        }
068    }
069
070    @Override
071    public void buttonActionPerformed(java.awt.event.ActionEvent ae) {
072        super.buttonActionPerformed(ae);
073        if (ae.getSource() == ignoreAllButton) {
074            ignoreAll(toggle);
075        }
076    }
077
078    boolean toggle = false;
079
080    protected void ignoreAll(boolean b) {
081        ignoreStatusCheckBox.setSelected(!locationUnknownCheckBox.isSelected() & b);
082        ignoreLocationCheckBox.setSelected(b);
083        ignoreConsistCheckBox.setSelected(b);
084        ignoreDestinationCheckBox.setSelected(b);
085        ignoreTrainCheckBox.setSelected(b);
086        enableComponents(!locationUnknownCheckBox.isSelected());
087        toggle = !b;
088    }
089
090    @Override
091    @SuppressFBWarnings(value = "ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD", justification = "GUI ease of use")
092    protected boolean save() {
093        // save ignore states
094        ignoreStatusCheckBoxSelected = ignoreStatusCheckBox.isSelected();
095        ignoreLocationCheckBoxSelected = ignoreLocationCheckBox.isSelected();
096        ignoreConsistCheckBoxSelected = ignoreConsistCheckBox.isSelected();
097        ignoreDestinationCheckBoxSelected = ignoreConsistCheckBox.isSelected();
098        ignoreTrainCheckBoxSelected = ignoreTrainCheckBox.isSelected();
099
100        // need to get selected engines before they are modified their location in the table can change
101        List<Engine> engines = new ArrayList<Engine>();
102        int rows[] = _enginesTable.getSelectedRows();
103        for (int row : rows) {
104            Engine engine = _enginesTableModel.getEngineAtIndex(_enginesTable.convertRowIndexToModel(row));
105            log.debug("Adding selected engine {} to change list", engine.toString());
106            engines.add(engine);
107        }
108        if (rows.length == 0) {
109            showMessageDialogWarning();
110            return false;
111        } else if (engines.get(0) != _engine) {
112            log.debug("Default engine isn't the first one selected");
113            if (JmriJOptionPane.showConfirmDialog(this, Bundle
114                    .getMessage("doYouWantToChange", engines.get(0).toString()),
115                    Bundle
116                            .getMessage("changeDefaultEngine"),
117                    JmriJOptionPane.YES_NO_OPTION) == JmriJOptionPane.YES_OPTION) {
118                super.load(engines.get(0)); // new default engine
119                return false; // done, don't modify any of the engines selected
120            }
121        }
122
123        // don't ask for to change engines in a consist when giving a selected group of engines a new consist name
124        askConsistChange = false;
125        
126        // determine if all engines in every consist are selected
127        for (Engine engine : engines) {
128            if (engine.getConsist() != null) {
129                for (Engine c : engine.getConsist().getEngines()) {
130                    if (!engines.contains(c)) {
131                        askConsistChange = true; // not all selected
132                        break;
133                    }
134                }
135            }
136        }
137
138        for (Engine engine : engines) {
139            if (!super.change(engine)) {
140                return false;
141            } else if (engine.getConsist() != null && !ignoreConsistCheckBox.isSelected()) {
142                askConsistChange = false; // changing consist name
143            }
144        }
145        return false; // all good, but don't close window
146    }
147    
148    private void showMessageDialogWarning() {
149        JmriJOptionPane.showMessageDialog(this, Bundle.getMessage("selectEngines"), Bundle
150                .getMessage("engineNoneSelected"), JmriJOptionPane.WARNING_MESSAGE);
151    }
152
153    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(EnginesSetFrame.class);
154}