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 the base class of "transport" classes, these classes are used to send custom data from client
18: * to server using an event fired on the client and listened in the server.
19: *
20: * <p>Derived classes may do some kind of automatic synchronization in the server, for instance
21: * an attribute of a client element can be transported and updated the server counterpart element.</p>
22:
23: *
24: * @author Jose Maria Arranz Santamaria
25: * @see org.itsnat.core.ItsNatDocument#addEventListener(EventTarget,String,EventListener,boolean,ParamTransport)
26: */
27: public abstract class ParamTransport {
28: private boolean sync;
29:
30: /**
31: * Creates a new instance with optional synchronization.
32: *
33: *
34: * @param sync if true the server is synchronized in some way.
35: */
36: protected ParamTransport(boolean sync) {
37: this .sync = sync;
38: }
39:
40: /**
41: * If the server state is synchronized in some way.
42: *
43: * @return true if the server is synchronized.
44: */
45: public boolean isSync() {
46: return sync;
47: }
48: }
|