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 org.w3c.dom.Element;
33:
34: import nextapp.echo2.webrender.ServerMessage;
35:
36: /**
37: * A utility class to add <code>EchoVirtualPosition</code> message parts to the
38: * <code>ServerMessage</code>. <code>EchoVirtualPosition</code> message parts
39: * are used to register elements with the client-side "Virtual Positioning" API.
40: */
41: public class VirtualPosition {
42:
43: private static final String MESSAGE_PART_NAME = "EchoVirtualPosition.MessageProcessor";
44: private static final String[] EMPTY = new String[] {};
45:
46: /**
47: * Creates a <code>register</code> operation to register an element id
48: * with the virtual positioning API.
49: *
50: * @param serverMessage the outgoing <code>ServerMessage</code>
51: * @param elementId the id of the element to register
52: */
53: public static void renderRegister(ServerMessage serverMessage,
54: String elementId) {
55: Element itemizedUpdateElement = serverMessage
56: .getItemizedDirective(
57: ServerMessage.GROUP_ID_POSTUPDATE,
58: MESSAGE_PART_NAME, "register", EMPTY, EMPTY);
59: Element itemElement = serverMessage.getDocument()
60: .createElement("item");
61: itemElement.setAttribute("eid", elementId);
62: itemizedUpdateElement.appendChild(itemElement);
63: }
64: }
|