summaryrefslogtreecommitdiff
path: root/webapps/qooxdoo-0.6.3-sdk/frontend/framework/source/class/qx/event/type/DomEvent.js
blob: 5e62b5333ec727b3ee4613cd25553a67d9f208cc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/* ************************************************************************

   qooxdoo - the new era of web development

   http://qooxdoo.org

   Copyright:
     2004-2006 by 1&1 Internet AG, Germany, http://www.1and1.org

   License:
     LGPL 2.1: http://www.gnu.org/licenses/lgpl.html

   Authors:
     * Sebastian Werner (wpbasti)
     * Andreas Ecker (ecker)

************************************************************************ */

/* ************************************************************************

#module(ui_core)

************************************************************************ */

qx.OO.defineClass("qx.event.type.DomEvent", qx.event.type.Event,
function(vType, vDomEvent, vDomTarget, vTarget, vOriginalTarget)
{
  qx.event.type.Event.call(this, vType);

  this.setDomEvent(vDomEvent);
  this.setDomTarget(vDomTarget);

  this.setTarget(vTarget);
  this.setOriginalTarget(vOriginalTarget);
});

qx.OO.addFastProperty({ name : "bubbles", defaultValue : true, noCompute : true });
qx.OO.addFastProperty({ name : "propagationStopped", defaultValue : false, noCompute : true });

qx.OO.addFastProperty({ name : "domEvent", setOnlyOnce : true, noCompute : true });
qx.OO.addFastProperty({ name : "domTarget", setOnlyOnce : true, noCompute : true });

/**
 * The modifiers. A mask of the pressed modifier keys. This is an OR-combination of
 * {@link #SHIFT_MASK}, {@link #CTRL_MASK}, {@link #ALT_MASK} and {@link #META_MASK}.
 */
qx.OO.addCachedProperty({ name : "modifiers", defaultValue : null });


// property computer
qx.Proto._computeModifiers = function() {
    var mask = 0;
    var evt = this.getDomEvent();
    if (evt.shiftKey) mask |= qx.event.type.DomEvent.SHIFT_MASK;
    if (evt.ctrlKey)  mask |= qx.event.type.DomEvent.CTRL_MASK;
    if (evt.altKey)   mask |= qx.event.type.DomEvent.ALT_MASK;
    if (evt.metaKey)  mask |= qx.event.type.DomEvent.META_MASK;
    return mask;
}






/*
---------------------------------------------------------------------------
  SPECIAL KEY SUPPORT
---------------------------------------------------------------------------
*/

/**
 * Returns whether the the ctrl key is pressed.
 *
 * @return {boolean} whether the the ctrl key is pressed.
 */
qx.Proto.isCtrlPressed = function() {
  return this.getDomEvent().ctrlKey;
}

/**
 * Returns whether the the ctrl key is pressed.
 *
 * @return {boolean} whether the the ctrl key is pressed.
 * @deprecated Use {@link #isCtrlPressed} instead.
 */
qx.Proto.getCtrlKey = qx.Proto.isCtrlPressed;


/**
 * Returns whether the the shift key is pressed.
 *
 * @return {boolean} whether the the shift key is pressed.
 */
qx.Proto.isShiftPressed = function() {
  return this.getDomEvent().shiftKey;
}

/**
 * Returns whether the the shift key is pressed.
 *
 * @return {boolean} whether the the shift key is pressed.
 * @deprecated Use {@link #isShiftPressed} instead.
 */
qx.Proto.getShiftKey = qx.Proto.isShiftPressed;


/**
 * Returns whether the the alt key is pressed.
 *
 * @return {boolean} whether the the alt key is pressed.
 */
qx.Proto.isAltPressed = function() {
  return this.getDomEvent().altKey;
}

/**
 * Returns whether the the alt key is pressed.
 *
 * @return {boolean} whether the the alt key is pressed.
 * @deprecated Use {@link #isAltPressed} instead.
 */
qx.Proto.getAltKey = qx.Proto.isAltPressed;


/**
 * Returns whether the the meta key is pressed.
 *
 * @return {boolean} whether the the meta key is pressed.
 */
qx.Proto.isMetaPressed = function() {
  return this.getDomEvent().metaKey;
}


/**
 * Returns whether the ctrl key or (on the Mac) the command key is pressed.
 *
 * @return {boolean} <code>true</code> if the command key is pressed on the Mac
 *         or the ctrl key is pressed on another system.
 */
qx.Proto.isCtrlOrCommandPressed = function() {
  if (qx.sys.Client.getInstance().runsOnMacintosh()) {
    return this.getDomEvent().metaKey;
  } else {
    return this.getDomEvent().ctrlKey;
  }
}







/*
---------------------------------------------------------------------------
  PREVENT DEFAULT
---------------------------------------------------------------------------
*/

if(qx.sys.Client.getInstance().isMshtml())
{
  qx.Proto.setDefaultPrevented = function(vValue)
  {
    if (!vValue) {
      return this.error("It is not possible to set preventDefault to false if it was true before!", "setDefaultPrevented");
    }

    this.getDomEvent().returnValue = false;

    qx.event.type.Event.prototype.setDefaultPrevented.call(this, vValue);
  }
}
else
{
  qx.Proto.setDefaultPrevented = function(vValue)
  {
    if (!vValue) {
      return this.error("It is not possible to set preventDefault to false if it was true before!", "setDefaultPrevented");
    }

    this.getDomEvent().preventDefault();
    this.getDomEvent().returnValue = false;

    qx.event.type.Event.prototype.setDefaultPrevented.call(this, vValue);
  }
}







/*
---------------------------------------------------------------------------
  DISPOSER
---------------------------------------------------------------------------
*/

qx.Proto.dispose = function()
{
  if (this.getDisposed()) {
    return;
  }

  this._valueDomEvent = null;
  this._valueDomTarget = null;

  return qx.event.type.Event.prototype.dispose.call(this);
}




/** {int} The modifier mask for the shift key. */
qx.Class.SHIFT_MASK = 1;

/** {int} The modifier mask for the control key. */
qx.Class.CTRL_MASK = 2;

/** {int} The modifier mask for the alt key. */
qx.Class.ALT_MASK = 4;

/** {int} The modifier mask for the meta key (e.g. apple key on Macs). */
qx.Class.META_MASK = 8;