Skip to content

Commit

Permalink
update item palette help
Browse files Browse the repository at this point in the history
fix class diagram img tags in Javadoc
  • Loading branch information
silverailscolo committed Dec 11, 2017
1 parent bacc776 commit 41791fb
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 21 deletions.
35 changes: 21 additions & 14 deletions help/en/package/jmri/jmrit/display/ItemPalette.shtml
Expand Up @@ -86,19 +86,23 @@
press the <b>Create Icon Set</b> button and the dialog is
closed with the new icon set added to radio button list.</p>

<h3>Table Items</h3>The items associated with a table have an
<b>Add New Table Item</b> button. This button opens a dialog
where a new device item can be added to its table. Tabs with
tables require a device to be selected (a row in the table)
before the an icon can be dragged to a control panel to
represent it.
<h3>Table Items</h3>
The items associated with a table (eg. Turnouts, Sensors,
Lights, Signal Heads) have an <b>Add New Table Item</b>
button. This button opens a dialog where a new device item
can be added to its table. Include the System Connection
prefix and item type in the entry, eg. "IL2".
<br>Tabs with tables require a device to be selected (a
row in the table) before the an icon can be dragged to a
control panel to represent it.

<h2>Item Palette Tabs</h2>

<ul>
<li><b>Turnout</b> Both left and right turnout icon sets
are contained in this tab. Select a turnout from the table
and an icon set, then drag to the panel.</li>
and an icon set for either Right, Left, R/L Crossover,
then drag to the panel.</li>

<li><b>Sensor</b> Select a sensor from the table and an
icon set, then drag to the panel.</li>
Expand All @@ -124,13 +128,15 @@
drag the item within the bordered "Drag to Panel" to the
panel.</li>

<li><b>Light</b> Select a light (as a CMRI object) from the
table and drag to the panel.</li>
<li><b>Light</b> Select a light from the table and an icon
set for either Crossed symbol, Right or Left and drag to
the panel.</li>

<li><b>Multisensor</b> The table displays the Sensor Table
and the default icon set has three lever positions. For the
default case, three rows must be selected from the table to
place the multisensor icon in a panel. The table selections
default case, three rows must be selected in order from the
table to place the multisensor icon in a panel.
The table selections
are labeled "first", "second", etc. and these labels
correspond to the labels shown when the full icon set is
displayed. When editing or creating a Multisensor icon set,
Expand Down Expand Up @@ -180,8 +186,9 @@
Indicator Turnouts also.</li>

<li><b>Portal</b>Portal icons are used in CircuitBuilder to
define Portals and Paths. They also will display direction
arrows along a route when Warrants are allocated.</li>
define Portals and Paths. On the Control Panel they also
will display direction arrows along a route when Warrants
are allocated.</li>
</ul>

<h2>More About Indicator Track</h2>Indicator track (i.e. both
Expand Down Expand Up @@ -281,7 +288,7 @@
Also the entire status row can be removed by the <b>Delete
Status</b> button - or restored by the <b>Add Missing
Status</b> button.</p>
<p><!--#include virtual="/Footer" -->
<!--#include virtual="/Footer" -->
</div><!-- closes #mainContent-->
</div><!-- closes #mBody-->
</body>
Expand Down
3 changes: 1 addition & 2 deletions java/src/jmri/jmrit/display/DisplayFrame.java
Expand Up @@ -8,8 +8,7 @@
* Extended JmriJFrame that allows to add an InitEventListener for display of
* a tabbed frame in the CPE Add Item {@link jmri.jmrit.display.palette.ItemPalette} pane.
* <p>
* <a href="doc-files/DisplayFrame-ClassDiagram.png"><img src="doc-files/DisplayFrame-ClassDiagram.png"
* alt="UML Class diagram" height="50%" width="50%"></a>
* <a href="doc-files/DisplayFrame-ClassDiagram.png"><img src="doc-files/DisplayFrame-ClassDiagram.png" alt="UML Class diagram" height="50%" width="50%"></a>
*
* @author Egbert Broerse Copyright (c) 2017
*/
Expand Down
9 changes: 4 additions & 5 deletions java/src/jmri/jmrit/display/palette/ItemPalette.java
Expand Up @@ -52,8 +52,7 @@
* squares pattern using the "View on:" combo. This choice is shared across tabs
* as a field on the {@link jmri.jmrit.display.DisplayFrame} parent frame.
* <p>
* <a href="doc-files/ItemPalette-ClassDiagram.png"><img src="doc-files/ItemPalette-ClassDiagram.png"
* alt="UML Class diagram" height="50%" width="50%"></a>
* <a href="doc-files/ItemPalette-ClassDiagram.png"><img src="doc-files/ItemPalette-ClassDiagram.png" alt="UML Class diagram" height="50%" width="50%"></a>
*
* @author Pete Cressman Copyright (c) 2010
* @author Egbert Broerse Copyright (c) 2017
Expand All @@ -64,9 +63,9 @@
abstract class JPanel
package "jmri.util.swing.ImagePanel" {
class ImagePanel {
-BufferedImage image
+SetImage()
+Repaint()
-BufferedImage back
+setImage()
+paintComponent()
}
}
package "jmri.util.swing.DrawSquares" {
Expand Down

0 comments on commit 41791fb

Please sign in to comment.