SceneManager in-built for CustomStage and added JavaDoc

Author: Oshan96

examples/v1_2_2/StageTest.java

@@ -1,9 +1,7 @@
 package v1_2_2;
 
 import javafx.application.Application;
-import javafx.scene.image.Image;
 import javafx.scene.layout.AnchorPane;
-import javafx.scene.shape.Circle;
 import javafx.stage.Stage;
 import lk.vivoxalabs.customstage.CustomStage;
 import lk.vivoxalabs.customstage.CustomStageBuilder;

src/main/java/lk/vivoxalabs/customstage/CustomStage.java

@@ -5,7 +5,9 @@
 import javafx.stage.Stage;
 import lk.vivoxalabs.customstage.tools.NavigationType;
 import lk.vivoxalabs.customstage.view.controller.CustomStageController;
+import lk.vivoxalabs.scenemanager.SceneManager;
 
+import java.awt.*;
 import java.net.URL;
 
 /**
@@ -18,6 +20,11 @@
  */
 public class CustomStage extends Stage {
     private final CustomStageController _STAGE_CONTROLLER_;
+    private static final SceneManager DEFAULT_SCENE_MANAGER;
+
+    static{
+        DEFAULT_SCENE_MANAGER = new SceneManager();
+    }
 
     CustomStage(CustomStageController controller){
         _STAGE_CONTROLLER_ = controller;
@@ -105,4 +112,11 @@ public void dynamicDrawerEvent(NavigationType type){
         _STAGE_CONTROLLER_.dynamicDrawerEvent(type);
     }
 
+    /**
+     * @return the static SceneManager object in CustomStage
+     */
+    public static SceneManager getDefaultSceneManager(){
+        return DEFAULT_SCENE_MANAGER;
+    }
+
 }

src/main/java/lk/vivoxalabs/scenemanager/SceneManager.java

@@ -78,16 +78,43 @@ public String[] getIds(){
         return sceneMap.keySet().toArray(new String[]{});
     }
 
+    /**
+     * @deprecated Use another "automate" method instead. This does not work unless used with a SceneManager object you have created.
+     * (Does not work with the defaultSceneManager object provided). <br>
+     *
+     * <b>NOTE : {@code CustomStage.getDefaultSceneManager().automate();} will not work </b>
+     *
+     * <p>
+     *     When called gets the directory to collect files as the directory of the caller class.
+     *     Ex : If "Foo.class" calls this method, then fxml files available in the same directory as "Foo.class" will be loaded.
+     * </p>
+     *
+     */
     public void automate(){
         fileLoader = new FileLoader("fxml",this);
         fileLoader.collect();
     }
 
+    /**
+     * <p>
+     *      This is used to make the FileLoader eligible to load the given type of files from the directory given in String format.
+     * </p>
+     *
+     * @param dir directory path for fxml files to be loaded from
+     */
     public void automate(String dir){
         fileLoader = new FileLoader(dir,"fxml",this);
         fileLoader.collect();
     }
 
+    /**
+     * <p>
+     *     This is used to make the FileLoader eligible to load the given type of files from the directory of the URL provides.
+     *     Ex : {@code sceneManager.automate(getClass().getResource("/path/to/file/myfile.fxml")))}
+     *     Will make the FileLoader eligible to load file with ".fxml" extension from the "/path/to/file" directory.
+     * </p>
+     * @param url URL of a class to determine the package which needs to be lookup for fxml files to load
+     */
     public void automate(URL url){
         fileLoader = new FileLoader(url,"fxml",this);
         fileLoader.collect();

src/main/java/lk/vivoxalabs/scenemanager/tools/FileLoader.java

@@ -11,14 +11,37 @@
 import java.util.List;
 
 /**
+ * This class is used to load all the files in the given package as to the given extension.
+ *
  * @author oshan
+ * @version 1.0
  */
 public class FileLoader {
 
     private SceneManager manager;
 
     private String dir="", ext;
 
+    /**
+     * <p>
+     *      IMPORTANT : <b>
+     *          This DOES NOT GUARANTEE to be executed the way expected and should be avoided unless in testing.
+     *          Use another constructor instead.
+     *      </b>
+     *      Calling this constructor will create a FileLoader object which can load the type of files of the given extension (ext)
+     *      from the same package of the class the constructor was called.
+     *      Ex : If the constructor was called from "Foo.class", this will create a FileLoader which is able to load the specific
+     *      files from the same directory "Foo.class" file is located.
+     * </p>
+     *
+     * <p>
+     *      <b>NOTE :</b> This constructor is specifically created to be used with SceneManager. If used separately, this will not
+     *      work properly and will be unable to load the files. (Since this uses getStackTrace()[3] argument and if called directly,
+     *      it should probably be changed to getStackTrace()[1]).
+     * </p>
+     *
+     * @param ext extension of the type of files needed to be loaded
+     */
     public FileLoader(String ext) {
         this.ext = ext;
         try {
@@ -31,11 +54,30 @@ public FileLoader(String ext) {
 
     }
 
+    /**
+     * <p>
+     *      This is same as {@link #FileLoader(String ext)}. The only difference is that this constructor will initialize the
+     *      SceneManager property which can be used later (through the given SceneManager object)
+     *</p>
+     *
+     * @param ext extension of the type of files needed to be loaded
+     * @param manager SceneManager object which is going to access this FileLoader object
+     */
     public FileLoader(String ext, SceneManager manager){
         this(ext);
         this.manager=manager;
     }
 
+    /**
+     * <p>
+     *     This is used to make the FileLoader eligible to load the given type of files from the directory of the URL provides.
+     *     Ex : {@code new FileLoader(getClass().getResource("/path/to/file/myfile.fxml")),"fxml")}
+     *     Will make the FileLoader eligible to load file with ".fxml" extension from the "/path/to/file" directory.
+     * </p>
+     *
+     * @param url URL of a class to determine the package which needs to be lookup for files to load
+     * @param ext extension of the type of files needed to be loaded
+     */
     public FileLoader(URL url, String ext){
         String[] content = url.toString().replace("file:/","").replace("%20"," ").split("/");
 
@@ -49,21 +91,51 @@ public FileLoader(URL url, String ext){
         this.ext = ext;
     }
 
+    /**
+     * <p>
+     *     This is same as {@link #FileLoader(URL, String)}. The only difference is that this constructor will initialize the
+     *     SceneManager property which can be used later (through the given SceneManager object)
+     * </p>
+     *
+     * @param url URL of a class to determine the package which needs to be lookup for files to load
+     * @param ext extension of the type of files needed to be loaded
+     * @param manager SceneManager object which is going to access this FileLoader object
+     */
     public FileLoader(URL url, String ext, SceneManager manager){
         this(url, ext);
         this.manager = manager;
     }
 
+    /**
+     * <p>
+     *      This is used to make the FileLoader eligible to load the given type of files from the directory given in String format.
+     * </p>
+     *
+     * @param dir directory path
+     * @param ext extension of the type of files needed to be loaded
+     */
     public FileLoader(String dir, String ext) {
         this.dir=dir;
         this.ext=ext;
     }
 
+    /**
+     * See {@link #FileLoader(String, String, SceneManager)}
+     *
+     * @param dir directory path
+     * @param ext extension of the type of files needed to be loaded
+     * @param manager SceneManager object which is going to access this FileLoader object
+     */
     public FileLoader(String dir, String ext, SceneManager manager){
         this(dir, ext);
         this.manager=manager;
     }
 
+    /**
+     * Collects the set of files with the given extension and inside the given directory for the FileLoader.
+     *
+     * @return the loaded available files.
+     */
     public List<File> collect(){
 
         List<File> files = new ArrayList<>();