refactoring

ordené métodos en regiones.
cambia nombre de algunos métodos
otros

Author: EdoFro

Tutorial-o-Matic/Tutorial-o-Matic.mm

@@ -148,8 +148,7 @@
       To translate the description you have to define a translation for the key 'addons.${name}.description'.
     </p>
   </body>
-</html>
-</richcontent>
+</html></richcontent>
 <node TEXT="Tutorial-o-Matic for Freeplane!!&#xa;Tutorial-o-Matic is an AddOn for Freeplane that gives the user the possibility to create his/her own tutorials." ID="ID_1642042079"/>
 </node>
 <node TEXT="changes" POSITION="left" ID="ID_461119253">
@@ -164,8 +163,7 @@
       Change log of this add-on: append one node for each noteworthy version and put the details for each version into a child node.
     </p>
   </body>
-</html>
-</richcontent>
+</html></richcontent>
 <node TEXT="v0.0.1" FOLDED="true" ID="ID_1147464075">
 <node TEXT="Demo version" ID="ID_1739689712"/>
 </node>
@@ -197,8 +195,7 @@
       The License text has to be entered as a child of the <i>'license'</i>&nbsp;node, either as plain text or as HTML.
     </p>
   </body>
-</html>
-</richcontent>
+</html></richcontent>
 <node TEXT="MIT License&#xa;&#xa;Copyright (c) 2021 Eduardo Frohlich.&#xa;&#xa;Permission is hereby granted, free of charge, to any person obtaining a copy&#xa;of this software and associated documentation files (the &quot;Software&quot;), to deal&#xa;in the Software without restriction, including without limitation the rights&#xa;to use, copy, modify, merge, publish, distribute, sublicense, and/or sell&#xa;copies of the Software, and to permit persons to whom the Software is&#xa;furnished to do so, subject to the following conditions:&#xa;&#xa;The above copyright notice and this permission notice shall be included in all&#xa;copies or substantial portions of the Software.&#xa;&#xa;THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR&#xa;IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,&#xa;FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE&#xa;AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER&#xa;LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,&#xa;OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE&#xa;SOFTWARE." ID="ID_444630498"/>
 </node>
 <node TEXT="preferences.xml" POSITION="left" ID="ID_1967714695">
@@ -216,8 +213,7 @@
       <font color="#000000" face="SansSerif, sans-serif">Every property in the configuration should receive a default value in <i>default.properties</i>&nbsp;node.</font>
     </p>
   </body>
-</html>
-</richcontent>
+</html></richcontent>
 </node>
 <node TEXT="default.properties" POSITION="left" ID="ID_1398497950">
 <edge COLOR="#00ffff"/>
