Source code

001package jmri.jmrit.operations.locations.gui;
002
003import java.awt.Color;
004import java.awt.GridBagLayout;
005
006import javax.swing.*;
007
008import org.slf4j.Logger;
009import org.slf4j.LoggerFactory;
010
011import jmri.InstanceManager;
012import jmri.jmrit.operations.locations.Location;
013import jmri.jmrit.operations.locations.Track;
014import jmri.jmrit.operations.locations.schedules.*;
015import jmri.jmrit.operations.locations.tools.AlternateTrackAction;
016import jmri.jmrit.operations.locations.tools.ChangeTrackTypeAction;
017import jmri.jmrit.operations.setup.Control;
018import jmri.util.swing.JmriJOptionPane;
019
020/**
021 * Frame for user edit of a spur.
022 *
023 * @author Dan Boudreau Copyright (C) 2008, 2011, 2023
024 */
025public class SpurEditFrame extends TrackEditFrame {
026
027    // labels, buttons, etc. for spurs
028    JLabel textSchedule = new JLabel(Bundle.getMessage("DeliverySchedule"));
029    JLabel textSchError = new JLabel();
030    JButton editScheduleButton = new JButton();
031    JComboBox<Schedule> comboBoxSchedules = InstanceManager.getDefault(ScheduleManager.class).getComboBox();
032
033    JPanel panelSchedule = panelOpt4;
034
035    public SpurEditFrame() {
036        super(Bundle.getMessage("AddSpur"));
037    }
038    
039    @Override
040    public void initComponents(Track track) {
041        setTitle(Bundle.getMessage("EditSpur", track.getLocation().getName()));
042        initComponents(track.getLocation(), track);
043    }
044
045    @Override
046    public void initComponents(Location location, Track track) {
047        _type = Track.SPUR;
048
049        // setup the optional panel with schedule stuff
050        panelSchedule.setLayout(new GridBagLayout());
051        panelSchedule.setBorder(BorderFactory.createTitledBorder(Bundle
052                .getMessage("DeliverySchedule")));
053        addItem(panelSchedule, comboBoxSchedules, 0, 0);
054        addItem(panelSchedule, editScheduleButton, 1, 0);
055        addItem(panelSchedule, textSchError, 2, 0);
056        textSchError.setForeground(Color.RED);
057
058        super.initComponents(location, track);
059
060        _toolMenu.insert(new AlternateTrackAction(this), 0);
061        _toolMenu.insert(new ChangeTrackTypeAction(this), TOOL_MENU_OFFSET + 1);
062        addHelpMenu("package.jmri.jmrit.operations.Operations_Spurs", true); // NOI18N
063
064        // override text strings for tracks
065        panelTrainDir.setBorder(BorderFactory.createTitledBorder(Bundle.getMessage("TrainSpur")));
066        paneCheckBoxes.setBorder(BorderFactory.createTitledBorder(Bundle.getMessage("TypesSpur")));
067        deleteTrackButton.setText(Bundle.getMessage("DeleteSpur"));
068        addTrackButton.setText(Bundle.getMessage("AddSpur"));
069        saveTrackButton.setText(Bundle.getMessage("SaveSpur"));
070        
071        // tool tips
072        autoSelectButton.setToolTipText(Bundle.getMessage("TipAutoSelectSchedule"));
073
074        // setup buttons
075        addButtonAction(autoSelectButton);
076        addButtonAction(editScheduleButton);
077        addComboBoxAction(comboBoxSchedules);
078        
079        // Select the spur's Schedule
080        updateScheduleComboBox();
081
082        InstanceManager.getDefault(ScheduleManager.class).addPropertyChangeListener(this);
083        
084        // finish
085        panelOrder.setVisible(false); // Car order out of spurs is not available
086        pack();
087        setVisible(true);
088    }
089
090    @Override
091    public void buttonActionPerformed(java.awt.event.ActionEvent ae) {
092        if (ae.getSource() == autoSelectButton) {
093            autoSelectCheckboxes();
094        }
095        if (ae.getSource() == editScheduleButton) {
096            editAddSchedule();
097        }
098        super.buttonActionPerformed(ae);
099    }
100    
101    @Override
102    public void comboBoxActionPerformed(java.awt.event.ActionEvent ae) {
103        removeSchedulePropertyListener();
104        updateScheduleButtonText();
105    }
106    
107    private void updateScheduleButtonText() {
108        if (comboBoxSchedules.getSelectedItem() == null) {
109            editScheduleButton.setText(Bundle.getMessage("Add"));
110        } else {
111            editScheduleButton.setText(Bundle.getMessage("ButtonEdit"));
112        }
113    }
114    
115    private void autoSelectCheckboxes() {
116        if (JmriJOptionPane.showConfirmDialog(this, Bundle.getMessage("TipAutoSelectSchedule"),
117                Bundle.getMessage("AutoSelect"), JmriJOptionPane.YES_NO_OPTION) == JmriJOptionPane.YES_OPTION) {
118            for (int i = 0; i < checkBoxes.size(); i++) {
119                JCheckBox checkBox = checkBoxes.get(i);
120                if (_track != null && _track.getSchedule() != null) {
121                    Schedule schedule = _track.getSchedule();
122                    if (schedule.checkScheduleAttribute(Track.TYPE, checkBox.getText(), null)) {
123                        _track.addTypeName(checkBox.getText());
124                    } else {
125                        _track.deleteTypeName(checkBox.getText());
126                    }
127                }
128            }
129        }
130    }
131
132
133    ScheduleEditFrame sef = null;
134
135    private void editAddSchedule() {
136        log.debug("Edit/add schedule");
137        if (sef != null) {
138            sef.dispose();
139        }
140        Schedule schedule = (Schedule) comboBoxSchedules.getSelectedItem();
141        sef = new ScheduleEditFrame(schedule, _track);
142    }
143
144    @Override
145    protected void enableButtons(boolean enabled) {
146        autoSelectButton.setEnabled(enabled && _track.getSchedule() != null);
147        editScheduleButton.setEnabled(enabled);
148        comboBoxSchedules.setEnabled(enabled);
149        if (!enabled) {
150            comboBoxSchedules.setSelectedItem(null);
151        }
152        super.enableButtons(enabled);
153    }
154
155    @Override
156    protected void saveTrack(Track track) {
157        // save the schedule
158        Schedule schedule = (Schedule) comboBoxSchedules.getSelectedItem();
159        track.setSchedule(schedule);
160        textSchError.setText(track.checkScheduleValid());
161        super.saveTrack(track);
162    }
163
164    @Override
165    protected void addNewTrack() {
166        super.addNewTrack();
167        updateScheduleComboBox(); // reset schedule and error text
168    }
169    
170    @Override
171    protected void deleteTrack() {
172        removeSchedulePropertyListener();
173        super.deleteTrack();
174    }
175
176    private void updateScheduleComboBox() {
177        InstanceManager.getDefault(ScheduleManager.class).updateComboBox(comboBoxSchedules);
178        if (_track != null) {
179            Schedule sch = InstanceManager.getDefault(ScheduleManager.class).getScheduleById(_track.getScheduleId());
180            comboBoxSchedules.setSelectedItem(sch);
181            textSchError.setText(_track.checkScheduleValid());
182            if (sch != null) {
183                sch.removePropertyChangeListener(this);
184                sch.addPropertyChangeListener(this);
185            }
186        }
187    }
188
189    @Override
190    public void dispose() {
191        removeSchedulePropertyListener();
192        super.dispose();
193    }
194    
195    private void removeSchedulePropertyListener() {
196        InstanceManager.getDefault(ScheduleManager.class).removePropertyChangeListener(this);
197        if (_track != null) {
198            Schedule sch = InstanceManager.getDefault(ScheduleManager.class).getScheduleById(_track.getScheduleId());
199            if (sch != null)
200                sch.removePropertyChangeListener(this);
201        }
202    }
203
204    @Override
205    public void propertyChange(java.beans.PropertyChangeEvent e) {
206        if (Control.SHOW_PROPERTY) {
207            log.debug("Property change: ({}) old: ({}) new: ({})", e.getPropertyName(), e.getOldValue(), e
208                    .getNewValue());
209        }
210        if (e.getPropertyName().equals(ScheduleManager.LISTLENGTH_CHANGED_PROPERTY)
211                || e.getPropertyName().equals(Track.SCHEDULE_ID_CHANGED_PROPERTY)) {
212            updateScheduleComboBox();
213        }
214        if (e.getSource().getClass().equals(Schedule.class) && _track != null) {
215            textSchError.setText(_track.checkScheduleValid());
216        }
217        super.propertyChange(e);
218    }
219
220    private final static Logger log = LoggerFactory.getLogger(SpurEditFrame.class);
221}