From 70860295139996966bb077f7df694102083da131 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Leif=20=C3=85strand?= Date: Mon, 25 Jun 2012 16:34:38 +0300 Subject: [PATCH] Add some missing Javadoc to Page (#8907) --- src/com/vaadin/terminal/Page.java | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/com/vaadin/terminal/Page.java b/src/com/vaadin/terminal/Page.java index e6d06a837a..8ccb243a1e 100644 --- a/src/com/vaadin/terminal/Page.java +++ b/src/com/vaadin/terminal/Page.java @@ -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 + * null + */ 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); } -- 2.39.5