01: /*
02: * This file is part of the Echo Web Application Framework (hereinafter "Echo").
03: * Copyright (C) 2002-2005 NextApp, Inc.
04: *
05: * Version: MPL 1.1/GPL 2.0/LGPL 2.1
06: *
07: * The contents of this file are subject to the Mozilla Public License Version
08: * 1.1 (the "License"); you may not use this file except in compliance with
09: * 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;
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 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(
52: ServerMessage.GROUP_ID_POSTUPDATE, MESSAGE_PART_NAME,
53: "reload");
54: }
55:
56: /**
57: * Creates a <code>focus</code> operation to set the focused
58: * component within the window.
59: *
60: * @param serverMessage the outgoing <code>ServerMessage</code>
61: * @param elementId the new focused element id
62: */
63: public static void renderSetFocus(ServerMessage serverMessage,
64: String elementId) {
65: Element element = serverMessage.appendPartDirective(
66: ServerMessage.GROUP_ID_POSTUPDATE, MESSAGE_PART_NAME,
67: "set-focus");
68: element.setAttribute("element-id", elementId);
69: }
70:
71: /**
72: * Creates a <code>set-title</code> operation to set the title of a
73: * top-level browser window.
74: *
75: * @param serverMessage the outgoing <code>ServerMessage</code>
76: * @param newValue the new window title
77: */
78: public static void renderSetWindowTitle(
79: ServerMessage serverMessage, String newValue) {
80: Element element = serverMessage.appendPartDirective(
81: ServerMessage.GROUP_ID_UPDATE, MESSAGE_PART_NAME,
82: "set-title");
83: element.setAttribute("title", newValue);
84: }
85: }
|