@@ -239,8 +235,7 @@ For each menu item with an icon add an attribute with the icon key (use develope
       </li>
     </ul>
   </body>
-</html>
-</richcontent>
+</html></richcontent>
 </node>
 <node TEXT="translations" POSITION="left" ID="ID_546877695">
 <edge COLOR="#7c0000"/>
@@ -265,8 +260,7 @@ For each menu item with an icon add an attribute with the icon key (use develope
       </li>
     </ul>
   </body>
-</html>
-</richcontent>
+</html></richcontent>
 <node TEXT="en" ID="ID_1998059292">
 <attribute_layout NAME_WIDTH="162 pt" VALUE_WIDTH="281.24999 pt"/>
 <attribute NAME="addons.${name}" VALUE="Tutorial-o-Matic"/>
@@ -289,8 +283,7 @@ For each menu item with an icon add an attribute with the icon key (use develope
       List of files and/or directories to remove on uninstall
     </p>
   </body>
-</html>
-</richcontent>
+</html></richcontent>
 <attribute_layout NAME_WIDTH="42.75 pt" VALUE_WIDTH="295.49999 pt"/>
 <attribute NAME="delete" VALUE="${installationbase}/addons/${name}.script.xml"/>
 <attribute NAME="delete" VALUE="${installationbase}/addons/${name}/lib/Tutorial-o-Matic.jar"/>
@@ -418,8 +411,7 @@ For each menu item with an icon add an attribute with the icon key (use develope
       &nbsp;&nbsp;- In any case set execute_scripts_without_asking to true unless you want to annoy users.
     </p>
   </body>
-</html>
-</richcontent>
+</html></richcontent>
 <node TEXT="openDemoMap.groovy" ID="ID_1629939217">
 <attribute_layout NAME_WIDTH="200.24999 pt" VALUE_WIDTH="200.24999 pt"/>
 <attribute NAME="menuTitleKey" VALUE="addons.${name}.openDemoMap"/>
@@ -481,8 +473,7 @@ For each menu item with an icon add an attribute with the icon key (use develope
       &nbsp;- The files will be processed in the sequence as seen in the map.
     </p>
   </body>
-</html>
-</richcontent>
+</html></richcontent>
 <node TEXT="Tutorial-o-Matic.jar" ID="ID_1864463328"/>
 <node TEXT="markedj-1.0.16.jar" ID="ID_1060333872"/>
 <node TEXT="jsoup-1.10.2.jar" ID="ID_1151792763"/>
@@ -523,8 +514,7 @@ For each menu item with an icon add an attribute with the icon key (use develope
       &nbsp;- The files will be processed in the sequence as seen in the map.
     </p>
   </body>
-</html>
-</richcontent>
+</html></richcontent>
 <node TEXT="doc" ID="ID_281158802"/>
 <node TEXT="icons" ID="ID_211861022"/>
 <node TEXT="templates" ID="ID_553385296"/>
@@ -561,8 +551,7 @@ For each menu item with an icon add an attribute with the icon key (use develope
       Images can be added automatically by releaseAddOn.groovy or must be uploaded into the map via the script <i>Tools-&gt;Scripts-&gt;Insert Binary</i>&nbsp;since they have to be (base64) encoded as simple strings.
     </p>
   </body>
-</html>
-</richcontent>
+</html></richcontent>
 </node>
 <node TEXT="shortcuts" POSITION="right" ID="ID_989188638">
 <edge COLOR="#ff0000"/>

Tutorial-o-Matic/scripts/ToMDemo.groovy

@@ -1,13 +1,16 @@
 import edofro.tutorialomatic.ToM_ui as tomui
 import edofro.tutorialomatic.ToM    as tom
 
-//opens tutorial map
-def sep         = File.separator
-def userDir     = c.userDirectory.path
-def mapFileName = "SimpleTutorialSample.mm"
-def pathName    = userDir + sep + "doc" + sep + "Tutorial-o-Matic" + sep + mapFileName
-def tutMap      = tom.getMapFromPath(pathName, false) //usar mapa indicado (pero oculto)
+//region: opens tutorial map
 
-tom.showTutorials( tutMap )
+    def sep         = File.separator
+    def userDir     = c.userDirectory.path
+    def mapFileName = "SimpleTutorialSample.mm"
+    def pathName    = userDir + sep + "doc" + sep + "Tutorial-o-Matic" + sep + mapFileName
+    def tutMap      = tom.getMapFromPath(pathName, false) //usar mapa indicado (pero oculto)
 
-return 'tutorial started'
+    tom.showTutorials( tutMap )
+
+    return 'tutorial started'
+
+//end:

Tutorial-o-Matic/scripts/openDemoMap.groovy

@@ -1,14 +1,22 @@
 //opens demo map
 
-def mapFile = "SimpleTutorialSample.mm"
-def dir = c.userDirectory.path
-def sep = File.separator
-def helpFile = "Tutorial-o-Matic" + sep + mapFile
-def pathName = dir + sep + "doc" + sep + helpFile
+//region: defining path
+    def mapFile = "SimpleTutorialSample.mm"
+    def dir = c.userDirectory.path
+    def sep = File.separator
+    def helpFile = "Tutorial-o-Matic" + sep + mapFile
+    def pathName = dir + sep + "doc" + sep + helpFile
+// end:
 
+//region: opening mindmap file
+    if(exists(pathName)){
+        c.mapLoader(pathName).withView().load()
+    }
+//end:
 
-if(exists(pathName)){
-    c.mapLoader(pathName).withView().load()
-}
 
-def exists(String path){new File(path).isFile()}
+//region: methods
+
+    def exists(String path){new File(path).isFile()}
+
+//end:

Tutorial-o-Matic/src/main/groovy/CustomComponentListener.groovy

@@ -1,12 +1,9 @@
 package edofro.tutorialomatic
 
-//import edofro.tutorialomatic.TabPane
 import edofro.tutorialomatic.ToM_ui      as tomui
-
 import java.awt.event.*
 
-
-
+// Listener for Tutorial Tab pane so it gets resized (enough length) each time its width gets modified
 class CustomComponentListener implements ComponentListener {
     public void componentResized(ComponentEvent e) { //https://docs.oracle.com/javase/8/docs/api/java/awt/event/ComponentEvent.html
         def comp = e.component
@@ -18,7 +15,7 @@ class CustomComponentListener implements ComponentListener {
     public void componentMoved(ComponentEvent e) {
         // e.source.title =  " moved. "
     }
-    public void componentShown(ComponentEvent e) {      
+    public void componentShown(ComponentEvent e) {
         // e.source.title =  " shown. "
     }
     public void componentHidden(ComponentEvent e) {

Tutorial-o-Matic/src/main/groovy/TabPane.groovy

@@ -4,8 +4,12 @@ import org.freeplane.core.ui.components.UITools as ui
 import org.freeplane.core.util.MenuUtils        as menuUtils
 
 class TabPane{
+//region: properties
     def static tabPane = ui.freeplaneTabbedPanel
 
+//end:
+
+//region: methods
 
     def static removeTab(String tabName, boolean hideTabPane = false){
         def index   = tabPane.indexOfTab(tabName)
@@ -21,7 +25,7 @@ class TabPane{
             return true
         } else return false
     }
-    
+
     def static showTab(String tabName){
         //if tabPanel is not showing --> show
         if(!tabPane.isShowing()) {
@@ -33,24 +37,24 @@ class TabPane{
             tabPane.previousTab = previousTab
         } else {
             tabPane.metaClass.previousTab = previousTab
-        }        
+        }
         // look if tab exists
         def index = tabPane.indexOfTab(tabName)
         if (index>=0) {
             tabPane.selectedIndex = index
             return true
         } else return false
     }
-    
+
     def static addTab(String tabName, componente){
         tabPane.addTab(tabName, componente)
     }
-    
+
     def static hasTab(String tabName){
         def index = tabPane.indexOfTab(tabName)
         return ( index >= 0 )
     }
-    
+
     def static getTab(String tabName){
         def index = tabPane.indexOfTab(tabName)
         if (index>=0) {
@@ -59,9 +63,9 @@ class TabPane{
             return null
         }
     }
-    
+
     def static repaint(){
         tabPane.repaint()
     }
-
+//end:
 }

Tutorial-o-Matic/src/main/groovy/ToM.groovy

@@ -165,7 +165,7 @@ class ToM{
         def tocToolTip   = 'Click to show the Table of Contents of the tutorial'
         def tocBttnAction   = { e -> showTOC(myP,lastNode) }
 
-        def nextButtonPanel = tomui.getNextButtonPanel(tabName, closeLabel, closeToolTip, nextLabel, nextToolTip , bttnAction, tocLabel, tocToolTip, tocBttnAction)
+        def nextButtonPanel = tomui.createNextButtonPanel(tabName, closeLabel, closeToolTip, nextLabel, nextToolTip , bttnAction, tocLabel, tocToolTip, tocBttnAction)
         myP.add(nextButtonPanel, tomui.GBC)
     }
 
@@ -192,7 +192,7 @@ class ToM{
                         }
                     }
 
-                def buttonPanel = tomui.getButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, true)
+                def buttonPanel = tomui.createButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, true)
                 buttonPanel.metaClass.pending = false
                 myP.add(buttonPanel, tomui.GBC)
             } else {
@@ -209,7 +209,7 @@ class ToM{
                 def bttnText    = nodo.text
                 def bttnToolTip = "Click to go to '${bttnText}' section"
                 def bttnAction  = { e -> fillPage(myP, targetNode, true, true) }
-            def buttonPanel = tomui.getButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, false)
+            def buttonPanel = tomui.createButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, false)
             myP.add(buttonPanel, tomui.GBC)
         }
     }
@@ -229,7 +229,7 @@ class ToM{
                         c.script(scrText, "groovy").executeOn(c.selected)
                     }
 
-                def buttonPanel = tomui.getButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, false)
+                def buttonPanel = tomui.createButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, false)
                 buttonPanel.metaClass.pending = false
                 myP.add(buttonPanel, tomui.GBC)
             } else {
@@ -264,7 +264,7 @@ class ToM{
                 toma.executeActions(infoAcciones, exeHow)
             }
 
-        def buttonPanel = ToM_ui.getButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, false)
+        def buttonPanel = ToM_ui.createButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, false)
         myP.add(buttonPanel, tomui.GBC)
     }
 
@@ -309,7 +309,7 @@ class ToM{
             //guarda idDictionary en mapa
             setIdDictionary(mapa, idDictionary)
         }
-        def buttonPanel = tomui.getButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, false)
+        def buttonPanel = tomui.createButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, false)
         myP.add(buttonPanel, tomui.GBC)
     }
 
@@ -349,7 +349,7 @@ class ToM{
             uiMsg("nodos $nodos")
             c.select(nodos)
         }
-        def buttonPanel = tomui.getButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, false)
+        def buttonPanel = tomui.createButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, false)
         myP.add(buttonPanel, tomui.GBC)
     }
 
@@ -388,7 +388,7 @@ class ToM{
             bttn.setEnabled(enabled)
             def mapa = getMapFromPath(pathName, true) //usar mapa indicado (pero oculto)
         }
-        def buttonPanel = tomui.getButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, false)
+        def buttonPanel = tomui.createButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, false)
         myP.add(buttonPanel, tomui.GBC)
     }
 
@@ -403,7 +403,7 @@ class ToM{
             pageNode.pathToRoot*.folded = false
             c.select(pageNode)
         }
-        def buttonPanel = tomui.getButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, false)
+        def buttonPanel = tomui.createButtonPanel(msgHtml,bttnText,bttnToolTip, bttnAction, false)
         myP.add(buttonPanel, tomui.GBC)
     }