Source code

001package jmri.jmrit.operations.locations.gui;
002
003import java.beans.PropertyChangeEvent;
004import java.beans.PropertyChangeListener;
005import java.util.ArrayList;
006import java.util.List;
007
008import javax.swing.*;
009import javax.swing.table.TableCellEditor;
010
011import org.slf4j.Logger;
012import org.slf4j.LoggerFactory;
013
014import jmri.InstanceManager;
015import jmri.jmrit.operations.locations.Location;
016import jmri.jmrit.operations.locations.LocationManager;
017import jmri.jmrit.operations.setup.Control;
018import jmri.jmrit.operations.setup.Setup;
019import jmri.util.swing.XTableColumnModel;
020import jmri.util.table.ButtonEditor;
021import jmri.util.table.ButtonRenderer;
022
023/**
024 * Table Model for edit of locations used by operations
025 *
026 * @author Daniel Boudreau Copyright (C) 2008, 2013
027 */
028public class LocationsTableModel extends javax.swing.table.AbstractTableModel implements PropertyChangeListener {
029
030    LocationManager locationManager; // There is only one manager
031    protected JTable _table;
032
033    // Define the columns
034    public static final int ID_COLUMN = 0;
035    public static final int NAME_COLUMN = 1;
036    public static final int TRACK_COLUMN = 2;
037    public static final int NUMBER_COLUMN = 3;
038    public static final int LENGTH_COLUMN = 4;
039    public static final int USED_LENGTH_COLUMN = 5;
040    public static final int ROLLINGSTOCK_COLUMN = 6;
041    protected static final int CARS_COLUMN = 7;
042    protected static final int LOCOS_COLUMN = 8;
043    public static final int PICKUPS_COLUMN = 9;
044    public static final int DROPS_COLUMN = 10;
045    public static final int DIVISION_COLUMN = 11;
046    public static final int REPORTER_COLUMN = 12;
047    public static final int ACTION_COLUMN = 13;
048    public static final int EDIT_COLUMN = 14;
049
050    private static final int HIGHEST_COLUMN = EDIT_COLUMN + 1;
051
052    public LocationsTableModel() {
053        super();
054        locationManager = InstanceManager.getDefault(LocationManager.class);
055        locationManager.addPropertyChangeListener(this);
056        updateList();
057    }
058
059    public final int SORTBYNAME = 1;
060    public final int SORTBYID = 2;
061
062    private int _sort = SORTBYNAME;
063
064    public void setSort(int sort) {
065        _sort = sort;
066        updateList();
067        setColumnsVisible();
068        fireTableDataChanged();
069    }
070
071    private void updateList() {
072        // first, remove listeners from the individual objects
073        removePropertyChangeLocations();
074
075        if (_sort == SORTBYID) {
076            locationsList = locationManager.getLocationsByIdList();
077        } else {
078            locationsList = locationManager.getLocationsByNameList();
079        }
080        // and add them back in
081        for (Location loc : locationsList) {
082            loc.addPropertyChangeListener(this);
083        }
084    }
085
086    List<Location> locationsList = null;
087
088    void initTable(LocationsTableFrame frame, JTable table) {
089        _table = table;
090        // Use XTableColumnModel so we can control which columns are visible
091        XTableColumnModel tcm = new XTableColumnModel();
092        table.setColumnModel(tcm);
093        table.createDefaultColumnsFromModel();
094        // Install the button handlers
095        ButtonRenderer buttonRenderer = new ButtonRenderer();
096        TableCellEditor buttonEditor = new ButtonEditor(new javax.swing.JButton());
097        tcm.getColumn(ACTION_COLUMN).setCellRenderer(buttonRenderer);
098        tcm.getColumn(ACTION_COLUMN).setCellEditor(buttonEditor);
099        tcm.getColumn(EDIT_COLUMN).setCellRenderer(buttonRenderer);
100        tcm.getColumn(EDIT_COLUMN).setCellEditor(buttonEditor);
101
102        // set column preferred widths
103        table.getColumnModel().getColumn(ID_COLUMN).setPreferredWidth(40);
104        table.getColumnModel().getColumn(NAME_COLUMN).setPreferredWidth(200);
105        table.getColumnModel().getColumn(TRACK_COLUMN).setPreferredWidth(Math.max(60, new JLabel(
106                Bundle.getMessage("Class/Interchange") + Bundle.getMessage("Spurs") + Bundle.getMessage("Yards"))
107                        .getPreferredSize().width +
108                20));
109        table.getColumnModel().getColumn(NUMBER_COLUMN).setPreferredWidth(40);
110        table.getColumnModel().getColumn(LENGTH_COLUMN).setPreferredWidth(
111                Math.max(60, new JLabel(getColumnName(LENGTH_COLUMN)).getPreferredSize().width + 10));
112        table.getColumnModel().getColumn(USED_LENGTH_COLUMN).setPreferredWidth(60);
113        table.getColumnModel().getColumn(ROLLINGSTOCK_COLUMN).setPreferredWidth(
114                Math.max(80, new JLabel(getColumnName(ROLLINGSTOCK_COLUMN)).getPreferredSize().width + 10));
115        table.getColumnModel().getColumn(CARS_COLUMN).setPreferredWidth(60);
116        table.getColumnModel().getColumn(LOCOS_COLUMN).setPreferredWidth(60);
117        table.getColumnModel().getColumn(PICKUPS_COLUMN).setPreferredWidth(
118                Math.max(60, new JLabel(getColumnName(PICKUPS_COLUMN)).getPreferredSize().width + 10));
119        table.getColumnModel().getColumn(DROPS_COLUMN)
120                .setPreferredWidth(Math.max(60, new JLabel(getColumnName(DROPS_COLUMN)).getPreferredSize().width + 10));
121        table.getColumnModel().getColumn(DIVISION_COLUMN).setPreferredWidth(160);
122        table.getColumnModel().getColumn(ACTION_COLUMN).setPreferredWidth(
123                Math.max(80, new JLabel(Bundle.getMessage("Yardmaster")).getPreferredSize().width + 40));
124        table.getColumnModel().getColumn(EDIT_COLUMN).setPreferredWidth(80);
125
126        frame.loadTableDetails(table);
127        setColumnsVisible();
128    }
129
130    protected void setColumnsVisible() {
131        XTableColumnModel tcm = (XTableColumnModel) _table.getColumnModel();
132        tcm.setColumnVisible(tcm.getColumnByModelIndex(ID_COLUMN), locationManager.isShowIdEnabled());
133        tcm.setColumnVisible(tcm.getColumnByModelIndex(DIVISION_COLUMN), locationManager.hasDivisions());
134        tcm.setColumnVisible(tcm.getColumnByModelIndex(REPORTER_COLUMN),
135                Setup.isRfidEnabled() && locationManager.hasReporters());
136    }
137
138    @Override
139    public int getRowCount() {
140        return locationsList.size();
141    }
142
143    @Override
144    public int getColumnCount() {
145        return HIGHEST_COLUMN;
146    }
147
148    @Override
149    public String getColumnName(int col) {
150        switch (col) {
151            case ID_COLUMN:
152                return Bundle.getMessage("Id");
153            case NAME_COLUMN:
154                return Bundle.getMessage("Name");
155            case TRACK_COLUMN:
156                return Bundle.getMessage("Track");
157            case NUMBER_COLUMN:
158                return Bundle.getMessage("Number");
159            case LENGTH_COLUMN:
160                return Bundle.getMessage("Length");
161            case USED_LENGTH_COLUMN:
162                return Bundle.getMessage("Used");
163            case ROLLINGSTOCK_COLUMN:
164                return Bundle.getMessage("RollingStock");
165            case LOCOS_COLUMN:
166                return Bundle.getMessage("Engines");
167            case CARS_COLUMN:
168                return Bundle.getMessage("Cars");
169            case PICKUPS_COLUMN:
170                return Bundle.getMessage("Pickups");
171            case DROPS_COLUMN:
172                return Bundle.getMessage("Drop");
173            case DIVISION_COLUMN:
174                return Bundle.getMessage("Division");
175            case REPORTER_COLUMN:
176                return Bundle.getMessage("Reporters");
177            case ACTION_COLUMN:
178                return Bundle.getMessage("Action");
179            case EDIT_COLUMN:
180                return Bundle.getMessage("ButtonEdit"); // titles above all columns
181            default:
182                return "unknown"; // NOI18N
183        }
184    }
185
186    @Override
187    public Class<?> getColumnClass(int col) {
188        switch (col) {
189            case NAME_COLUMN:
190            case TRACK_COLUMN:
191            case DIVISION_COLUMN:
192            case REPORTER_COLUMN:
193                return String.class;
194            case ID_COLUMN:
195            case NUMBER_COLUMN:
196            case LENGTH_COLUMN:
197            case USED_LENGTH_COLUMN:
198            case ROLLINGSTOCK_COLUMN:
199            case LOCOS_COLUMN:
200            case CARS_COLUMN:
201            case PICKUPS_COLUMN:
202            case DROPS_COLUMN:
203                return Integer.class;
204            case ACTION_COLUMN:
205            case EDIT_COLUMN:
206                return JButton.class;
207            default:
208                return null;
209        }
210    }
211
212    @Override
213    public boolean isCellEditable(int row, int col) {
214        switch (col) {
215            case EDIT_COLUMN:
216            case ACTION_COLUMN:
217                return true;
218            default:
219                return false;
220        }
221    }
222
223    @Override
224    public Object getValueAt(int row, int col) {
225        if (row >= getRowCount()) {
226            return "ERROR row " + row; // NOI18N
227        }
228        Location location = locationsList.get(row);
229        if (location == null) {
230            return "ERROR location unknown " + row; // NOI18N
231        }
232        switch (col) {
233            case ID_COLUMN:
234                return Integer.parseInt(location.getId());
235            case NAME_COLUMN:
236                return location.getName();
237            case TRACK_COLUMN:
238                return getTrackTypes(location);
239            case NUMBER_COLUMN:
240                return location.getTracksList().size();
241            case LENGTH_COLUMN:
242                return location.getLength();
243            case USED_LENGTH_COLUMN:
244                return location.getUsedLength();
245            case ROLLINGSTOCK_COLUMN:
246                return location.getNumberRS();
247            case LOCOS_COLUMN:
248                return location.getNumberEngines();
249            case CARS_COLUMN:
250                return location.getNumberCars();
251            case PICKUPS_COLUMN:
252                return location.getPickupRS();
253            case DROPS_COLUMN:
254                return location.getDropRS();
255            case DIVISION_COLUMN:
256                return location.getDivisionName();
257            case REPORTER_COLUMN:
258                return location.getReporterName();
259            case ACTION_COLUMN:
260                return Bundle.getMessage("Yardmaster");
261            case EDIT_COLUMN:
262                return Bundle.getMessage("ButtonEdit");
263            default:
264                return "unknown " + col; // NOI18N
265        }
266    }
267
268    private String getTrackTypes(Location location) {
269        if (location.isStaging()) {
270            return (Bundle.getMessage("Staging"));
271        } else {
272            StringBuffer sb = new StringBuffer();
273            if (location.hasInterchanges()) {
274                sb.append(Bundle.getMessage("Class/Interchange") + " ");
275            }
276            if (location.hasSpurs()) {
277                sb.append(Bundle.getMessage("Spurs") + " ");
278            }
279            if (location.hasYards()) {
280                sb.append(Bundle.getMessage("Yards"));
281            }
282            return sb.toString();
283        }
284    }
285
286    @Override
287    public void setValueAt(Object value, int row, int col) {
288        switch (col) {
289            case ACTION_COLUMN:
290                launchYardmaster(row);
291                break;
292            case EDIT_COLUMN:
293                editLocation(row);
294                break;
295            default:
296                break;
297        }
298    }
299
300    List<LocationEditFrame> frameList = new ArrayList<LocationEditFrame>();
301
302    private void editLocation(int row) {
303        // use invokeLater so new window appears on top
304        SwingUtilities.invokeLater(() -> {
305            Location loc = locationsList.get(row);
306            log.debug("Edit location ({})", loc.getName());
307            for (LocationEditFrame lef : frameList) {
308                if (lef._location == loc) {
309                    lef.dispose();
310                    frameList.remove(lef);
311                    break;
312                }
313            }
314            LocationEditFrame lef = new LocationEditFrame(loc);
315            frameList.add(lef);
316        });
317    }
318
319    private void launchYardmaster(int row) {
320        // use invokeLater so new window appears on top
321        SwingUtilities.invokeLater(() -> {
322            log.debug("Yardmaster");
323            Location loc = locationsList.get(row);
324            new YardmasterFrame(loc);
325        });
326    }
327
328    @Override
329    public void propertyChange(PropertyChangeEvent e) {
330        if (Control.SHOW_PROPERTY) {
331            log.debug("Property change: ({}) old: ({}) new: ({})", e.getPropertyName(), e.getOldValue(),
332                    e.getNewValue());
333        }
334        if (e.getPropertyName().equals(LocationManager.LISTLENGTH_CHANGED_PROPERTY)) {
335            updateList();
336            fireTableDataChanged();
337        } else if (e.getSource().getClass().equals(Location.class)) {
338            Location loc = (Location) e.getSource();
339            int row = locationsList.indexOf(loc);
340            if (Control.SHOW_PROPERTY) {
341                log.debug("Update location table row: {} name: {}", row, loc.getName());
342            }
343            if (row >= 0) {
344                fireTableRowsUpdated(row, row);
345            }
346            if (e.getPropertyName().equals(Location.LOCATION_REPORTER_CHANGED_PROPERTY) ||
347                    e.getPropertyName().equals(Location.LOCATION_DIVISION_CHANGED_PROPERTY)) {
348                setColumnsVisible();
349            }
350        }
351    }
352
353    private void removePropertyChangeLocations() {
354        if (locationsList != null) {
355            for (Location loc : locationsList) {
356                loc.removePropertyChangeListener(this);
357            }
358        }
359    }
360
361    public void dispose() {
362        for (LocationEditFrame lef : frameList) {
363            lef.dispose();
364        }
365        locationManager.removePropertyChangeListener(this);
366        removePropertyChangeLocations();
367    }
368
369    private final static Logger log = LoggerFactory.getLogger(LocationsTableModel.class);
370}