001package jmri.jmrit.operations.rollingstock.engines.gui;
002
003import java.beans.PropertyChangeEvent;
004import java.beans.PropertyChangeListener;
005import java.util.List;
006
007import javax.swing.*;
008import javax.swing.table.TableColumnModel;
009
010import jmri.InstanceManager;
011import jmri.jmrit.operations.OperationsFrame;
012import jmri.jmrit.operations.OperationsXml;
013import jmri.jmrit.operations.rollingstock.engines.Engine;
014import jmri.jmrit.operations.rollingstock.engines.EngineManager;
015import jmri.jmrit.operations.rollingstock.engines.tools.*;
016import jmri.jmrit.operations.setup.Control;
017import jmri.jmrit.operations.setup.Setup;
018import jmri.swing.JTablePersistenceManager;
019import jmri.util.swing.JmriJOptionPane;
020
021/**
022 * Frame for adding and editing the engine roster for operations.
023 *
024 * @author Bob Jacobsen Copyright (C) 2001
025 * @author Daniel Boudreau Copyright (C) 2008, 2011, 2012, 2013, 2025
026 */
027public class EnginesTableFrame extends OperationsFrame implements PropertyChangeListener {
028
029    public EnginesTableModel enginesTableModel;
030    javax.swing.JTable enginesTable;
031    JScrollPane enginesPane;
032    EngineManager engineManager = InstanceManager.getDefault(EngineManager.class);
033
034    // labels
035    JLabel numEngines = new JLabel();
036    JLabel textEngines = new JLabel();
037    JLabel textSep1 = new JLabel("          ");
038
039    // radio buttons
040    JRadioButton sortByNumber = new JRadioButton(Bundle.getMessage("Number"));
041    JRadioButton sortByRoad = new JRadioButton(Bundle.getMessage("Road"));
042    JRadioButton sortByModel = new JRadioButton(Bundle.getMessage("Model"));
043    public JRadioButton sortByConsist = new JRadioButton(Bundle.getMessage("Consist"));
044    JRadioButton sortByLocation = new JRadioButton(Bundle.getMessage("Location"));
045    JRadioButton sortByDestination = new JRadioButton(Bundle.getMessage("Destination"));
046    JRadioButton sortByTrain = new JRadioButton(Bundle.getMessage("Train"));
047    JRadioButton sortByMoves = new JRadioButton(Bundle.getMessage("Moves"));
048    JRadioButton sortByBuilt = new JRadioButton(Bundle.getMessage("Built"));
049    JRadioButton sortByOwner = new JRadioButton(Bundle.getMessage("Owner"));
050    public JRadioButton sortByValue = new JRadioButton(Setup.getValueLabel());
051    public JRadioButton sortByRfid = new JRadioButton(Setup.getRfidLabel());
052    JRadioButton sortByDcc = new JRadioButton(Bundle.getMessage("DccAddress"));
053    JRadioButton sortByLast = new JRadioButton(Bundle.getMessage("Last"));
054    JRadioButton sortByComment = new JRadioButton(Bundle.getMessage("Comment"));
055    ButtonGroup group = new ButtonGroup();
056
057    // major buttons
058    JButton addButton = new JButton(Bundle.getMessage("TitleEngineAdd"));
059    JButton findButton = new JButton(Bundle.getMessage("Find"));
060    JButton saveButton = new JButton(Bundle.getMessage("ButtonSave"));
061
062    JTextField findEngineTextBox = new JTextField(6);
063
064    public EnginesTableFrame() {
065        super(Bundle.getMessage("TitleEnginesTable"));
066        // general GUI config
067
068        getContentPane().setLayout(new BoxLayout(getContentPane(), BoxLayout.Y_AXIS));
069
070        // Set up the jtable in a Scroll Pane..
071        enginesTableModel = new EnginesTableModel();
072        enginesTable = new JTable(enginesTableModel);
073        enginesPane = new JScrollPane(enginesTable);
074        enginesPane.setVerticalScrollBarPolicy(ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED);
075        enginesTableModel.initTable(enginesTable, this);
076
077        // load the number of engines and listen for changes
078        numEngines.setText(Integer.toString(engineManager.getNumEntries()));
079        engineManager.addPropertyChangeListener(this);
080        textEngines.setText(Bundle.getMessage("engines"));
081
082        // Set up the control panel
083        // row 1
084        JPanel cp1 = new JPanel();
085        cp1.setBorder(BorderFactory.createTitledBorder(Bundle.getMessage("SortBy")));
086
087        cp1.add(sortByNumber);
088        cp1.add(sortByRoad);
089        cp1.add(sortByModel);
090        cp1.add(sortByConsist);
091        cp1.add(sortByLocation);
092        cp1.add(sortByDestination);
093        cp1.add(sortByTrain);
094        JPanel movep = new JPanel();
095        movep.setBorder(BorderFactory.createTitledBorder(""));
096        movep.add(sortByMoves);
097        movep.add(sortByBuilt);
098        movep.add(sortByOwner);
099        if (Setup.isValueEnabled()) {
100            movep.add(sortByValue);
101        }
102        if (Setup.isRfidEnabled()) {
103            movep.add(sortByRfid);
104        }
105        movep.add(sortByDcc);
106        movep.add(sortByLast);
107        movep.add(sortByComment);
108        cp1.add(movep);
109
110        // row 2
111        JPanel cp2 = new JPanel();
112        cp2.setLayout(new BoxLayout(cp2, BoxLayout.X_AXIS));
113
114        JPanel cp2Add = new JPanel();
115        cp2Add.setBorder(BorderFactory.createTitledBorder(""));
116        addButton.setToolTipText(Bundle.getMessage("TipAddButton"));
117        cp2Add.add(numEngines);
118        cp2Add.add(textEngines);
119        cp2Add.add(textSep1);
120        cp2Add.add(addButton);
121        cp2.add(cp2Add);
122
123        JPanel cp2Find = new JPanel();
124        cp2Find.setBorder(BorderFactory.createTitledBorder(""));
125        findButton.setToolTipText(Bundle.getMessage("findEngine"));
126        findEngineTextBox.setToolTipText(Bundle.getMessage("findEngine"));
127        cp2Find.add(findButton);
128        cp2Find.add(findEngineTextBox);
129        cp2.add(cp2Find);
130
131        JPanel cp2Save = new JPanel();
132        cp2Save.setBorder(BorderFactory.createTitledBorder(""));
133        cp2Save.add(saveButton);
134        cp2.add(cp2Save);
135
136        // place controls in scroll pane
137        JPanel controlPanel = new JPanel();
138        controlPanel.setLayout(new BoxLayout(controlPanel, BoxLayout.Y_AXIS));
139        controlPanel.add(cp1);
140        controlPanel.add(cp2);
141
142        // some tool tips
143        sortByLast.setToolTipText(Bundle.getMessage("TipLastMoved"));
144
145        JScrollPane controlPane = new JScrollPane(controlPanel);
146
147        getContentPane().add(enginesPane);
148        getContentPane().add(controlPane);
149
150        // setup buttons
151        addButtonAction(addButton);
152        addButtonAction(findButton);
153        addButtonAction(saveButton);
154
155        sortByNumber.setSelected(true);
156        addRadioButtonAction(sortByNumber);
157        addRadioButtonAction(sortByRoad);
158        addRadioButtonAction(sortByModel);
159        addRadioButtonAction(sortByConsist);
160        addRadioButtonAction(sortByLocation);
161        addRadioButtonAction(sortByDestination);
162        addRadioButtonAction(sortByTrain);
163        addRadioButtonAction(sortByMoves);
164        addRadioButtonAction(sortByBuilt);
165        addRadioButtonAction(sortByOwner);
166        addRadioButtonAction(sortByValue);
167        addRadioButtonAction(sortByRfid);
168        addRadioButtonAction(sortByDcc);
169        addRadioButtonAction(sortByLast);
170        addRadioButtonAction(sortByComment);
171
172        group.add(sortByNumber);
173        group.add(sortByRoad);
174        group.add(sortByModel);
175        group.add(sortByConsist);
176        group.add(sortByLocation);
177        group.add(sortByDestination);
178        group.add(sortByTrain);
179        group.add(sortByMoves);
180        group.add(sortByBuilt);
181        group.add(sortByOwner);
182        group.add(sortByValue);
183        group.add(sortByRfid);
184        group.add(sortByDcc);
185        group.add(sortByLast);
186        group.add(sortByComment);
187        
188        sortByDcc.setToolTipText(Bundle.getMessage("TipDccAddressFromRoster"));
189
190        // build menu
191        JMenuBar menuBar = new JMenuBar();
192        JMenu toolMenu = new JMenu(Bundle.getMessage("MenuTools"));
193        toolMenu.add(new EngineRosterMenu(Bundle.getMessage("TitleEngineRoster"), EngineRosterMenu.MAINMENU, this));
194        toolMenu.addSeparator();
195        toolMenu.add(new ShowCheckboxesEnginesTableAction(enginesTableModel));
196        toolMenu.add(new ResetCheckboxesEnginesTableAction(enginesTableModel));
197        toolMenu.addSeparator();
198        toolMenu.add(new EnginesSetFrameAction(enginesTable));
199        toolMenu.add(new NceConsistEngineAction());
200        menuBar.add(toolMenu);
201        menuBar.add(new jmri.jmrit.operations.OperationsMenu());
202        setJMenuBar(menuBar);
203        addHelpMenu("package.jmri.jmrit.operations.Operations_Locomotives", true); // NOI18N
204
205        initMinimumSize();
206
207        addHorizontalScrollBarKludgeFix(controlPane, controlPanel);
208
209        // create ShutDownTasks
210        createShutDownTask();
211    }
212
213    @Override
214    public void radioButtonActionPerformed(java.awt.event.ActionEvent ae) {
215        log.debug("radio button activated");
216        // clear any sorts by column
217        clearTableSort(enginesTable);
218        if (ae.getSource() == sortByNumber) {
219            enginesTableModel.setSort(enginesTableModel.SORTBY_NUMBER);
220        }
221        if (ae.getSource() == sortByRoad) {
222            enginesTableModel.setSort(enginesTableModel.SORTBY_ROAD);
223        }
224        if (ae.getSource() == sortByModel) {
225            enginesTableModel.setSort(enginesTableModel.SORTBY_MODEL);
226        }
227        if (ae.getSource() == sortByConsist) {
228            enginesTableModel.setSort(enginesTableModel.SORTBY_CONSIST);
229        }
230        if (ae.getSource() == sortByLocation) {
231            enginesTableModel.setSort(enginesTableModel.SORTBY_LOCATION);
232        }
233        if (ae.getSource() == sortByDestination) {
234            enginesTableModel.setSort(enginesTableModel.SORTBY_DESTINATION);
235        }
236        if (ae.getSource() == sortByTrain) {
237            enginesTableModel.setSort(enginesTableModel.SORTBY_TRAIN);
238        }
239        if (ae.getSource() == sortByMoves) {
240            enginesTableModel.setSort(enginesTableModel.SORTBY_MOVES);
241        }
242        if (ae.getSource() == sortByBuilt) {
243            enginesTableModel.setSort(enginesTableModel.SORTBY_BUILT);
244        }
245        if (ae.getSource() == sortByOwner) {
246            enginesTableModel.setSort(enginesTableModel.SORTBY_OWNER);
247        }
248        if (ae.getSource() == sortByValue) {
249            enginesTableModel.setSort(enginesTableModel.SORTBY_VALUE);
250        }
251        if (ae.getSource() == sortByRfid) {
252            enginesTableModel.setSort(enginesTableModel.SORTBY_RFID);
253        }
254        if (ae.getSource() == sortByLast) {
255            enginesTableModel.setSort(enginesTableModel.SORTBY_LAST);
256        }
257        if (ae.getSource() == sortByDcc) {
258            enginesTableModel.setSort(enginesTableModel.SORTBY_DCC_ADDRESS);
259        }
260        if (ae.getSource() == sortByComment) {
261            enginesTableModel.setSort(enginesTableModel.SORTBY_COMMENT);
262        }
263    }
264
265    public List<Engine> getSortByList() {
266        return enginesTableModel.getSelectedEngineList();
267    }
268
269    EngineEditFrame engineEditFrame = null;
270
271    // add, save or find button
272    @Override
273    public void buttonActionPerformed(java.awt.event.ActionEvent ae) {
274        // log.debug("engine button activated");
275        if (ae.getSource() == findButton) {
276            int rowindex = enginesTableModel.findEngineByRoadNumber(findEngineTextBox.getText());
277            if (rowindex < 0) {
278                JmriJOptionPane.showMessageDialog(this, 
279                        Bundle.getMessage("engineWithRoadNumNotFound", findEngineTextBox.getText()),
280                        Bundle.getMessage("engineCouldNotFind"), JmriJOptionPane.INFORMATION_MESSAGE);
281                return;
282
283            }
284            // clear any sorts by column
285            clearTableSort(enginesTable);
286            enginesTable.changeSelection(rowindex, 0, false, false);
287            return;
288        }
289        if (ae.getSource() == addButton) {
290            if (engineEditFrame != null) {
291                engineEditFrame.dispose();
292            }
293            engineEditFrame = new EngineEditFrame();
294            engineEditFrame.initComponents();
295        }
296        if (ae.getSource() == saveButton) {
297            if (enginesTable.isEditing()) {
298                log.debug("locomotives table edit true");
299                enginesTable.getCellEditor().stopCellEditing();
300            }
301            OperationsXml.save();
302            if (Setup.isCloseWindowOnSaveEnabled()) {
303                dispose();
304            }
305        }
306    }
307
308    protected int[] getCurrentTableColumnWidths() {
309        TableColumnModel tcm = enginesTable.getColumnModel();
310        int[] widths = new int[tcm.getColumnCount()];
311        for (int i = 0; i < tcm.getColumnCount(); i++) {
312            widths[i] = tcm.getColumn(i).getWidth();
313        }
314        return widths;
315    }
316
317    @Override
318    public void dispose() {
319        engineManager.removePropertyChangeListener(this);
320        enginesTableModel.dispose();
321        if (engineEditFrame != null) {
322            engineEditFrame.dispose();
323        }
324        InstanceManager.getOptionalDefault(JTablePersistenceManager.class).ifPresent(tpm -> {
325            tpm.stopPersisting(enginesTable);
326        });
327        super.dispose();
328    }
329
330    @Override
331    public void propertyChange(PropertyChangeEvent e) {
332        if (Control.SHOW_PROPERTY) {
333            log.debug("Property change: ({}) old: ({}) new: ({})", e.getPropertyName(), e.getOldValue(), e
334                    .getNewValue());
335        }
336        if (e.getPropertyName().equals(EngineManager.LISTLENGTH_CHANGED_PROPERTY)) {
337            numEngines.setText(Integer.toString(engineManager.getNumEntries()));
338        }
339    }
340
341    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(EnginesTableFrame.class);
342}