01: /*
02: ItsNat Java Web Application Framework
03: Copyright (C) 2007 Innowhere Software Services S.L., Spanish Company
04: Author: Jose Maria Arranz Santamaria
05:
06: This program is free software: you can redistribute it and/or modify
07: it under the terms of the GNU Affero General Public License as published by
08: the Free Software Foundation, either version 3 of the License, or
09: (at your option) any later version. See the GNU Affero General Public
10: License for more details. See the copy of the GNU Affero General Public License
11: included in this program. If not, see <http://www.gnu.org/licenses/>.
12: */
13:
14: package org.itsnat.core.event;
15:
16: /**
17: * Is used to command ItsNat to transport one value from client to server
18: * using an event fired on the client and listened in the server.
19: *
20: * <p>The transported value can be obtained
21: * calling {@link org.itsnat.core.event.ItsNatEvent#getExtraParam(String)}</p>
22: *
23: * @see org.itsnat.core.ItsNatDocument#addEventListener(org.w3c.dom.events.EventTarget,String,org.w3c.dom.events.EventListener,boolean,int,ParamTransport[],String,long)
24: * @author Jose Maria Arranz Santamaria
25: */
26: public class CustomParamTransport extends SingleParamTransport {
27: private String code;
28:
29: /**
30: * Creates a new instance ready to transport a value obtained in the client using the specified name
31: * and the specified JavaScript code. This code is executed to obtain the value before the event
32: * is sent to the server.
33: *
34: * @param name the name used to identify the value.
35: * @param code the JavaScript code used to obtain the value to send to the server.
36: */
37: public CustomParamTransport(String name, String code) {
38: super (name, false);
39:
40: this .code = code;
41: }
42:
43: /**
44: * Returns the JavaScript code used to obtain the value to send to the server.
45: *
46: * @return code the JavaScript code.
47: */
48: public String getScriptCode() {
49: return code;
50: }
51: }
|