KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > nextapp > echo2 > webrender > servermessage > WindowUpdate


1 /*
2  * This file is part of the Echo Web Application Framework (hereinafter "Echo").
3  * Copyright (C) 2002-2005 NextApp, Inc.
4  *
5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
6  *
7  * The contents of this file are subject to the Mozilla Public License Version
8  * 1.1 (the "License"); you may not use this file except in compliance with
9  * the License. You may obtain a copy of the License at
10  * http://www.mozilla.org/MPL/
11  *
12  * Software distributed under the License is distributed on an "AS IS" basis,
13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14  * for the specific language governing rights and limitations under the
15  * License.
16  *
17  * Alternatively, the contents of this file may be used under the terms of
18  * either the GNU General Public License Version 2 or later (the "GPL"), or
19  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
20  * in which case the provisions of the GPL or the LGPL are applicable instead
21  * of those above. If you wish to allow use of your version of this file only
22  * under the terms of either the GPL or the LGPL, and not to allow others to
23  * use your version of this file under the terms of the MPL, indicate your
24  * decision by deleting the provisions above and replace them with the notice
25  * and other provisions required by the GPL or the LGPL. If you do not delete
26  * the provisions above, a recipient may use your version of this file under
27  * the terms of any one of the MPL, the GPL or the LGPL.
28  */
29
30 package nextapp.echo2.webrender.servermessage;
31
32 import nextapp.echo2.webrender.ServerMessage;
33
34 import org.w3c.dom.Element JavaDoc;
35
36 /**
37  * A utility class to add <code>EchoWindowUpdate</code> message parts to the
38  * <code>ServerMessage</code>. <code>EchoWindowUpdate</code> message parts
39  * are used to perform miscellaneous updates to a top-level window.
40  */
41 public class WindowUpdate {
42
43     private static final String JavaDoc MESSAGE_PART_NAME = "EchoWindowUpdate";
44     
45     /**
46      * Creates a <code>reload</code> operation to reload the contents of the window.
47      *
48      * @param serverMessage the outgoing <code>ServerMessage</code>
49      */
50     public static void renderReload(ServerMessage serverMessage) {
51         serverMessage.appendPartDirective(ServerMessage.GROUP_ID_POSTUPDATE,
52                 MESSAGE_PART_NAME, "reload");
53     }
54     
55     /**
56      * Creates a <code>focus</code> operation to set the focused
57      * component within the window.
58      *
59      * @param serverMessage the outgoing <code>ServerMessage</code>
60      * @param elementId the new focused element id
61      */
62     public static void renderSetFocus(ServerMessage serverMessage, String JavaDoc elementId) {
63         Element JavaDoc element = serverMessage.appendPartDirective(ServerMessage.GROUP_ID_POSTUPDATE,
64                 MESSAGE_PART_NAME, "set-focus");
65         element.setAttribute("element-id", elementId);
66     }
67     
68     /**
69      * Creates a <code>set-title</code> operation to set the title of a
70      * top-level browser window.
71      *
72      * @param serverMessage the outgoing <code>ServerMessage</code>
73      * @param newValue the new window title
74      */
75     public static void renderSetWindowTitle(ServerMessage serverMessage, String JavaDoc newValue) {
76         Element JavaDoc element = serverMessage.appendPartDirective(ServerMessage.GROUP_ID_UPDATE,
77                 MESSAGE_PART_NAME, "set-title");
78         element.setAttribute("title", newValue);
79     }
80 }
81
Popular Tags