]> source.dussan.org Git - vaadin-framework.git/commitdiff
Add some missing Javadoc to Page (#8907)
authorLeif Åstrand <leif@vaadin.com>
Mon, 25 Jun 2012 13:34:38 +0000 (16:34 +0300)
committerLeif Åstrand <leif@vaadin.com>
Mon, 25 Jun 2012 13:34:38 +0000 (16:34 +0300)
src/com/vaadin/terminal/Page.java

index e6d06a837a0d48a4185e6ac157b552ce0110abbd..8ccb243a1e8230c69dd0cc3fe17eb28a416f2a42 100644 (file)
@@ -614,6 +614,16 @@ public class Page implements Serializable {
         addNotification(notification);
     }
 
+    /**
+     * Gets the Page to which the current root belongs. This is automatically
+     * defined when processing requests to the server. In other cases, (e.g.
+     * from background threads), the current root is not automatically defined.
+     * 
+     * @see Root#getCurrent()
+     * 
+     * @return the current page instance if available, otherwise
+     *         <code>null</code>
+     */
     public static Page getCurrent() {
         Root currentRoot = Root.getCurrent();
         if (currentRoot == null) {
@@ -622,6 +632,13 @@ public class Page implements Serializable {
         return currentRoot.getPage();
     }
 
+    /**
+     * Sets the page title. The page title is displayed by the browser e.g. as
+     * the title of the browser window or as the title of the tab.
+     * 
+     * @param title
+     *            the new page title to set
+     */
     public void setTitle(String title) {
         root.getRpcProxy(PageClientRpc.class).setTitle(title);
     }