Documentation

hal · May 6, 2024 · 50358c4 · 50358c4
1 parent 555da38
commit 50358c4
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -477,8 +477,7 @@ public static class TimePage implements Page {
 public static class Application {
 
     public void entryPoint() {
-        body().add(div().id("main"));
-        new PlaceManager()
+        PlaceManager placeManager = new PlaceManager()
                 .root(By.id("main"))
                 .register(place("/time/:area/:location")
                         .loader((place, parameter) -> {
@@ -491,8 +490,11 @@ public static class Application {
                                         JsPropertyMap<String> map = Js.cast(json);
                                         return Promise.resolve(map.get("datetime"));
                                     });
-                        }), TimePage::new)
-                .start();
+                        }), TimePage::new);
+        body().add(div().id("main")
+                .add(link(placeManager, "/time/Europe/Berlin")
+                        .textNode("What time is it in Berlin?")));
+        placeManager.start();
     }
 }
 ```

diff --git a/router/src/demo/java/PlaceManagerDemo.java b/router/src/demo/java/PlaceManagerDemo.java
@@ -34,6 +34,7 @@
 import static org.jboss.elemento.Elements.h;
 import static org.jboss.elemento.Elements.p;
 import static org.jboss.elemento.Elements.span;
+import static org.jboss.elemento.router.Link.link;
 import static org.jboss.elemento.router.Place.place;
 
 @SuppressWarnings("unused")
@@ -60,8 +61,7 @@ public Iterable<HTMLElement> elements(Place place, Parameter parameter, LoaderDa
     public static class Application {
 
         public void entryPoint() {
-            body().add(div().id("main"));
-            new PlaceManager()
+            PlaceManager placeManager = new PlaceManager()
                     .root(By.id("main"))
                     .register(place("/time/:area/:location")
                             .loader((place, parameter) -> {
@@ -74,8 +74,11 @@ public void entryPoint() {
                                             JsPropertyMap<String> map = Js.cast(json);
                                             return Promise.resolve(map.get("datetime"));
                                         });
-                            }), TimePage::new)
-                    .start();
+                            }), TimePage::new);
+            body().add(div().id("main")
+                    .add(link(placeManager, "/time/Europe/Berlin")
+                            .textNode("What time is it in Berlin?")));
+            placeManager.start();
         }
     }
     // @end region = placeManager

diff --git a/router/src/main/java/org/jboss/elemento/router/Link.java b/router/src/main/java/org/jboss/elemento/router/Link.java
@@ -21,17 +21,28 @@
 
 import static org.jboss.elemento.Elements.a;
 
+/**
+ * The Link class represents a hyperlink element that creates hyperlinks using the {@link PlaceManager}. It extends the
+ * HTMLContainerBuilder class, which is a builder for container-like HTML elements.
+ */
 public class Link extends HTMLContainerBuilder<HTMLAnchorElement> {
 
     // ------------------------------------------------------ factory
 
+    /**
+     * Creates a new Link instance based on the given PlaceManager and route.
+     *
+     * @param placeManager The PlaceManager used to resolve the route.
+     * @param route        The route of the hyperlink.
+     * @return The new Link instance.
+     */
     public static Link link(PlaceManager placeManager, String route) {
         return new Link(placeManager, route);
     }
 
     // ------------------------------------------------------ instance
 
-    public Link(PlaceManager placeManager, String route) {
+    Link(PlaceManager placeManager, String route) {
         super(a(placeManager.href(route)).element());
     }