001package jmri.jmrit.operations.rollingstock.cars.gui;
002
003import java.util.List;
004
005import javax.swing.*;
006import javax.swing.event.TableModelEvent;
007import javax.swing.event.TableModelListener;
008import javax.swing.table.TableColumnModel;
009
010import jmri.InstanceManager;
011import jmri.jmrit.operations.OperationsFrame;
012import jmri.jmrit.operations.OperationsXml;
013import jmri.jmrit.operations.locations.schedules.ScheduleManager;
014import jmri.jmrit.operations.locations.tools.ModifyLocationsAction;
015import jmri.jmrit.operations.rollingstock.cars.*;
016import jmri.jmrit.operations.rollingstock.cars.tools.*;
017import jmri.jmrit.operations.setup.Control;
018import jmri.jmrit.operations.setup.Setup;
019import jmri.jmrit.operations.trains.tools.TrainsByCarTypeAction;
020import jmri.swing.JTablePersistenceManager;
021import jmri.util.swing.JmriJOptionPane;
022
023/**
024 * Frame for adding and editing the car roster for operations.
025 *
026 * @author Bob Jacobsen Copyright (C) 2001
027 * @author Daniel Boudreau Copyright (C) 2008, 2009, 2010, 2011, 2012, 2013,
028 * 2014
029 */
030public class CarsTableFrame extends OperationsFrame implements TableModelListener {
031
032    public CarsTableModel carsTableModel;
033    public JTable carsTable;
034    boolean showAllCars;
035    String locationName;
036    String trackName;
037    CarManager carManager = InstanceManager.getDefault(CarManager.class);
038
039    // labels
040    JLabel numCars = new JLabel();
041    JLabel textCars = new JLabel(Bundle.getMessage("cars"));
042    JLabel textSep1 = new JLabel("      ");
043
044    // radio buttons
045    JRadioButton sortByNumber = new JRadioButton(Bundle.getMessage("Number"));
046    JRadioButton sortByRoad = new JRadioButton(Bundle.getMessage("Road"));
047    JRadioButton sortByType = new JRadioButton(Bundle.getMessage("Type"));
048    JRadioButton sortByColor = new JRadioButton(Bundle.getMessage("Color"));
049    JRadioButton sortByLoad = new JRadioButton(Bundle.getMessage("Load"));
050    JRadioButton sortByKernel = new JRadioButton(Bundle.getMessage("Kernel"));
051    JRadioButton sortByLocation = new JRadioButton(Bundle.getMessage("Location"));
052    JRadioButton sortByDestination = new JRadioButton(Bundle.getMessage("Destination"));
053    JRadioButton sortByFinalDestination = new JRadioButton(Bundle.getMessage("FD"));
054    JRadioButton sortByRwe = new JRadioButton(Bundle.getMessage("RWE"));
055    JRadioButton sortByRwl = new JRadioButton(Bundle.getMessage("RWL"));
056    JRadioButton sortByRoute = new JRadioButton(Bundle.getMessage("Route"));
057    JRadioButton sortByDivision = new JRadioButton(Bundle.getMessage("Division"));
058    JRadioButton sortByTrain = new JRadioButton(Bundle.getMessage("Train"));
059    JRadioButton sortByMoves = new JRadioButton(Bundle.getMessage("Moves"));
060    JRadioButton sortByBuilt = new JRadioButton(Bundle.getMessage("Built"));
061    JRadioButton sortByOwner = new JRadioButton(Bundle.getMessage("Owner"));
062    JRadioButton sortByValue = new JRadioButton(Setup.getValueLabel());
063    JRadioButton sortByRfid = new JRadioButton(Setup.getRfidLabel());
064    JRadioButton sortByWait = new JRadioButton(Bundle.getMessage("Wait"));
065    JRadioButton sortByPickup = new JRadioButton(Bundle.getMessage("Pickup"));
066    JRadioButton sortByLast = new JRadioButton(Bundle.getMessage("Last"));
067    JRadioButton sortByComment = new JRadioButton(Bundle.getMessage("Comment"));
068    ButtonGroup group = new ButtonGroup();
069
070    // major buttons
071    JButton addButton = new JButton(Bundle.getMessage("TitleCarAdd"));
072    JButton findButton = new JButton(Bundle.getMessage("Find"));
073    JButton saveButton = new JButton(Bundle.getMessage("ButtonSave"));
074
075    JTextField findCarTextBox = new JTextField(6);
076
077    public CarsTableFrame(boolean showAllCars, String locationName, String trackName) {
078        super(Bundle.getMessage("TitleCarsTable"));
079        this.showAllCars = showAllCars;
080        this.locationName = locationName;
081        this.trackName = trackName;
082        // general GUI configuration
083        getContentPane().setLayout(new BoxLayout(getContentPane(), BoxLayout.Y_AXIS));
084
085        // Set up the table in a Scroll Pane..
086        carsTableModel = new CarsTableModel(showAllCars, locationName, trackName);
087        carsTable = new JTable(carsTableModel);
088        JScrollPane carsPane = new JScrollPane(carsTable);
089        carsPane.setVerticalScrollBarPolicy(ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED);
090        carsTableModel.initTable(carsTable, this);
091
092        // load the number of cars and listen for changes
093        updateNumCars();
094        carsTableModel.addTableModelListener(this);
095
096        // Set up the control panel
097        // row 1
098        JPanel cp1 = new JPanel();
099        cp1.setBorder(BorderFactory.createTitledBorder(Bundle.getMessage("SortBy")));
100        cp1.add(sortByNumber);
101        cp1.add(sortByRoad);
102        cp1.add(sortByType);
103
104        JPanel clp = new JPanel();
105        clp.setBorder(BorderFactory.createTitledBorder(""));  
106        clp.add(sortByLoad);
107        clp.add(sortByColor);
108        cp1.add(clp);
109        cp1.add(sortByKernel);
110        cp1.add(sortByLocation);
111
112        JPanel destp = new JPanel();
113        destp.setBorder(BorderFactory.createTitledBorder(""));
114        destp.add(sortByDestination);
115        destp.add(sortByFinalDestination);
116        destp.add(sortByRwe);
117        destp.add(sortByRwl);
118        destp.add(sortByRoute);
119        cp1.add(destp);
120        cp1.add(sortByDivision);
121        cp1.add(sortByTrain);
122
123        JPanel movep = new JPanel();
124        movep.setBorder(BorderFactory.createTitledBorder(""));
125        movep.add(sortByMoves);
126        movep.add(sortByBuilt);
127        movep.add(sortByOwner);
128        if (Setup.isValueEnabled()) {
129            movep.add(sortByValue);
130        }
131        if (Setup.isRfidEnabled()) {
132            movep.add(sortByRfid);
133        }
134        if (InstanceManager.getDefault(ScheduleManager.class).numEntries() > 0) {
135            movep.add(sortByWait);
136            movep.add(sortByPickup);
137        }
138        movep.add(sortByLast);
139        movep.add(sortByComment);
140        cp1.add(movep);
141
142        // row 2
143        JPanel cp2 = new JPanel();
144        cp2.setLayout(new BoxLayout(cp2, BoxLayout.X_AXIS));
145
146        JPanel cp2Add = new JPanel();
147        cp2Add.setBorder(BorderFactory.createTitledBorder(""));
148        addButton.setToolTipText(Bundle.getMessage("TipAddButton"));
149        cp2Add.add(numCars);
150        cp2Add.add(textCars);
151        cp2Add.add(textSep1);
152        cp2Add.add(addButton);
153        cp2.add(cp2Add);
154
155        JPanel cp2Find = new JPanel();
156        cp2Find.setBorder(BorderFactory.createTitledBorder(""));
157        findButton.setToolTipText(Bundle.getMessage("findCar"));
158        findCarTextBox.setToolTipText(Bundle.getMessage("findCar"));
159        cp2Find.add(findButton);
160        cp2Find.add(findCarTextBox);
161        cp2.add(cp2Find);
162
163        JPanel cp2Save = new JPanel();
164        cp2Save.setBorder(BorderFactory.createTitledBorder(""));
165        cp2Save.add(saveButton);
166        cp2.add(cp2Save);
167
168        // place controls in scroll pane
169        JPanel controlPanel = new JPanel();
170        controlPanel.setLayout(new BoxLayout(controlPanel, BoxLayout.Y_AXIS));
171        controlPanel.add(cp1);
172        controlPanel.add(cp2);
173
174        // some tool tips
175        sortByFinalDestination.setToolTipText(Bundle.getMessage("FinalDestination"));
176        sortByRwe.setToolTipText(Bundle.getMessage("ReturnWhenEmpty"));
177        sortByRwl.setToolTipText(Bundle.getMessage("ReturnWhenLoaded"));
178        sortByPickup.setToolTipText(Bundle.getMessage("TipPickup"));
179        sortByLast.setToolTipText(Bundle.getMessage("TipLastMoved"));
180
181        JScrollPane controlPane = new JScrollPane(controlPanel);
182
183        getContentPane().add(carsPane);
184        getContentPane().add(controlPane);
185
186        // setup buttons
187        addButtonAction(addButton);
188        addButtonAction(findButton);
189        addButtonAction(saveButton);
190
191        sortByNumber.setSelected(true);
192        addRadioButtonAction(sortByNumber);
193        addRadioButtonAction(sortByRoad);
194        addRadioButtonAction(sortByType);
195        addRadioButtonAction(sortByColor);
196        addRadioButtonAction(sortByLoad);
197        addRadioButtonAction(sortByKernel);
198        addRadioButtonAction(sortByLocation);
199        addRadioButtonAction(sortByDestination);
200        addRadioButtonAction(sortByFinalDestination);
201        addRadioButtonAction(sortByRwe);
202        addRadioButtonAction(sortByRwl);
203        addRadioButtonAction(sortByRoute);
204        addRadioButtonAction(sortByDivision);
205        addRadioButtonAction(sortByTrain);
206        addRadioButtonAction(sortByMoves);
207        addRadioButtonAction(sortByBuilt);
208        addRadioButtonAction(sortByOwner);
209        addRadioButtonAction(sortByValue);
210        addRadioButtonAction(sortByRfid);
211        addRadioButtonAction(sortByWait);
212        addRadioButtonAction(sortByPickup);
213        addRadioButtonAction(sortByLast);
214        addRadioButtonAction(sortByComment);
215
216        group.add(sortByNumber);
217        group.add(sortByRoad);
218        group.add(sortByType);
219        group.add(sortByColor);
220        group.add(sortByLoad);
221        group.add(sortByKernel);
222        group.add(sortByLocation);
223        group.add(sortByDestination);
224        group.add(sortByFinalDestination);
225        group.add(sortByRwe);
226        group.add(sortByRwl);
227        group.add(sortByRoute);
228        group.add(sortByDivision);
229        group.add(sortByTrain);
230        group.add(sortByMoves);
231        group.add(sortByBuilt);
232        group.add(sortByOwner);
233        group.add(sortByValue);
234        group.add(sortByRfid);
235        group.add(sortByWait);
236        group.add(sortByPickup);
237        group.add(sortByLast);
238        group.add(sortByComment);
239
240        // sort by location
241        if (!showAllCars) {
242            sortByLocation.doClick();
243            if (locationName != null) {
244                String title = Bundle.getMessage("TitleCarsTable") + " " + locationName;
245                if (trackName != null) {
246                    title = title + " " + trackName;
247                }
248                setTitle(title);
249            }
250        }
251
252        // build menu
253        JMenuBar menuBar = new JMenuBar();
254        JMenu toolMenu = new JMenu(Bundle.getMessage("MenuTools"));
255        toolMenu.add(new CarRosterMenu(Bundle.getMessage("TitleCarRoster"), CarRosterMenu.MAINMENU, this));
256        toolMenu.addSeparator();
257        toolMenu.add(new ShowCheckboxesCarsTableAction(carsTableModel));
258        toolMenu.add(new ResetCheckboxesCarsTableAction(carsTableModel));
259        toolMenu.addSeparator();
260        toolMenu.add(new ModifyLocationsAction());
261        toolMenu.add(new TrainsByCarTypeAction());
262        toolMenu.addSeparator();
263        toolMenu.add(new PrintCarLoadsAction(false));
264        toolMenu.add(new PrintCarLoadsAction(true));
265        toolMenu.addSeparator();
266        toolMenu.add(new CarsSetFrameAction(carsTable));
267        menuBar.add(toolMenu);
268        menuBar.add(new jmri.jmrit.operations.OperationsMenu());
269        setJMenuBar(menuBar);
270        addHelpMenu("package.jmri.jmrit.operations.Operations_Cars", true); // NOI18N
271
272        initMinimumSize();
273
274        addHorizontalScrollBarKludgeFix(controlPane, controlPanel);
275
276        // create ShutDownTasks
277        createShutDownTask();
278    }
279
280    @Override
281    public void radioButtonActionPerformed(java.awt.event.ActionEvent ae) {
282        log.debug("radio button activated");
283        // clear any sorts by column
284        clearTableSort(carsTable);
285        if (ae.getSource() == sortByNumber) {
286            carsTableModel.setSort(carsTableModel.SORTBY_NUMBER);
287        }
288        if (ae.getSource() == sortByRoad) {
289            carsTableModel.setSort(carsTableModel.SORTBY_ROAD);
290        }
291        if (ae.getSource() == sortByType) {
292            carsTableModel.setSort(carsTableModel.SORTBY_TYPE);
293        }
294        if (ae.getSource() == sortByColor) {
295            carsTableModel.setSort(carsTableModel.SORTBY_COLOR);
296        }
297        if (ae.getSource() == sortByLoad) {
298            carsTableModel.setSort(carsTableModel.SORTBY_LOAD);
299        }
300        if (ae.getSource() == sortByKernel) {
301            carsTableModel.setSort(carsTableModel.SORTBY_KERNEL);
302        }
303        if (ae.getSource() == sortByLocation) {
304            carsTableModel.setSort(carsTableModel.SORTBY_LOCATION);
305        }
306        if (ae.getSource() == sortByDestination) {
307            carsTableModel.setSort(carsTableModel.SORTBY_DESTINATION);
308        }
309        if (ae.getSource() == sortByFinalDestination) {
310            carsTableModel.setSort(carsTableModel.SORTBY_FINALDESTINATION);
311        }
312        if (ae.getSource() == sortByRwe) {
313            carsTableModel.setSort(carsTableModel.SORTBY_RWE);
314        }
315        if (ae.getSource() == sortByRwl) {
316            carsTableModel.setSort(carsTableModel.SORTBY_RWL);
317        }
318        if (ae.getSource() == sortByRoute) {
319            carsTableModel.setSort(carsTableModel.SORTBY_ROUTE);
320        }
321        if (ae.getSource() == sortByDivision) {
322            carsTableModel.setSort(carsTableModel.SORTBY_DIVISION);
323        }
324        if (ae.getSource() == sortByTrain) {
325            carsTableModel.setSort(carsTableModel.SORTBY_TRAIN);
326        }
327        if (ae.getSource() == sortByMoves) {
328            carsTableModel.setSort(carsTableModel.SORTBY_MOVES);
329        }
330        if (ae.getSource() == sortByBuilt) {
331            carsTableModel.setSort(carsTableModel.SORTBY_BUILT);
332        }
333        if (ae.getSource() == sortByOwner) {
334            carsTableModel.setSort(carsTableModel.SORTBY_OWNER);
335        }
336        if (ae.getSource() == sortByValue) {
337            carsTableModel.setSort(carsTableModel.SORTBY_VALUE);
338        }
339        if (ae.getSource() == sortByRfid) {
340            carsTableModel.setSort(carsTableModel.SORTBY_RFID);
341        }
342        if (ae.getSource() == sortByWait) {
343            carsTableModel.setSort(carsTableModel.SORTBY_WAIT);
344        }
345        if (ae.getSource() == sortByPickup) {
346            carsTableModel.setSort(carsTableModel.SORTBY_PICKUP);
347        }
348        if (ae.getSource() == sortByLast) {
349            carsTableModel.setSort(carsTableModel.SORTBY_LAST);
350        }
351        if (ae.getSource() == sortByComment) {
352            carsTableModel.setSort(carsTableModel.SORTBY_COMMENT);
353        }
354    }
355
356    public List<Car> getSortByList() {
357        return carsTableModel.carList;
358    }
359
360    CarEditFrame f = null;
361
362    // add, find or save button
363    @Override
364    public void buttonActionPerformed(java.awt.event.ActionEvent ae) {
365        // log.debug("car button activated");
366        if (ae.getSource() == findButton) {
367            int rowindex = carsTableModel.findCarByRoadNumber(findCarTextBox.getText());
368            if (rowindex < 0) {
369                JmriJOptionPane.showMessageDialog(this, Bundle.getMessage("carWithRoadNumNotFound",
370                        findCarTextBox.getText()), Bundle.getMessage("carCouldNotFind"),
371                        JmriJOptionPane.INFORMATION_MESSAGE);
372                return;
373            }
374            // clear any sorts by column
375            clearTableSort(carsTable);
376            carsTable.changeSelection(rowindex, 0, false, false);
377            return;
378        }
379        if (ae.getSource() == addButton) {
380            if (f != null) {
381                f.dispose();
382            }
383            f = new CarEditFrame();
384            f.initComponents(); // default is add car
385        }
386        if (ae.getSource() == saveButton) {
387            if (carsTable.isEditing()) {
388                log.debug("cars table edit true");
389                carsTable.getCellEditor().stopCellEditing();
390            }
391            OperationsXml.save();
392            if (Setup.isCloseWindowOnSaveEnabled()) {
393                dispose();
394            }
395        }
396    }
397
398    protected int[] getCurrentTableColumnWidths() {
399        TableColumnModel tcm = carsTable.getColumnModel();
400        int[] widths = new int[tcm.getColumnCount()];
401        for (int i = 0; i < tcm.getColumnCount(); i++) {
402            widths[i] = tcm.getColumn(i).getWidth();
403        }
404        return widths;
405    }
406
407    @Override
408    public void dispose() {
409        carsTableModel.removeTableModelListener(this);
410        carsTableModel.dispose();
411        if (f != null) {
412            f.dispose();
413        }
414        InstanceManager.getOptionalDefault(JTablePersistenceManager.class).ifPresent(tpm -> {
415            tpm.stopPersisting(carsTable);
416        });
417        super.dispose();
418    }
419
420    @Override
421    public void tableChanged(TableModelEvent e) {
422        if (Control.SHOW_PROPERTY) {
423            log.debug("Table changed");
424        }
425        updateNumCars();
426    }
427
428    private void updateNumCars() {
429        String totalNumber = Integer.toString(InstanceManager.getDefault(CarManager.class).getNumEntries());
430        if (showAllCars) {
431            numCars.setText(totalNumber);
432            return;
433        }
434        String showNumber = Integer.toString(getSortByList().size());
435        numCars.setText(showNumber + "/" + totalNumber);
436    }
437
438    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(CarsTableFrame.class);
439
440}