-
Notifications
You must be signed in to change notification settings - Fork 331
/
LayoutEditor.java
8741 lines (7595 loc) · 337 KB
/
LayoutEditor.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package jmri.jmrit.display.layoutEditor;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.awt.*;
import java.awt.event.*;
import java.awt.geom.Point2D;
import java.awt.geom.Rectangle2D;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyVetoException;
import java.io.File;
import java.lang.reflect.Field;
import java.text.MessageFormat;
import java.util.List;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import javax.imageio.ImageIO;
import javax.swing.*;
import javax.swing.event.PopupMenuEvent;
import javax.swing.event.PopupMenuListener;
import javax.swing.filechooser.FileNameExtensionFilter;
import jmri.*;
import jmri.configurexml.StoreXmlUserAction;
import jmri.jmrit.catalog.NamedIcon;
import jmri.jmrit.dispatcher.DispatcherAction;
import jmri.jmrit.dispatcher.DispatcherFrame;
import jmri.jmrit.display.*;
import jmri.jmrit.display.layoutEditor.LayoutEditorDialogs.*;
import jmri.jmrit.display.layoutEditor.LayoutEditorToolBarPanel.LocationFormat;
import jmri.jmrit.display.panelEditor.PanelEditor;
import jmri.jmrit.entryexit.AddEntryExitPairAction;
import jmri.swing.NamedBeanComboBox;
import jmri.util.*;
import jmri.util.swing.JComboBoxUtil;
import jmri.util.swing.JmriColorChooser;
/**
* Provides a scrollable Layout Panel and editor toolbars (that can be hidden)
* <p>
* This module serves as a manager for the LayoutTurnout, Layout Block,
* PositionablePoint, Track Segment, LayoutSlip and LevelXing objects which are
* integral subparts of the LayoutEditor class.
* <p>
* All created objects are put on specific levels depending on their type
* (higher levels are in front): Note that higher numbers appear behind lower
* numbers.
* <p>
* The "contents" List keeps track of all text and icon label objects added to
* the target frame for later manipulation. Other Lists keep track of drawn
* items.
* <p>
* Based in part on PanelEditor.java (Bob Jacobsen (c) 2002, 2003). In
* particular, text and icon label items are copied from Panel editor, as well
* as some of the control design.
*
* @author Dave Duchamp Copyright: (c) 2004-2007
* @author George Warner Copyright: (c) 2017-2019
*/
final public class LayoutEditor extends PanelEditor implements MouseWheelListener, LayoutModels {
// Operational instance variables - not saved to disk
private JmriJFrame floatingEditToolBoxFrame = null;
private JScrollPane floatingEditContentScrollPane = null;
private JPanel floatEditHelpPanel = null;
private JPanel editToolBarContainerPanel = null;
private JScrollPane editToolBarScrollPane = null;
private JPanel helpBarPanel = null;
private final JPanel helpBar = new JPanel();
private final boolean editorUseOldLocSize;
private LayoutEditorToolBarPanel leToolBarPanel = null;
@Nonnull
public LayoutEditorToolBarPanel getLayoutEditorToolBarPanel() {
return leToolBarPanel;
}
// end of main panel controls
private boolean delayedPopupTrigger = false;
private Point2D currentPoint = new Point2D.Double(100.0, 100.0);
private Point2D dLoc = new Point2D.Double(0.0, 0.0);
private int toolbarHeight = 100;
private int toolbarWidth = 100;
private TrackSegment newTrack = null;
private boolean panelChanged = false;
// size of point boxes
public static final double SIZE = 3.0;
public static final double SIZE2 = SIZE * 2.; // must be twice SIZE
public Color turnoutCircleColor = Color.black; // matches earlier versions
public Color turnoutCircleThrownColor = Color.black;
private boolean turnoutFillControlCircles = false;
private int turnoutCircleSize = 4; // matches earlier versions
// use turnoutCircleSize when you need an int and these when you need a double
// note: these only change when setTurnoutCircleSize is called
// using these avoids having to call getTurnoutCircleSize() and
// the multiply (x2) and the int -> double conversion overhead
public double circleRadius = SIZE * getTurnoutCircleSize();
public double circleDiameter = 2.0 * circleRadius;
// selection variables
public boolean selectionActive = false;
private double selectionX = 0.0;
private double selectionY = 0.0;
public double selectionWidth = 0.0;
public double selectionHeight = 0.0;
// Option menu items
private JCheckBoxMenuItem editModeCheckBoxMenuItem = null;
private JRadioButtonMenuItem toolBarSideTopButton = null;
private JRadioButtonMenuItem toolBarSideLeftButton = null;
private JRadioButtonMenuItem toolBarSideBottomButton = null;
private JRadioButtonMenuItem toolBarSideRightButton = null;
private JRadioButtonMenuItem toolBarSideFloatButton = null;
private final JCheckBoxMenuItem wideToolBarCheckBoxMenuItem = new JCheckBoxMenuItem(Bundle.getMessage("ToolBarWide"));
private JCheckBoxMenuItem positionableCheckBoxMenuItem = null;
private JCheckBoxMenuItem controlCheckBoxMenuItem = null;
private JCheckBoxMenuItem animationCheckBoxMenuItem = null;
private JCheckBoxMenuItem showHelpCheckBoxMenuItem = null;
private JCheckBoxMenuItem showGridCheckBoxMenuItem = null;
private JCheckBoxMenuItem autoAssignBlocksCheckBoxMenuItem = null;
private JMenu scrollMenu = null;
private JRadioButtonMenuItem scrollBothMenuItem = null;
private JRadioButtonMenuItem scrollNoneMenuItem = null;
private JRadioButtonMenuItem scrollHorizontalMenuItem = null;
private JRadioButtonMenuItem scrollVerticalMenuItem = null;
private JMenu tooltipMenu = null;
private JRadioButtonMenuItem tooltipAlwaysMenuItem = null;
private JRadioButtonMenuItem tooltipNoneMenuItem = null;
private JRadioButtonMenuItem tooltipInEditMenuItem = null;
private JRadioButtonMenuItem tooltipNotInEditMenuItem = null;
private JCheckBoxMenuItem pixelsCheckBoxMenuItem = new JCheckBoxMenuItem(Bundle.getMessage("Pixels"));
private JCheckBoxMenuItem metricCMCheckBoxMenuItem = new JCheckBoxMenuItem(Bundle.getMessage("MetricCM"));
private JCheckBoxMenuItem englishFeetInchesCheckBoxMenuItem = new JCheckBoxMenuItem(Bundle.getMessage("EnglishFeetInches"));
private JCheckBoxMenuItem snapToGridOnAddCheckBoxMenuItem = null;
private JCheckBoxMenuItem snapToGridOnMoveCheckBoxMenuItem = null;
private JCheckBoxMenuItem antialiasingOnCheckBoxMenuItem = null;
private JCheckBoxMenuItem drawLayoutTracksLabelCheckBoxMenuItem = null;
private JCheckBoxMenuItem turnoutCirclesOnCheckBoxMenuItem = null;
private JCheckBoxMenuItem turnoutDrawUnselectedLegCheckBoxMenuItem = null;
private JCheckBoxMenuItem turnoutFillControlCirclesCheckBoxMenuItem = null;
private JCheckBoxMenuItem hideTrackSegmentConstructionLinesCheckBoxMenuItem = null;
private JCheckBoxMenuItem useDirectTurnoutControlCheckBoxMenuItem = null;
private ButtonGroup turnoutCircleSizeButtonGroup = null;
private boolean turnoutDrawUnselectedLeg = true;
private boolean autoAssignBlocks = false;
// Tools menu items
private final JMenu zoomMenu = new JMenu(Bundle.getMessage("MenuZoom"));
private final JRadioButtonMenuItem zoom025Item = new JRadioButtonMenuItem("x 0.25");
private final JRadioButtonMenuItem zoom05Item = new JRadioButtonMenuItem("x 0.5");
private final JRadioButtonMenuItem zoom075Item = new JRadioButtonMenuItem("x 0.75");
private final JRadioButtonMenuItem noZoomItem = new JRadioButtonMenuItem(Bundle.getMessage("NoZoom"));
private final JRadioButtonMenuItem zoom15Item = new JRadioButtonMenuItem("x 1.5");
private final JRadioButtonMenuItem zoom20Item = new JRadioButtonMenuItem("x 2.0");
private final JRadioButtonMenuItem zoom30Item = new JRadioButtonMenuItem("x 3.0");
private final JRadioButtonMenuItem zoom40Item = new JRadioButtonMenuItem("x 4.0");
private final JRadioButtonMenuItem zoom50Item = new JRadioButtonMenuItem("x 5.0");
private final JRadioButtonMenuItem zoom60Item = new JRadioButtonMenuItem("x 6.0");
private final JRadioButtonMenuItem zoom70Item = new JRadioButtonMenuItem("x 7.0");
private final JRadioButtonMenuItem zoom80Item = new JRadioButtonMenuItem("x 8.0");
private final JMenuItem undoTranslateSelectionMenuItem = new JMenuItem(Bundle.getMessage("UndoTranslateSelection"));
private final JMenuItem assignBlockToSelectionMenuItem = new JMenuItem(Bundle.getMessage("AssignBlockToSelectionTitle") + "...");
// Selected point information
private Point2D startDelta = new Point2D.Double(0.0, 0.0); // starting delta coordinates
public Object selectedObject = null; // selected object, null if nothing selected
public Object prevSelectedObject = null; // previous selected object, for undo
private HitPointType selectedHitPointType = HitPointType.NONE; // hit point type within the selected object
public LayoutTrack foundTrack = null; // found object, null if nothing found
public LayoutTrackView foundTrackView = null; // found view object, null if nothing found
private Point2D foundLocation = new Point2D.Double(0.0, 0.0); // location of found object
public HitPointType foundHitPointType = HitPointType.NONE; // connection type within the found object
public LayoutTrack beginTrack = null; // begin track segment connection object, null if none
public Point2D beginLocation = new Point2D.Double(0.0, 0.0); // location of begin object
private HitPointType beginHitPointType = HitPointType.NONE; // connection type within begin connection object
public Point2D currentLocation = new Point2D.Double(0.0, 0.0); // current location
// Lists of items that describe the Layout, and allow it to be drawn
// Each of the items must be saved to disk over sessions
private List<AnalogClock2Display> clocks = new ArrayList<>(); // fast clocks
private List<LocoIcon> markerImage = new ArrayList<>(); // marker images
private List<MultiSensorIcon> multiSensors = new ArrayList<>(); // multi-sensor images
private List<PositionableLabel> backgroundImage = new ArrayList<>(); // background images
private List<PositionableLabel> labelImage = new ArrayList<>(); // positionable label images
private List<SensorIcon> sensorImage = new ArrayList<>(); // sensor images
private List<SignalHeadIcon> signalHeadImage = new ArrayList<>(); // signal head images
// PositionableLabel's
private List<BlockContentsIcon> blockContentsLabelList = new ArrayList<>(); // BlockContentsIcon Label List
private List<MemoryIcon> memoryLabelList = new ArrayList<>(); // Memory Label List
private List<SensorIcon> sensorList = new ArrayList<>(); // Sensor Icons
private List<SignalHeadIcon> signalList = new ArrayList<>(); // Signal Head Icons
private List<SignalMastIcon> signalMastList = new ArrayList<>(); // Signal Mast Icons
public final LayoutEditorViewContext gContext = new LayoutEditorViewContext(); // public for now, as things work access changes
@Nonnull
public List<SensorIcon> getSensorList() {
return sensorList;
}
@Nonnull
public List<PositionableLabel> getLabelImageList() {
return labelImage;
}
@Nonnull
public List<BlockContentsIcon> getBlockContentsLabelList() {
return blockContentsLabelList;
}
@Nonnull
public List<MemoryIcon> getMemoryLabelList() {
return memoryLabelList;
}
@Nonnull
public List<SignalHeadIcon> getSignalList() {
return signalList;
}
@Nonnull
public List<SignalMastIcon> getSignalMastList() {
return signalMastList;
}
private final List<LayoutShape> layoutShapes = new ArrayList<>(); // LayoutShap list
// counts used to determine unique internal names
private int numAnchors = 0;
private int numEndBumpers = 0;
private int numEdgeConnectors = 0;
private int numTrackSegments = 0;
private int numLevelXings = 0;
private int numLayoutSlips = 0;
private int numLayoutTurnouts = 0;
private int numLayoutTurntables = 0;
private int numShapes = 0;
private LayoutEditorFindItems finder = new LayoutEditorFindItems(this);
@Nonnull
public LayoutEditorFindItems getFinder() {
return finder;
}
private Color mainlineTrackColor = Color.DARK_GRAY;
private Color sidelineTrackColor = Color.DARK_GRAY;
public Color defaultTrackColor = Color.DARK_GRAY;
private Color defaultOccupiedTrackColor = Color.red;
private Color defaultAlternativeTrackColor = Color.white;
private Color defaultTextColor = Color.black;
private String layoutName = "";
private boolean animatingLayout = true;
private boolean showHelpBar = true;
private boolean drawGrid = true;
private boolean snapToGridOnAdd = false;
private boolean snapToGridOnMove = false;
private boolean snapToGridInvert = false;
private boolean antialiasingOn = false;
private boolean drawLayoutTracksLabel = false;
private boolean highlightSelectedBlockFlag = false;
private boolean turnoutCirclesWithoutEditMode = false;
private boolean tooltipsWithoutEditMode = false;
private boolean tooltipsInEditMode = true;
// turnout size parameters - saved with panel
private double turnoutBX = LayoutTurnout.turnoutBXDefault; // RH, LH, WYE
private double turnoutCX = LayoutTurnout.turnoutCXDefault;
private double turnoutWid = LayoutTurnout.turnoutWidDefault;
private double xOverLong = LayoutTurnout.xOverLongDefault; // DOUBLE_XOVER, RH_XOVER, LH_XOVER
private double xOverHWid = LayoutTurnout.xOverHWidDefault;
private double xOverShort = LayoutTurnout.xOverShortDefault;
private boolean useDirectTurnoutControl = false; // Uses Left click for closing points, Right click for throwing.
// saved state of options when panel was loaded or created
private boolean savedEditMode = true;
private boolean savedPositionable = true;
private boolean savedControlLayout = true;
private boolean savedAnimatingLayout = true;
private boolean savedShowHelpBar = true;
// zoom
private double minZoom = 0.25;
private final double maxZoom = 8.0;
// A hash to store string -> KeyEvent constants, used to set keyboard shortcuts per locale
private HashMap<String, Integer> stringsToVTCodes = new HashMap<>();
/*==============*\
|* Toolbar side *|
\*==============*/
private enum ToolBarSide {
eTOP("top"),
eLEFT("left"),
eBOTTOM("bottom"),
eRIGHT("right"),
eFLOAT("float");
private final String name;
private static final Map<String, ToolBarSide> ENUM_MAP;
ToolBarSide(String name) {
this.name = name;
}
// Build an immutable map of String name to enum pairs.
static {
Map<String, ToolBarSide> map = new ConcurrentHashMap<>();
for (ToolBarSide instance : ToolBarSide.values()) {
map.put(instance.getName(), instance);
}
ENUM_MAP = Collections.unmodifiableMap(map);
}
public static ToolBarSide getName(@CheckForNull String name) {
return ENUM_MAP.get(name);
}
public String getName() {
return name;
}
}
private ToolBarSide toolBarSide = ToolBarSide.eTOP;
public LayoutEditor() {
this("My Layout");
}
public LayoutEditor(@Nonnull String name) {
super(name);
setSaveSize(true);
layoutName = name;
editorUseOldLocSize = InstanceManager.getDefault(jmri.util.gui.GuiLafPreferencesManager.class).isEditorUseOldLocSize();
// initialise keycode map
initStringsToVTCodes();
setupToolBar();
setupMenuBar();
super.setDefaultToolTip(new ToolTip(null, 0, 0, new Font("SansSerif", Font.PLAIN, 12),
Color.black, new Color(215, 225, 255), Color.black));
// setup help bar
helpBar.setLayout(new BoxLayout(helpBar, BoxLayout.PAGE_AXIS));
JTextArea helpTextArea1 = new JTextArea(Bundle.getMessage("Help1"));
helpBar.add(helpTextArea1);
JTextArea helpTextArea2 = new JTextArea(Bundle.getMessage("Help2"));
helpBar.add(helpTextArea2);
String helpText3 = "";
switch (SystemType.getType()) {
case SystemType.MACOSX: {
helpText3 = Bundle.getMessage("Help3Mac");
break;
}
case SystemType.WINDOWS:
case SystemType.LINUX: {
helpText3 = Bundle.getMessage("Help3Win");
break;
}
default:
helpText3 = Bundle.getMessage("Help3");
}
JTextArea helpTextArea3 = new JTextArea(helpText3);
helpBar.add(helpTextArea3);
// set to full screen
Dimension screenDim = Toolkit.getDefaultToolkit().getScreenSize();
gContext.setWindowWidth(screenDim.width - 20);
gContext.setWindowHeight(screenDim.height - 120);
// Let Editor make target, and use this frame
super.setTargetPanel(null, null);
super.setTargetPanelSize(gContext.getWindowWidth(), gContext.getWindowHeight());
setSize(screenDim.width, screenDim.height);
// register the resulting panel for later configuration
InstanceManager.getOptionalDefault(ConfigureManager.class)
.ifPresent(cm -> cm.registerUser(this));
// confirm that panel hasn't already been loaded
if (!this.equals(InstanceManager.getDefault(EditorManager.class).get(name))) {
log.warn("File contains a panel with the same name ({}) as an existing panel", name);
}
setFocusable(true);
addKeyListener(this);
resetDirty();
// establish link to LayoutEditor Tools
auxTools = getLEAuxTools();
SwingUtilities.invokeLater(() -> {
// initialize preferences
InstanceManager.getOptionalDefault(UserPreferencesManager.class).ifPresent((prefsMgr) -> {
String windowFrameRef = getWindowFrameRef();
Object prefsProp = prefsMgr.getProperty(windowFrameRef, "toolBarSide");
// log.debug("{}.toolBarSide is {}", windowFrameRef, prefsProp);
if (prefsProp != null) {
ToolBarSide newToolBarSide = ToolBarSide.getName((String) prefsProp);
setToolBarSide(newToolBarSide);
}
// Note: since prefs default to false and we want wide to be the default
// we invert it and save it as thin
boolean prefsToolBarIsWide = prefsMgr.getSimplePreferenceState(windowFrameRef + ".toolBarThin");
log.debug("{}.toolBarThin is {}", windowFrameRef, prefsProp);
setToolBarWide(prefsToolBarIsWide);
boolean prefsShowHelpBar = prefsMgr.getSimplePreferenceState(windowFrameRef + ".showHelpBar");
// log.debug("{}.showHelpBar is {}", windowFrameRef, prefsShowHelpBar);
setShowHelpBar(prefsShowHelpBar);
boolean prefsAntialiasingOn = prefsMgr.getSimplePreferenceState(windowFrameRef + ".antialiasingOn");
// log.debug("{}.antialiasingOn is {}", windowFrameRef, prefsAntialiasingOn);
setAntialiasingOn(prefsAntialiasingOn);
boolean prefsDrawLayoutTracksLabel = prefsMgr.getSimplePreferenceState(windowFrameRef + ".drawLayoutTracksLabel");
// log.debug("{}.drawLayoutTracksLabel is {}", windowFrameRef, prefsDrawLayoutTracksLabel);
setDrawLayoutTracksLabel(prefsDrawLayoutTracksLabel);
boolean prefsHighlightSelectedBlockFlag
= prefsMgr.getSimplePreferenceState(windowFrameRef + ".highlightSelectedBlock");
// log.debug("{}.highlightSelectedBlock is {}", windowFrameRef, prefsHighlightSelectedBlockFlag);
setHighlightSelectedBlock(prefsHighlightSelectedBlockFlag);
}); // InstanceManager.getOptionalDefault(UserPreferencesManager.class).ifPresent((prefsMgr)
// make sure that the layoutEditorComponent is in the _targetPanel components
List<Component> componentList = Arrays.asList(_targetPanel.getComponents());
if (!componentList.contains(layoutEditorComponent)) {
try {
_targetPanel.remove(layoutEditorComponent);
_targetPanel.add(layoutEditorComponent, Integer.valueOf(3));
_targetPanel.moveToFront(layoutEditorComponent);
} catch (Exception e) {
log.warn("paintTargetPanelBefore: ", e);
}
}
});
}
private void setupMenuBar() {
// initialize menu bar
JMenuBar menuBar = new JMenuBar();
// set up File menu
JMenu fileMenu = new JMenu(Bundle.getMessage("MenuFile"));
fileMenu.setMnemonic(stringsToVTCodes.get(Bundle.getMessage("MenuFileMnemonic")));
menuBar.add(fileMenu);
StoreXmlUserAction store = new StoreXmlUserAction(Bundle.getMessage("FileMenuItemStore"));
int primary_modifier = Toolkit.getDefaultToolkit().getMenuShortcutKeyMask();
store.putValue(Action.ACCELERATOR_KEY, KeyStroke.getKeyStroke(
stringsToVTCodes.get(Bundle.getMessage("MenuItemStoreAccelerator")), primary_modifier));
fileMenu.add(store);
fileMenu.addSeparator();
JMenuItem deleteItem = new JMenuItem(Bundle.getMessage("DeletePanel"));
fileMenu.add(deleteItem);
deleteItem.addActionListener((ActionEvent event) -> {
if (deletePanel()) {
dispose();
}
});
setJMenuBar(menuBar);
// setup Options menu
setupOptionMenu(menuBar);
// setup Tools menu
setupToolsMenu(menuBar);
// setup Zoom menu
setupZoomMenu(menuBar);
// setup marker menu
setupMarkerMenu(menuBar);
// Setup Dispatcher window
setupDispatcherMenu(menuBar);
// setup Help menu
addHelpMenu("package.jmri.jmrit.display.LayoutEditor", true);
}
@Override
public void newPanelDefaults() {
getLayoutTrackDrawingOptions().setMainRailWidth(2);
getLayoutTrackDrawingOptions().setSideRailWidth(1);
setBackgroundColor(defaultBackgroundColor);
JmriColorChooser.addRecentColor(defaultTrackColor);
JmriColorChooser.addRecentColor(defaultOccupiedTrackColor);
JmriColorChooser.addRecentColor(defaultAlternativeTrackColor);
JmriColorChooser.addRecentColor(defaultBackgroundColor);
JmriColorChooser.addRecentColor(defaultTextColor);
}
private final LayoutEditorComponent layoutEditorComponent = new LayoutEditorComponent(this);
private void setupToolBar() {
// Initial setup for both horizontal and vertical
Container contentPane = getContentPane();
// remove these (if present) so we can add them back (without duplicates)
if (editToolBarContainerPanel != null) {
editToolBarContainerPanel.setVisible(false);
contentPane.remove(editToolBarContainerPanel);
}
if (helpBarPanel != null) {
contentPane.remove(helpBarPanel);
}
deletefloatingEditToolBoxFrame();
if (toolBarSide.equals(ToolBarSide.eFLOAT)) {
createfloatingEditToolBoxFrame();
createFloatingHelpPanel();
return;
}
Dimension screenDim = Toolkit.getDefaultToolkit().getScreenSize();
boolean toolBarIsVertical = (toolBarSide.equals(ToolBarSide.eRIGHT) || toolBarSide.equals(ToolBarSide.eLEFT));
if (toolBarIsVertical) {
leToolBarPanel = new LayoutEditorVerticalToolBarPanel(this);
editToolBarScrollPane = new JScrollPane(leToolBarPanel);
toolbarWidth = editToolBarScrollPane.getPreferredSize().width;
toolbarHeight = screenDim.height;
} else {
leToolBarPanel = new LayoutEditorHorizontalToolBarPanel(this);
editToolBarScrollPane = new JScrollPane(leToolBarPanel);
toolbarWidth = screenDim.width;
toolbarHeight = editToolBarScrollPane.getPreferredSize().height;
}
editToolBarContainerPanel = new JPanel();
editToolBarContainerPanel.setLayout(new BoxLayout(editToolBarContainerPanel, BoxLayout.PAGE_AXIS));
editToolBarContainerPanel.add(editToolBarScrollPane);
// setup notification for when horizontal scrollbar changes visibility
// editToolBarScroll.getViewport().addChangeListener(e -> {
// log.warn("scrollbars visible: " + editToolBarScroll.getHorizontalScrollBar().isVisible());
//});
editToolBarContainerPanel.setMinimumSize(new Dimension(toolbarWidth, toolbarHeight));
editToolBarContainerPanel.setPreferredSize(new Dimension(toolbarWidth, toolbarHeight));
helpBarPanel = new JPanel();
helpBarPanel.add(helpBar);
for (Component c : helpBar.getComponents()) {
if (c instanceof JTextArea) {
JTextArea j = (JTextArea) c;
j.setSize(new Dimension(toolbarWidth, j.getSize().height));
j.setLineWrap(toolBarIsVertical);
j.setWrapStyleWord(toolBarIsVertical);
}
}
contentPane.setLayout(new BoxLayout(contentPane, toolBarIsVertical ? BoxLayout.LINE_AXIS : BoxLayout.PAGE_AXIS));
switch (toolBarSide) {
case eTOP:
case eLEFT:
contentPane.add(editToolBarContainerPanel, 0);
break;
case eBOTTOM:
case eRIGHT:
contentPane.add(editToolBarContainerPanel);
break;
default:
// fall through
break;
}
if (toolBarIsVertical) {
editToolBarContainerPanel.add(helpBarPanel);
} else {
contentPane.add(helpBarPanel);
}
helpBarPanel.setVisible(isEditable() && getShowHelpBar());
editToolBarContainerPanel.setVisible(isEditable());
}
private void createfloatingEditToolBoxFrame() {
if (isEditable() && floatingEditToolBoxFrame == null) {
// Create a scroll pane to hold the window content.
leToolBarPanel = new LayoutEditorFloatingToolBarPanel(this);
floatingEditContentScrollPane = new JScrollPane(leToolBarPanel);
floatingEditContentScrollPane.setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
floatingEditContentScrollPane.setVerticalScrollBarPolicy(JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED);
// Create the window and add the toolbox content
floatingEditToolBoxFrame = new JmriJFrame(Bundle.getMessage("ToolBox", getLayoutName()));
floatingEditToolBoxFrame.setDefaultCloseOperation(JFrame.HIDE_ON_CLOSE);
floatingEditToolBoxFrame.setContentPane(floatingEditContentScrollPane);
floatingEditToolBoxFrame.pack();
floatingEditToolBoxFrame.setAlwaysOnTop(true);
floatingEditToolBoxFrame.setVisible(true);
}
}
private void deletefloatingEditToolBoxFrame() {
if (floatingEditContentScrollPane != null) {
floatingEditContentScrollPane.removeAll();
floatingEditContentScrollPane = null;
}
if (floatingEditToolBoxFrame != null) {
floatingEditToolBoxFrame.dispose();
floatingEditToolBoxFrame = null;
}
}
private void createFloatingHelpPanel() {
if (leToolBarPanel instanceof LayoutEditorFloatingToolBarPanel) {
LayoutEditorFloatingToolBarPanel leftbp = (LayoutEditorFloatingToolBarPanel) leToolBarPanel;
floatEditHelpPanel = new JPanel();
leToolBarPanel.add(floatEditHelpPanel);
// Notice: End tree structure indenting
// Force the help panel width to the same as the tabs section
int tabSectionWidth = (int) leftbp.getPreferredSize().getWidth();
// Change the textarea settings
for (Component c : helpBar.getComponents()) {
if (c instanceof JTextArea) {
JTextArea j = (JTextArea) c;
j.setSize(new Dimension(tabSectionWidth, j.getSize().height));
j.setLineWrap(true);
j.setWrapStyleWord(true);
}
}
// Change the width of the help panel section
floatEditHelpPanel.setMaximumSize(new Dimension(tabSectionWidth, Integer.MAX_VALUE));
floatEditHelpPanel.add(helpBar);
floatEditHelpPanel.setVisible(isEditable() && getShowHelpBar());
}
}
@Override
public void init(String name) {
}
@Override
public void initView() {
editModeCheckBoxMenuItem.setSelected(isEditable());
positionableCheckBoxMenuItem.setSelected(allPositionable());
controlCheckBoxMenuItem.setSelected(allControlling());
if (isEditable()) {
setAllShowToolTip(tooltipsInEditMode);
} else {
setAllShowToolTip(tooltipsWithoutEditMode);
}
scrollNoneMenuItem.setSelected(_scrollState == Editor.SCROLL_NONE);
scrollBothMenuItem.setSelected(_scrollState == Editor.SCROLL_BOTH);
scrollHorizontalMenuItem.setSelected(_scrollState == Editor.SCROLL_HORIZONTAL);
scrollVerticalMenuItem.setSelected(_scrollState == Editor.SCROLL_VERTICAL);
}
@Override
public void setSize(int w, int h) {
super.setSize(w, h);
}
@Override
public void targetWindowClosingEvent(WindowEvent e) {
boolean save = (isDirty() || (savedEditMode != isEditable())
|| (savedPositionable != allPositionable())
|| (savedControlLayout != allControlling())
|| (savedAnimatingLayout != isAnimating())
|| (savedShowHelpBar != getShowHelpBar()));
log.trace("Temp fix to disable CI errors: save = {}", save);
targetWindowClosing();
}
/**
* Set up NamedBeanComboBox
*
* @param inComboBox the NamedBeanComboBox to set up
* @param inValidateMode true to validate typed inputs; false otherwise
* @param inEnable boolean to enable / disable the NamedBeanComboBox
* @param inEditable boolean to make the NamedBeanComboBox editable
*/
public static void setupComboBox(@Nonnull NamedBeanComboBox<?> inComboBox, boolean inValidateMode, boolean inEnable, boolean inEditable) {
log.debug("LE setupComboBox called");
assert inComboBox != null;
inComboBox.setEnabled(inEnable);
inComboBox.setEditable(inEditable);
inComboBox.setValidatingInput(inValidateMode);
inComboBox.setSelectedIndex(-1);
// This has to be set before calling setupComboBoxMaxRows
// (otherwise if inFirstBlank then the number of rows will be wrong)
inComboBox.setAllowNull(!inValidateMode);
// set the max number of rows that will fit onscreen
JComboBoxUtil.setupComboBoxMaxRows(inComboBox);
inComboBox.setSelectedIndex(-1);
}
/**
* Grabs a subset of the possible KeyEvent constants and puts them into a
* hash for fast lookups later. These lookups are used to enable bundles to
* specify keyboard shortcuts on a per-locale basis.
*/
private void initStringsToVTCodes() {
Field[] fields = KeyEvent.class
.getFields();
for (Field field : fields) {
String name = field.getName();
if (name.startsWith("VK")) {
int code = 0;
try {
code = field.getInt(null);
} catch (IllegalAccessException | IllegalArgumentException e) {
// exceptions make me throw up...
}
String key = name.substring(3);
// log.debug("VTCode[{}]:'{}'", key, code);
stringsToVTCodes.put(key, code);
}
}
}
/**
* Set up the Option menu.
*
* @param menuBar to add the option menu to
* @return option menu that was added
*/
private JMenu setupOptionMenu(@Nonnull JMenuBar menuBar) {
assert menuBar != null;
JMenu optionMenu = new JMenu(Bundle.getMessage("MenuOptions"));
optionMenu.setMnemonic(stringsToVTCodes.get(Bundle.getMessage("OptionsMnemonic")));
menuBar.add(optionMenu);
//
// edit mode
//
editModeCheckBoxMenuItem = new JCheckBoxMenuItem(Bundle.getMessage("EditMode"));
optionMenu.add(editModeCheckBoxMenuItem);
editModeCheckBoxMenuItem.setMnemonic(stringsToVTCodes.get(Bundle.getMessage("EditModeMnemonic")));
int primary_modifier = Toolkit.getDefaultToolkit().getMenuShortcutKeyMask();
editModeCheckBoxMenuItem.setAccelerator(KeyStroke.getKeyStroke(
stringsToVTCodes.get(Bundle.getMessage("EditModeAccelerator")), primary_modifier));
editModeCheckBoxMenuItem.addActionListener((ActionEvent event) -> {
setAllEditable(editModeCheckBoxMenuItem.isSelected());
// show/hide the help bar
if (toolBarSide.equals(ToolBarSide.eFLOAT)) {
if (floatEditHelpPanel != null) {
floatEditHelpPanel.setVisible(isEditable() && getShowHelpBar());
}
} else {
helpBarPanel.setVisible(isEditable() && getShowHelpBar());
}
if (isEditable()) {
setAllShowToolTip(tooltipsInEditMode);
// redo using the "Extra" color to highlight the selected block
if (highlightSelectedBlockFlag) {
if (!highlightBlockInComboBox(leToolBarPanel.blockIDComboBox)) {
highlightBlockInComboBox(leToolBarPanel.blockContentsComboBox);
}
}
} else {
setAllShowToolTip(tooltipsWithoutEditMode);
// undo using the "Extra" color to highlight the selected block
if (highlightSelectedBlockFlag) {
highlightBlock(null);
}
}
awaitingIconChange = false;
});
editModeCheckBoxMenuItem.setSelected(isEditable());
//
// toolbar
//
JMenu toolBarMenu = new JMenu(Bundle.getMessage("ToolBar")); // used for ToolBar SubMenu
optionMenu.add(toolBarMenu);
JMenu toolBarSideMenu = new JMenu(Bundle.getMessage("ToolBarSide"));
ButtonGroup toolBarSideGroup = new ButtonGroup();
//
// create toolbar side menu items: (top, left, bottom, right)
//
toolBarSideTopButton = new JRadioButtonMenuItem(Bundle.getMessage("ToolBarSideTop"));
toolBarSideTopButton.addActionListener((ActionEvent event) -> setToolBarSide(ToolBarSide.eTOP));
toolBarSideTopButton.setSelected(toolBarSide.equals(ToolBarSide.eTOP));
toolBarSideMenu.add(toolBarSideTopButton);
toolBarSideGroup.add(toolBarSideTopButton);
toolBarSideLeftButton = new JRadioButtonMenuItem(Bundle.getMessage("ToolBarSideLeft"));
toolBarSideLeftButton.addActionListener((ActionEvent event) -> setToolBarSide(ToolBarSide.eLEFT));
toolBarSideLeftButton.setSelected(toolBarSide.equals(ToolBarSide.eLEFT));
toolBarSideMenu.add(toolBarSideLeftButton);
toolBarSideGroup.add(toolBarSideLeftButton);
toolBarSideBottomButton = new JRadioButtonMenuItem(Bundle.getMessage("ToolBarSideBottom"));
toolBarSideBottomButton.addActionListener((ActionEvent event) -> setToolBarSide(ToolBarSide.eBOTTOM));
toolBarSideBottomButton.setSelected(toolBarSide.equals(ToolBarSide.eBOTTOM));
toolBarSideMenu.add(toolBarSideBottomButton);
toolBarSideGroup.add(toolBarSideBottomButton);
toolBarSideRightButton = new JRadioButtonMenuItem(Bundle.getMessage("ToolBarSideRight"));
toolBarSideRightButton.addActionListener((ActionEvent event) -> setToolBarSide(ToolBarSide.eRIGHT));
toolBarSideRightButton.setSelected(toolBarSide.equals(ToolBarSide.eRIGHT));
toolBarSideMenu.add(toolBarSideRightButton);
toolBarSideGroup.add(toolBarSideRightButton);
toolBarSideFloatButton = new JRadioButtonMenuItem(Bundle.getMessage("ToolBarSideFloat"));
toolBarSideFloatButton.addActionListener((ActionEvent event) -> setToolBarSide(ToolBarSide.eFLOAT));
toolBarSideFloatButton.setSelected(toolBarSide.equals(ToolBarSide.eFLOAT));
toolBarSideMenu.add(toolBarSideFloatButton);
toolBarSideGroup.add(toolBarSideFloatButton);
toolBarMenu.add(toolBarSideMenu);
//
// toolbar wide menu
//
toolBarMenu.add(wideToolBarCheckBoxMenuItem);
wideToolBarCheckBoxMenuItem.addActionListener((ActionEvent event) -> setToolBarWide(wideToolBarCheckBoxMenuItem.isSelected()));
wideToolBarCheckBoxMenuItem.setSelected(leToolBarPanel.toolBarIsWide);
wideToolBarCheckBoxMenuItem.setEnabled(toolBarSide.equals(ToolBarSide.eTOP) || toolBarSide.equals(ToolBarSide.eBOTTOM));
//
// Scroll Bars
//
scrollMenu = new JMenu(Bundle.getMessage("ComboBoxScrollable")); // used for ScrollBarsSubMenu
optionMenu.add(scrollMenu);
ButtonGroup scrollGroup = new ButtonGroup();
scrollBothMenuItem = new JRadioButtonMenuItem(Bundle.getMessage("ScrollBoth"));
scrollGroup.add(scrollBothMenuItem);
scrollMenu.add(scrollBothMenuItem);
scrollBothMenuItem.setSelected(_scrollState == Editor.SCROLL_BOTH);
scrollBothMenuItem.addActionListener((ActionEvent event) -> {
_scrollState = Editor.SCROLL_BOTH;
setScroll(_scrollState);
redrawPanel();
});
scrollNoneMenuItem = new JRadioButtonMenuItem(Bundle.getMessage("ScrollNone"));
scrollGroup.add(scrollNoneMenuItem);
scrollMenu.add(scrollNoneMenuItem);
scrollNoneMenuItem.setSelected(_scrollState == Editor.SCROLL_NONE);
scrollNoneMenuItem.addActionListener((ActionEvent event) -> {
_scrollState = Editor.SCROLL_NONE;
setScroll(_scrollState);
redrawPanel();
});
scrollHorizontalMenuItem = new JRadioButtonMenuItem(Bundle.getMessage("ScrollHorizontal"));
scrollGroup.add(scrollHorizontalMenuItem);
scrollMenu.add(scrollHorizontalMenuItem);
scrollHorizontalMenuItem.setSelected(_scrollState == Editor.SCROLL_HORIZONTAL);
scrollHorizontalMenuItem.addActionListener((ActionEvent event) -> {
_scrollState = Editor.SCROLL_HORIZONTAL;
setScroll(_scrollState);
redrawPanel();
});
scrollVerticalMenuItem = new JRadioButtonMenuItem(Bundle.getMessage("ScrollVertical"));
scrollGroup.add(scrollVerticalMenuItem);
scrollMenu.add(scrollVerticalMenuItem);
scrollVerticalMenuItem.setSelected(_scrollState == Editor.SCROLL_VERTICAL);
scrollVerticalMenuItem.addActionListener((ActionEvent event) -> {
_scrollState = Editor.SCROLL_VERTICAL;
setScroll(_scrollState);
redrawPanel();
});
//
// Tooltips
//
tooltipMenu = new JMenu(Bundle.getMessage("TooltipSubMenu"));
optionMenu.add(tooltipMenu);
ButtonGroup tooltipGroup = new ButtonGroup();
tooltipNoneMenuItem = new JRadioButtonMenuItem(Bundle.getMessage("TooltipNone"));
tooltipGroup.add(tooltipNoneMenuItem);
tooltipMenu.add(tooltipNoneMenuItem);
tooltipNoneMenuItem.setSelected((!tooltipsInEditMode) && (!tooltipsWithoutEditMode));
tooltipNoneMenuItem.addActionListener((ActionEvent event) -> {
tooltipsInEditMode = false;
tooltipsWithoutEditMode = false;
setAllShowToolTip(false);
});
tooltipAlwaysMenuItem = new JRadioButtonMenuItem(Bundle.getMessage("TooltipAlways"));
tooltipGroup.add(tooltipAlwaysMenuItem);
tooltipMenu.add(tooltipAlwaysMenuItem);
tooltipAlwaysMenuItem.setSelected((tooltipsInEditMode) && (tooltipsWithoutEditMode));
tooltipAlwaysMenuItem.addActionListener((ActionEvent event) -> {
tooltipsInEditMode = true;
tooltipsWithoutEditMode = true;
setAllShowToolTip(true);
});
tooltipInEditMenuItem = new JRadioButtonMenuItem(Bundle.getMessage("TooltipEdit"));
tooltipGroup.add(tooltipInEditMenuItem);
tooltipMenu.add(tooltipInEditMenuItem);
tooltipInEditMenuItem.setSelected((tooltipsInEditMode) && (!tooltipsWithoutEditMode));
tooltipInEditMenuItem.addActionListener((ActionEvent event) -> {
tooltipsInEditMode = true;
tooltipsWithoutEditMode = false;
setAllShowToolTip(isEditable());
});
tooltipNotInEditMenuItem = new JRadioButtonMenuItem(Bundle.getMessage("TooltipNotEdit"));
tooltipGroup.add(tooltipNotInEditMenuItem);
tooltipMenu.add(tooltipNotInEditMenuItem);
tooltipNotInEditMenuItem.setSelected((!tooltipsInEditMode) && (tooltipsWithoutEditMode));
tooltipNotInEditMenuItem.addActionListener((ActionEvent event) -> {
tooltipsInEditMode = false;
tooltipsWithoutEditMode = true;
setAllShowToolTip(!isEditable());
});
//
// show edit help
//
showHelpCheckBoxMenuItem = new JCheckBoxMenuItem(Bundle.getMessage("ShowEditHelp"));
optionMenu.add(showHelpCheckBoxMenuItem);
showHelpCheckBoxMenuItem.addActionListener((ActionEvent event) -> {
boolean newShowHelpBar = showHelpCheckBoxMenuItem.isSelected();
setShowHelpBar(newShowHelpBar);
});
showHelpCheckBoxMenuItem.setSelected(getShowHelpBar());
//
// Allow Repositioning
//
positionableCheckBoxMenuItem = new JCheckBoxMenuItem(Bundle.getMessage("AllowRepositioning"));
optionMenu.add(positionableCheckBoxMenuItem);
positionableCheckBoxMenuItem.addActionListener((ActionEvent event) -> setAllPositionable(positionableCheckBoxMenuItem.isSelected()));
positionableCheckBoxMenuItem.setSelected(allPositionable());
//
// Allow Layout Control
//
controlCheckBoxMenuItem = new JCheckBoxMenuItem(Bundle.getMessage("AllowLayoutControl"));
optionMenu.add(controlCheckBoxMenuItem);
controlCheckBoxMenuItem.addActionListener((ActionEvent event) -> {
setAllControlling(controlCheckBoxMenuItem.isSelected());
redrawPanel();
});
controlCheckBoxMenuItem.setSelected(allControlling());
//
// use direct turnout control