001package jmri.jmrit.operations.trains.gui;
002
003import java.awt.Dimension;
004import java.awt.GridBagLayout;
005
006import javax.swing.*;
007
008import org.slf4j.Logger;
009import org.slf4j.LoggerFactory;
010
011import jmri.jmrit.operations.CommonConductorYardmasterPanel;
012import jmri.jmrit.operations.rollingstock.RollingStock;
013import jmri.jmrit.operations.rollingstock.cars.Car;
014import jmri.jmrit.operations.routes.RouteLocation;
015import jmri.jmrit.operations.setup.Control;
016import jmri.jmrit.operations.trains.*;
017
018/**
019 * Conductor Panel. Shows work for a train one location at a time.
020 *
021 * @author Dan Boudreau Copyright (C) 2011, 2013
022 * 
023 */
024public class TrainConductorPanel extends CommonConductorYardmasterPanel {
025
026    // labels
027    JLabel textTrainName = new JLabel();
028    JLabel textTrainDepartureTime = new JLabel();
029    JLabel textNextLocationName = new JLabel();
030
031    // panels
032    JPanel pTrainDepartureTime = new JPanel();
033
034    /**
035     * Default constructor required to use as JavaBean.
036     */
037    public TrainConductorPanel() {
038        this(null);
039    }
040
041    public TrainConductorPanel(Train train) {
042        super();
043
044        _train = train;
045
046        // row 2
047        JPanel pRow2 = new JPanel();
048        pRow2.setLayout(new BoxLayout(pRow2, BoxLayout.X_AXIS));
049
050        // row 2a (train name)
051        JPanel pTrainName = new JPanel();
052        pTrainName.setBorder(BorderFactory.createTitledBorder(Bundle.getMessage("Train")));
053        pTrainName.add(textTrainName);
054
055        pRow2.add(pTrainName);
056        pRow2.add(pTrainDescription);
057        pRow2.add(pRailRoadName);
058
059        JPanel pLocation = new JPanel();
060        pLocation.setLayout(new BoxLayout(pLocation, BoxLayout.X_AXIS));
061
062        // row 10b (train departure time)
063        pTrainDepartureTime.setBorder(BorderFactory.createTitledBorder(Bundle.getMessage("DepartTime")));
064        pTrainDepartureTime.add(textTrainDepartureTime);
065
066        // row 10c (next location name)
067        JPanel pNextLocationName = new JPanel();
068        pNextLocationName.setBorder(BorderFactory.createTitledBorder(Bundle.getMessage("NextLocation")));
069        pNextLocationName.add(textNextLocationName);
070
071        pLocation.add(pLocationName); // location name
072        pLocation.add(pTrainDepartureTime);
073        pLocation.add(pNextLocationName);
074
075        // row 14
076        JPanel pRow14 = new JPanel();
077        pRow14.setLayout(new BoxLayout(pRow14, BoxLayout.X_AXIS));
078        pRow14.setMaximumSize(new Dimension(2000, 200));
079
080        // row 14b
081        JPanel pMoveButton = new JPanel();
082        pMoveButton.setLayout(new GridBagLayout());
083        pMoveButton.setBorder(BorderFactory.createTitledBorder(Bundle.getMessage("Train")));
084        addItem(pMoveButton, moveButton, 1, 0);
085
086        pRow14.add(pButtons);
087        pRow14.add(pMoveButton);
088
089        add(pRow2);
090        add(pLocation);
091        add(textTrainCommentPane);
092        add(textTrainRouteCommentPane); // train route comment
093        add(textTrainRouteLocationCommentPane); // train route location comment
094        add(textLocationCommentPane);
095        add(pTrackComments);
096        add(textTrainStatusPane);
097        add(locoPane);
098        add(pWorkPanes);
099        add(movePane);
100        add(pStatus);
101        add(pRow14);
102
103        // setup buttons
104        addButtonAction(moveButton);
105
106        if (_train != null) {
107            loadTrainDescription();
108            loadTrainComment();
109            loadRouteComment();
110            loadRailroadName();
111            // listen for train changes
112            _train.addPropertyChangeListener(this);
113        }
114        trainManager.addPropertyChangeListener(this);
115        
116        update();
117    }
118
119    @Override
120    public void buttonActionPerformed(java.awt.event.ActionEvent ae) {
121        if (ae.getSource() == moveButton) {
122            _train.move();
123            return;
124        }
125        super.buttonActionPerformed(ae);
126    }
127
128    private boolean queued = false;
129
130    @Override
131    protected void update() {
132        log.debug("queue update");
133        if (queued) {
134            return;
135        }
136        queued = true;
137        // use invokeLater to prevent deadlock
138        SwingUtilities.invokeLater(() -> {
139            log.debug("run update, setMode: {}", isSetMode);
140            queued = false;
141            initialize();
142            if (_train != null && _train.getRoute() != null) {
143                textTrainName.setText(_train.getIconName());
144                RouteLocation rl = _train.getCurrentRouteLocation();
145                if (rl != null) {
146                    loadRouteLocationComment(rl);
147
148                    textLocationName.setText(trainManager.isShowLocationHyphenNameEnabled() ? rl.getLocation().getName()
149                            : rl.getLocation().getSplitName());
150                    pTrainDepartureTime.setVisible(_train.isShowArrivalAndDepartureTimesEnabled() &&
151                            !rl.getDepartureTime().equals(RouteLocation.NONE));
152                    textTrainDepartureTime.setText(rl.getFormatedDepartureTime());
153
154                    loadLocationComment(rl.getLocation());
155
156                    textNextLocationName
157                            .setText(trainManager.isShowLocationHyphenNameEnabled() ? _train.getNextLocationName()
158                                    : TrainCommon.splitString(_train.getNextLocationName()));
159                    
160                    updateTrackComments(rl, IS_MANIFEST);
161                    
162                    textTrainStatusPane.setText(TrainCommon.getTrainMessage(_train, rl));
163                            
164                    // check for locos
165                    updateLocoPanes(rl);
166
167                    // now update the car pick ups and set outs
168                    blockCars(rl, IS_MANIFEST);
169                }
170
171                textStatus.setText(getStatus(rl, IS_MANIFEST));
172
173                // adjust move button text
174                if (rl == _train.getTrainTerminatesRouteLocation()) {
175                    moveButton.setText(Bundle.getMessage("Terminate"));
176                } else {
177                    moveButton.setText(Bundle.getMessage("Move"));
178                }
179            }
180            updateComplete();
181        });
182    }
183
184    @Override
185    public void dispose() {
186        trainManager.removePropertyChangeListener(this);
187        removePropertyChangeListerners();
188        if (_train != null) {
189            _train.removePropertyChangeListener(this);
190        }
191        super.dispose();
192    }
193
194    @Override
195    public void propertyChange(java.beans.PropertyChangeEvent e) {
196        if (Control.SHOW_PROPERTY) {
197            log.debug("Property change ({}) for: ({}) old: {}, new: {}", e.getPropertyName(), e.getSource().toString(),
198                    e.getOldValue(), e.getNewValue());
199        }
200        if (e.getPropertyName().equals(Train.TRAIN_MOVE_COMPLETE_CHANGED_PROPERTY) ||
201                e.getPropertyName().equals(Train.BUILT_CHANGED_PROPERTY)) {
202            clearAndUpdate();
203        }
204        if ((e.getPropertyName().equals(RollingStock.ROUTE_LOCATION_CHANGED_PROPERTY) && e.getNewValue() == null) ||
205                (e.getPropertyName().equals(RollingStock.ROUTE_DESTINATION_CHANGED_PROPERTY) &&
206                        e.getNewValue() == null) ||
207                e.getPropertyName().equals(RollingStock.TRAIN_CHANGED_PROPERTY) ||
208                e.getPropertyName().equals(Train.TRAIN_MODIFIED_CHANGED_PROPERTY) ||
209                e.getPropertyName().equals(TrainManager.TRAINS_SHOW_FULL_NAME_PROPERTY)) {
210            // remove car from list so the text get's updated
211            if (e.getSource().getClass().equals(Car.class)) {
212                Car car = (Car) e.getSource();
213                removeCarFromList(car);
214            }
215            update();
216        }
217    }
218
219    private final static Logger log = LoggerFactory.getLogger(TrainConductorPanel.class);
220}