001package jmri.jmrit.operations.rollingstock.cars.tools;
002
003import java.awt.*;
004import java.io.IOException;
005import java.util.List;
006
007import javax.swing.*;
008
009import org.slf4j.Logger;
010import org.slf4j.LoggerFactory;
011
012import jmri.InstanceManager;
013import jmri.jmrit.operations.OperationsFrame;
014import jmri.jmrit.operations.OperationsPanel;
015import jmri.jmrit.operations.locations.LocationManager;
016import jmri.jmrit.operations.rollingstock.cars.*;
017import jmri.jmrit.operations.rollingstock.cars.gui.CarsTableFrame;
018import jmri.jmrit.operations.setup.Control;
019import jmri.jmrit.operations.setup.Setup;
020import jmri.jmrit.operations.trains.TrainCommon;
021import jmri.util.davidflanagan.HardcopyWriter;
022
023/**
024 * Prints a summary of the car roster
025 * <p>
026 * This uses the older style printing, for compatibility with Java 1.1.8 in
027 * MacIntosh MRJ
028 *
029 * @author Bob Jacobsen Copyright (C) 2003
030 * @author Daniel Boudreau Copyright (C) 2023
031 */
032
033public class PrintCarRosterFrame extends OperationsFrame {
034
035    boolean _isPreview;
036    CarsTableFrame _ctf;
037
038    JComboBox<String> sortByComboBox = new JComboBox<>();
039    JComboBox<String> manifestOrientationComboBox = new JComboBox<>();
040    JComboBox<Integer> fontSizeComboBox = new JComboBox<>();
041
042    JCheckBox printCarsWithLocation = new JCheckBox(Bundle.getMessage("PrintCarsWithLocation"));
043    JCheckBox printCarLength = new JCheckBox(Bundle.getMessage("PrintCarLength"));
044    JCheckBox printCarWeight = new JCheckBox(Bundle.getMessage("PrintCarWeight"));
045    JCheckBox printCarColor = new JCheckBox(Bundle.getMessage("PrintCarColor"));
046    JCheckBox printCarOwner = new JCheckBox(Bundle.getMessage("PrintCarOwner"));
047    JCheckBox printCarBuilt = new JCheckBox(Bundle.getMessage("PrintCarBuilt"));
048    JCheckBox printCarLoad = new JCheckBox(Bundle.getMessage("PrintCarLoad"));
049    JCheckBox printCarKernel = new JCheckBox(Bundle.getMessage("PrintKernel"));
050    JCheckBox printCarValue = new JCheckBox(
051            Bundle.getMessage("PrintCar", Setup.getValueLabel()));
052    JCheckBox printCarRfid = new JCheckBox(
053            Bundle.getMessage("PrintCar", Setup.getRfidLabel()));
054    JCheckBox printCarLast = new JCheckBox(Bundle.getMessage("PrintCarLastMoved"));
055    JCheckBox printCarWait = new JCheckBox(Bundle.getMessage("PrintCarWait"));
056    JCheckBox printCarPickup = new JCheckBox(Bundle.getMessage("PrintCarPickup"));
057    JCheckBox printCarLocation = new JCheckBox(Bundle.getMessage("PrintCarLocation"));
058    JCheckBox printCarTrain = new JCheckBox(Bundle.getMessage("PrintCarTrain"));
059    JCheckBox printCarDestination = new JCheckBox(Bundle.getMessage("PrintCarDestination"));
060    JCheckBox printCarFinalDestination = new JCheckBox(Bundle.getMessage("PrintCarFinalDestination"));
061    JCheckBox printCarRoutePath = new JCheckBox(Bundle.getMessage("PrintCarRoutePath"));
062    JCheckBox printCarRWE = new JCheckBox(Bundle.getMessage("PrintCarReturnWhenEmpty"));
063    JCheckBox printCarRWL = new JCheckBox(Bundle.getMessage("PrintCarReturnWhenLoaded"));
064    JCheckBox printDivision = new JCheckBox(Bundle.getMessage("PrintCarDivision"));
065    JCheckBox printCarStatus = new JCheckBox(Bundle.getMessage("PrintCarStatus"));
066    JCheckBox printCarComment = new JCheckBox(Bundle.getMessage("PrintCarComment"));
067    JCheckBox printSpace = new JCheckBox(Bundle.getMessage("PrintSpace"));
068    JCheckBox printPage = new JCheckBox(Bundle.getMessage("PrintPage"));
069
070    JButton okayButton = new JButton(Bundle.getMessage("ButtonOK"));
071
072    public PrintCarRosterFrame(boolean isPreview, CarsTableFrame carsTableFrame) {
073        super();
074        _isPreview = isPreview;
075        _ctf = carsTableFrame;
076
077        // create panel
078        JPanel pSortBy = new JPanel();
079        pSortBy.setBorder(BorderFactory.createTitledBorder(Bundle.getMessage("SortBy")));
080        pSortBy.add(sortByComboBox);
081        addComboBoxAction(sortByComboBox);
082
083        JPanel pOrientation = new JPanel();
084        pOrientation.setBorder(BorderFactory.createTitledBorder(Bundle.getMessage("BorderLayoutOrientation")));
085        pOrientation.add(manifestOrientationComboBox);
086
087        manifestOrientationComboBox.addItem(Setup.PORTRAIT);
088        manifestOrientationComboBox.addItem(Setup.LANDSCAPE);
089
090        JPanel pFontSize = new JPanel();
091        pFontSize.setBorder(BorderFactory.createTitledBorder(Bundle.getMessage("BorderLayoutFontSize")));
092        pFontSize.add(fontSizeComboBox);
093
094        OperationsPanel.loadFontSizeComboBox(fontSizeComboBox);
095        fontSizeComboBox.setSelectedItem(Control.reportFontSize);
096
097        JPanel pPanel = new JPanel();
098        pPanel.setLayout(new GridBagLayout());
099        JScrollPane panePanel = new JScrollPane(pPanel);
100        panePanel.setBorder(BorderFactory.createTitledBorder(Bundle.getMessage("PrintOptions")));
101        addItemLeft(pPanel, printCarsWithLocation, 0, 0);
102        addItemLeft(pPanel, printCarLength, 0, 1);
103        addItemLeft(pPanel, printCarWeight, 0, 2);
104        addItemLeft(pPanel, printCarColor, 0, 3);
105        addItemLeft(pPanel, printCarLoad, 0, 4);
106        addItemLeft(pPanel, printCarKernel, 0, 5);
107        addItemLeft(pPanel, printCarOwner, 0, 6);
108        addItemLeft(pPanel, printCarBuilt, 0, 7);
109        addItemLeft(pPanel, printCarLast, 0, 8);
110        addItemLeft(pPanel, printCarWait, 0, 9);
111        addItemLeft(pPanel, printCarPickup, 0, 10);
112        if (Setup.isValueEnabled()) {
113            addItemLeft(pPanel, printCarValue, 0, 11);
114        }
115        if (Setup.isRfidEnabled()) {
116            addItemLeft(pPanel, printCarRfid, 0, 12);
117        }
118        addItemLeft(pPanel, printCarLocation, 0, 13);
119        addItemLeft(pPanel, printCarTrain, 0, 14);
120        addItemLeft(pPanel, printCarDestination, 0, 15);
121        addItemLeft(pPanel, printCarFinalDestination, 0, 16);
122        addItemLeft(pPanel, printCarRWE, 0, 17);
123        addItemLeft(pPanel, printCarRWL, 0, 18);
124        addItemLeft(pPanel, printDivision, 0, 19);
125        addItemLeft(pPanel, printCarStatus, 0, 20);
126        addItemLeft(pPanel, printCarRoutePath, 0, 21);
127        addItemLeft(pPanel, printCarComment, 0, 22);
128        addItemLeft(pPanel, printSpace, 0, 23);
129        addItemLeft(pPanel, printPage, 0, 24);
130
131        // set defaults
132        printCarsWithLocation.setSelected(false);
133        printCarLength.setSelected(true);
134        printCarWeight.setSelected(false);
135        printCarColor.setSelected(true);
136        printCarLoad.setSelected(false);
137        printCarKernel.setSelected(false);
138        printCarOwner.setSelected(false);
139        printCarBuilt.setSelected(false);
140        printCarLast.setSelected(false);
141        printCarWait.setSelected(false);
142        printCarPickup.setSelected(false);
143        printCarValue.setSelected(false);
144        printCarRfid.setSelected(false);
145        printCarLocation.setSelected(true);
146        printCarTrain.setSelected(false);
147        printCarDestination.setSelected(false);
148        printCarFinalDestination.setSelected(false);
149        printCarRoutePath.setSelected(false);
150        printCarRWE.setSelected(false);
151        printCarRWL.setSelected(false);
152        printDivision.setSelected(false);
153        printCarStatus.setSelected(false);
154        printCarComment.setSelected(false);
155        printSpace.setSelected(false);
156        printPage.setSelected(false);
157
158        // add tool tips
159        printSpace.setToolTipText(Bundle.getMessage("TipSelectSortByLoc"));
160        printPage.setToolTipText(Bundle.getMessage("TipSelectSortByLoc"));
161
162        JPanel pButtons = new JPanel();
163        pButtons.setLayout(new GridBagLayout());
164        pButtons.add(okayButton);
165        pButtons.setBorder(BorderFactory.createTitledBorder(""));
166        addButtonAction(okayButton);
167
168        getContentPane().setLayout(new BoxLayout(getContentPane(), BoxLayout.Y_AXIS));
169        getContentPane().add(pSortBy);
170        getContentPane().add(pOrientation);
171        getContentPane().add(pFontSize);
172        getContentPane().add(panePanel);
173        getContentPane().add(pButtons);
174
175        initMinimumSize(new Dimension(Control.panelWidth300, Control.panelHeight500));
176
177        if (_isPreview) {
178            setTitle(Bundle.getMessage("MenuItemPreview"));
179        } else {
180            setTitle(Bundle.getMessage("MenuItemPrint"));
181        }
182        loadSortByComboBox(sortByComboBox);
183        updateLocationCheckboxes();
184    }
185
186    private void loadSortByComboBox(JComboBox<String> box) {
187        box.removeAllItems();
188        for (int i = _ctf.carsTableModel.SORTBY_NUMBER; i <= _ctf.carsTableModel.SORTBY_COMMENT; i++) {
189            box.addItem(_ctf.carsTableModel.getSortByName(i));
190        }
191        box.setSelectedItem(_ctf.carsTableModel.getSortByName());
192    }
193
194    @Override
195    public void buttonActionPerformed(java.awt.event.ActionEvent ae) {
196        setVisible(false);
197        printCars();
198    }
199
200    @Override
201    public void comboBoxActionPerformed(java.awt.event.ActionEvent ae) {
202        updateLocationCheckboxes();
203    }
204
205    private void updateLocationCheckboxes() {
206        if (sortByComboBox.getSelectedItem() != null &&
207                sortByComboBox.getSelectedItem()
208                        .equals(_ctf.carsTableModel.getSortByName(_ctf.carsTableModel.SORTBY_LOCATION))) {
209            printSpace.setEnabled(true);
210            printPage.setEnabled(true);
211        } else {
212            printSpace.setEnabled(false);
213            printPage.setEnabled(false);
214            printSpace.setSelected(false);
215            printPage.setSelected(false);
216        }
217    }
218
219    int numberCharPerLine;
220
221    private void printCars() {
222        boolean isLandscape = false;
223        if (manifestOrientationComboBox.getSelectedItem() != null &&
224                manifestOrientationComboBox.getSelectedItem().equals(Setup.LANDSCAPE)) {
225            isLandscape = true;
226        }
227
228        int fontSize = (int) fontSizeComboBox.getSelectedItem();
229
230        // obtain a HardcopyWriter to do this
231        try (HardcopyWriter writer = new HardcopyWriter(new Frame(), Bundle.getMessage("TitleCarRoster"), fontSize, .5,
232                .5, .5, .5, _isPreview, "", isLandscape, true, null, null)) {
233
234            numberCharPerLine = writer.getCharactersPerLine();
235
236            printHeader(writer);
237
238            printRoster(writer);
239
240        } catch (HardcopyWriter.PrintCanceledException ex) {
241            log.debug("Print cancelled");
242        } catch (IOException we) {
243            log.error("Error printing car roster: {}", we.getLocalizedMessage());
244        }
245    }
246
247    private void printHeader(HardcopyWriter writer) throws IOException {
248        String s = padAttribute(Bundle.getMessage("Number"), Control.max_len_string_print_road_number) +
249                padAttribute(Bundle.getMessage("Road"),
250                        InstanceManager.getDefault(CarRoads.class).getMaxNameLength()) +
251                padAttribute(Bundle.getMessage("Type"),
252                        InstanceManager.getDefault(CarTypes.class).getMaxFullNameLength()) +
253                (printCarLength.isSelected() ? Bundle.getMessage("Len") + "  " : "") +
254                (printCarWeight.isSelected() ? "     " : "") +
255                (printCarColor.isSelected()
256                        ? padAttribute(Bundle.getMessage("Color"),
257                                InstanceManager.getDefault(CarColors.class).getMaxNameLength())
258                        : "") +
259                (printCarLoad.isSelected()
260                        ? padAttribute(Bundle.getMessage("Load"),
261                                InstanceManager.getDefault(CarLoads.class).getMaxNameLength())
262                        : "") +
263                (printCarKernel.isSelected() ? padAttribute(("Kernel"), Control.max_len_string_attibute) : "") +
264                (printCarOwner.isSelected()
265                        ? padAttribute(Bundle.getMessage("Owner"),
266                                InstanceManager.getDefault(CarOwners.class).getMaxNameLength())
267                        : "") +
268                (printCarBuilt.isSelected() ? Bundle.getMessage("Built") + " " : "") +
269                (printCarLast.isSelected() ? Bundle.getMessage("LastMoved") + " " : "") +
270                (printCarWait.isSelected() ? Bundle.getMessage("Wait") + " " : "") +
271                (printCarPickup.isSelected() ? padAttribute(Bundle.getMessage("Pickup"), 10) : "") +
272                (printCarValue.isSelected() ? padAttribute(Setup.getValueLabel(), Control.max_len_string_attibute)
273                        : "") +
274                (printCarRfid.isSelected() ? padAttribute(Setup.getRfidLabel(), Control.max_len_string_attibute)
275                        : "") +
276                (printCarLocation.isSelected()
277                        ? padAttribute(Bundle.getMessage("Location"),
278                                InstanceManager.getDefault(LocationManager.class)
279                                        .getMaxLocationAndTrackNameLength() +
280                                        3)
281                        : "") +
282                (printCarTrain.isSelected()
283                        ? padAttribute(Bundle.getMessage("Train"), Control.max_len_string_train_name / 2)
284                        : "") +
285                (printCarDestination.isSelected()
286                        ? padAttribute(Bundle.getMessage("Destination"),
287                                InstanceManager.getDefault(LocationManager.class)
288                                        .getMaxLocationAndTrackNameLength() +
289                                        3)
290                        : "") +
291                (printCarFinalDestination.isSelected()
292                        ? padAttribute(Bundle.getMessage("FinalDestination"),
293                                InstanceManager.getDefault(LocationManager.class)
294                                        .getMaxLocationAndTrackNameLength() +
295                                        3)
296                        : "") +
297                (printCarRWE.isSelected()
298                        ? padAttribute(Bundle.getMessage("ReturnWhenEmpty"),
299                                InstanceManager.getDefault(LocationManager.class)
300                                        .getMaxLocationAndTrackNameLength() +
301                                        3)
302                        : "") +
303                (printCarRWL.isSelected()
304                        ? padAttribute(Bundle.getMessage("ReturnWhenLoaded"),
305                                InstanceManager.getDefault(LocationManager.class)
306                                        .getMaxLocationAndTrackNameLength() +
307                                        3)
308                        : "") +
309                (printDivision.isSelected() ? Bundle.getMessage("HomeDivision") + " " : "") +
310                (printCarStatus.isSelected() ? Bundle.getMessage("Status") + " " : "") +
311                (printCarRoutePath.isSelected()
312                        ? padAttribute(Bundle.getMessage("Route"),
313                                InstanceManager.getDefault(LocationManager.class)
314                                        .getMaxLocationAndTrackNameLength() +
315                                        3)
316                        : "") +
317                (printCarComment.isSelected() ? Bundle.getMessage("Comment") : "");
318        if (s.length() > numberCharPerLine) {
319            s = s.substring(0, numberCharPerLine);
320            writer.write(Bundle.getMessage("WarningTextPage") + NEW_LINE);
321        }
322        writer.write(s + NEW_LINE);
323    }
324
325    private void printRoster(HardcopyWriter writer) throws IOException {
326        // Loop through the Roster, printing as needed
327        String location = "";
328        String number;
329        String road;
330        String type;
331        String length = "";
332        String weight = "";
333        String color = "";
334        String owner = "";
335        String built = "";
336        String load = "";
337        String kernel = "";
338        String train = "";
339        String destination = "";
340        String finalDestination = "";
341        String returnWhenEmpty = "";
342        String returnWhenLoaded = "";
343        String division = "";
344        String value = "";
345        String rfid = "";
346        String last = "";
347        String wait = "";
348        String schedule = "";
349        String status = "";
350        String routePath = "";
351        String comment = "";
352        String previousLocation = null;
353        List<Car> cars = _ctf.carsTableModel.getCarList(sortByComboBox.getSelectedIndex());
354        for (Car car : cars) {
355            if (printCarsWithLocation.isSelected() && car.getLocation() == null) {
356                continue; // car doesn't have a location skip
357            }
358            location = "";
359            destination = "";
360            finalDestination = "";
361            returnWhenEmpty = "";
362            returnWhenLoaded = "";
363
364            if (printCarLocation.isSelected()) {
365                if (car.getLocation() != null) {
366                    location = car.getLocationName().trim() + " - " + car.getTrackName().trim();
367                }
368                location = padAttribute(location,
369                        InstanceManager.getDefault(LocationManager.class).getMaxLocationAndTrackNameLength() +
370                                3);
371            }
372            // Page break between locations?
373            if (previousLocation != null &&
374                    !car.getLocationName().trim().equals(previousLocation) &&
375                    printPage.isSelected()) {
376                writer.pageBreak();
377                printHeader(writer);
378            } // Add a line between locations?
379            else if (previousLocation != null &&
380                    !car.getLocationName().trim().equals(previousLocation) &&
381                    printSpace.isSelected()) {
382                writer.write(NEW_LINE);
383            }
384            previousLocation = car.getLocationName().trim();
385
386            // car number
387            number = padAttribute(car.getNumber().trim(), Control.max_len_string_print_road_number);
388            // car road
389            road = padAttribute(car.getRoadName().trim(),
390                    InstanceManager.getDefault(CarRoads.class).getMaxNameLength());
391            // car type
392            type = padAttribute(car.getTypeName().trim(),
393                    InstanceManager.getDefault(CarTypes.class).getMaxFullNameLength());
394
395            if (printCarLength.isSelected()) {
396                length = padAttribute(car.getLength().trim(), Control.max_len_string_length_name);
397            }
398            if (printCarWeight.isSelected()) {
399                weight = padAttribute(car.getWeight().trim(), Control.max_len_string_weight_name);
400            }
401            if (printCarColor.isSelected()) {
402                color = padAttribute(car.getColor().trim(),
403                        InstanceManager.getDefault(CarColors.class).getMaxNameLength());
404            }
405            if (printCarLoad.isSelected()) {
406                load = padAttribute(car.getLoadName().trim(),
407                        InstanceManager.getDefault(CarLoads.class).getMaxNameLength());
408            }
409            if (printCarKernel.isSelected()) {
410                kernel = padAttribute(car.getKernelName().trim(), Control.max_len_string_attibute);
411            }
412            if (printCarOwner.isSelected()) {
413                owner = padAttribute(car.getOwnerName().trim(),
414                        InstanceManager.getDefault(CarOwners.class).getMaxNameLength());
415            }
416            if (printCarBuilt.isSelected()) {
417                built = padAttribute(car.getBuilt().trim(), Control.max_len_string_built_name);
418            }
419            if (printCarLast.isSelected()) {
420                last = padAttribute(car.getSortDate().split(" ")[0], 10);
421            }
422            if (printCarWait.isSelected()) {
423                wait = padAttribute(Integer.toString(car.getWait()), 4);
424            }
425            if (printCarPickup.isSelected()) {
426                schedule = padAttribute(car.getPickupScheduleName(), 10);
427            }
428            if (printCarValue.isSelected()) {
429                value = padAttribute(car.getValue().trim(), Control.max_len_string_attibute);
430            }
431            if (printCarRfid.isSelected()) {
432                rfid = padAttribute(car.getRfid().trim(), Control.max_len_string_attibute);
433            }
434            // pad out train to half of its maximum length
435            if (printCarTrain.isSelected()) {
436                train = padAttribute(car.getTrainName().trim(), Control.max_len_string_train_name / 2);
437            }
438            if (printCarDestination.isSelected()) {
439                if (car.getDestination() != null) {
440                    destination =
441                            car.getDestinationName().trim() + " - " + car.getDestinationTrackName().trim();
442                }
443                destination = padAttribute(destination,
444                        InstanceManager.getDefault(LocationManager.class).getMaxLocationAndTrackNameLength() +
445                                3);
446            }
447            if (printCarFinalDestination.isSelected()) {
448                if (car.getFinalDestination() != null) {
449                    finalDestination = car.getFinalDestinationName().trim();
450                    if (car.getFinalDestinationTrack() != null) {
451                        finalDestination = finalDestination +
452                                " - " +
453                                car.getFinalDestinationTrackName().trim();
454                    }
455                }
456                finalDestination = padAttribute(finalDestination,
457                        InstanceManager.getDefault(LocationManager.class).getMaxLocationAndTrackNameLength() +
458                                3);
459            }
460            // long route paths will wrap
461            if (printCarRoutePath.isSelected()) {
462                routePath = car.getRoutePath() + " ";
463            }
464            if (printCarRWE.isSelected()) {
465                if (car.getReturnWhenEmptyDestination() != null) {
466                    returnWhenEmpty = car.getReturnWhenEmptyDestinationName().trim() +
467                            " - " +
468                            car.getReturnWhenEmptyDestTrackName().trim();
469                }
470                returnWhenEmpty = padAttribute(returnWhenEmpty,
471                        InstanceManager.getDefault(LocationManager.class).getMaxLocationAndTrackNameLength() +
472                                3);
473            }
474            if (printCarRWL.isSelected()) {
475                if (car.getReturnWhenLoadedDestination() != null) {
476                    returnWhenLoaded = car.getReturnWhenLoadedDestinationName().trim() +
477                            " - " +
478                            car.getReturnWhenLoadedDestTrackName().trim();
479                }
480                returnWhenLoaded = padAttribute(returnWhenLoaded,
481                        InstanceManager.getDefault(LocationManager.class).getMaxLocationAndTrackNameLength() +
482                                3);
483            }
484            if (printDivision.isSelected()) {
485                division = padAttribute(car.getDivisionName(), Bundle.getMessage("HomeDivision").length());
486            }
487            if (printCarStatus.isSelected()) {
488                status = padAttribute(car.getStatus(), Bundle.getMessage("Status").length());
489            }
490            // comment gets trimmed by line length
491            if (printCarComment.isSelected()) {
492                comment = car.getComment().trim();
493            }
494
495            String s = number +
496                    road +
497                    type +
498                    length +
499                    weight +
500                    color +
501                    load +
502                    kernel +
503                    owner +
504                    built +
505                    last +
506                    wait +
507                    schedule +
508                    value +
509                    rfid +
510                    location +
511                    train +
512                    destination +
513                    finalDestination +
514                    returnWhenEmpty +
515                    returnWhenLoaded +
516                    division +
517                    status +
518                    routePath +
519                    comment;
520
521            s = s.trim();
522            if (s.length() > numberCharPerLine) {
523                writer.write(s.substring(0, numberCharPerLine) + NEW_LINE);
524                s = s.substring(numberCharPerLine, s.length());
525                String tab = getTab();
526                int subStringLength = numberCharPerLine - tab.length();
527                while (tab.length() + s.length() > numberCharPerLine) {
528                    writer.write(tab + s.substring(0, subStringLength) + NEW_LINE);
529                    s = s.substring(subStringLength, s.length());
530                }
531                s = tab + s;
532            }
533            writer.write(s + NEW_LINE);
534        }
535    }
536
537    private String padAttribute(String attribute, int length) {
538        return TrainCommon.padAndTruncate(attribute, length) + TrainCommon.SPACE;
539    }
540
541    private String getTab() {
542        return padAttribute("",
543                Control.max_len_string_print_road_number +
544                        InstanceManager.getDefault(CarRoads.class).getMaxNameLength() +
545                        1);
546    }
547
548    private final static Logger log = LoggerFactory.getLogger(PrintCarRosterFrame.class);
549}