Add option to use PushState instead of URI fragments in Navigator (#10042)

* Navigator now by default uses pushState and normal URLs

* added documentation for pushState and updated Navigator documentation

* improving docs etc, adding one TODO to be solved before merging

* pushState/replaceState no work better with changing titles

* Making uri fragment navigator work when not using specially mapped UI

* Revert to older default, add annotation for selecting

* Fix tests, add null checks

* Reorder if-clause, fix tests

* Revert unnecessary test change

* Use correct variable in UI, fix test clean up

* Updates to JavaDocs, fix some methods and tests

* Add comments, fix test ui, TODO for fallbacks

* Navigation documentation, JavaDocs, removed TODOs

* Documentation fixes

* Improve JavaDocs

* Fix link name in documentation

* Improve throws declaration in getLocation

* Change documentation about the PushState based navigation

* Add since tags

* Add since tags for UI

1 files changed, 9 insertions, 0 deletions

diff --git a/shared/src/main/java/com/vaadin/shared/ApplicationConstants.java b/shared/src/main/java/com/vaadin/shared/ApplicationConstants.java
index b3490a434c..4ce1ee0ac0 100644
--- a/shared/src/main/java/com/vaadin/shared/ApplicationConstants.java
+++ b/shared/src/main/java/com/vaadin/shared/ApplicationConstants.java
@@ -206,6 +206,15 @@ public class ApplicationConstants implements Serializable {
     public static final String WIDGETSET_VERSION_ID = "wsver";
 
     /**
+     * A request attribute name to store the part of pathInfo that was used to
+     * select the UI. Will be used by default Navigator to separate view
+     * identifiers from UI. This can be set by custom UI providers.
+     * 
+     * @since 8.2
+     **/
+    public static final String UI_ROOT_PATH = "com.vaadin.server.UI_ROOT_PATH";
+
+    /**
      * Content type to use for text/html responses (should always be UTF-8).
      */
     public static final String CONTENT_TYPE_TEXT_HTML_UTF_8 = "text/html; charset=utf-8";