DomPropertyStore


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  ;
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  []{"name", "value"};
45  
46      /**
47       * Creates a <code>store-property</code> operation to store a non-rendered
48       * named property in an HTMLElement of the client DOM.
49       * 
50       * @param serverMessage the outgoing <code>ServerMessage</code>
51       * @param elementId the id of the element on which to set the non-rendered
52       *        property
53       * @param propertyName the name of the property
54       * @param propertyValue the value of the property
55       */
56      public static void renderSetProperty(ServerMessage serverMessage, String   elementId, String   propertyName, 
57              String   propertyValue) {
58          Element   itemizedUpdateElement = serverMessage.getItemizedDirective(ServerMessage.GROUP_ID_POSTUPDATE, 
59                  MESSAGE_PART_NAME, "store-property", PROPERTY_STORE_KEYS, new String  []{propertyName, propertyValue});
60          Element   itemElement = serverMessage.getDocument().createElement("item");
61          itemElement.setAttribute("eid", elementId);
62          itemizedUpdateElement.appendChild(itemElement);
63      }
64  }
65
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags