KickJava   Java API By Example, From Geeks To Geeks.

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


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