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>EchoDomPropertyStore</code> message parts to
38: * the <code>ServerMessage</code>. <code>EchoDomPropertyStore</code> message
39: * parts are used to store non-rendered information in the client DOM.
40: */
41: public class DomPropertyStore {
42:
43: private static final String MESSAGE_PART_NAME = "EchoDomPropertyStore.MessageProcessor";
44: private static final String[] PROPERTY_STORE_KEYS = new String[] {
45: "name", "value" };
46:
47: /**
48: * Creates a <code>store-property</code> operation to store a non-rendered
49: * named property in an HTMLElement of the client DOM.
50: *
51: * @param serverMessage the outgoing <code>ServerMessage</code>
52: * @param elementId the id of the element on which to set the non-rendered
53: * property
54: * @param propertyName the name of the property
55: * @param propertyValue the value of the property
56: */
57: public static void renderSetProperty(ServerMessage serverMessage,
58: String elementId, String propertyName, String propertyValue) {
59: Element itemizedUpdateElement = serverMessage
60: .getItemizedDirective(
61: ServerMessage.GROUP_ID_POSTUPDATE,
62: MESSAGE_PART_NAME, "store-property",
63: PROPERTY_STORE_KEYS, new String[] {
64: propertyName, propertyValue });
65: Element itemElement = serverMessage.getDocument()
66: .createElement("item");
67: itemElement.setAttribute("eid", elementId);
68: itemizedUpdateElement.appendChild(itemElement);
69: }
70: }
|