forked from extnet/Ext.NET
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathKeyMap.cs
More file actions
371 lines (331 loc) · 12.2 KB
/
KeyMap.cs
File metadata and controls
371 lines (331 loc) · 12.2 KB
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
/********
* @version : 2.1.1 - Ext.NET Pro License
* @author : Ext.NET, Inc. http://www.ext.net/
* @date : 2012-12-10
* @copyright : Copyright (c) 2007-2012, Ext.NET, Inc. (http://www.ext.net/). All rights reserved.
* @license : See license.txt and http://www.ext.net/license/.
********/
using System;
using System.ComponentModel;
using System.Drawing;
using System.Text;
using System.Web.UI;
using Ext.Net.Utilities;
namespace Ext.Net
{
/// <summary>
/// Handles mapping key events to handling functions for an element or a Component. One KeyMap can be used for multiple actions.
///
/// A KeyMap must be configured with a target as an event source which may be an Element or a Component.
///
/// If the target is an element, then the keydown event will trigger the invocation of bindings.
///
/// It is possible to configure the KeyMap with a custom eventName to listen for. This may be useful when the target is a Component.
///
/// The KeyMap's event handling requires that the first parameter passed is a key event. So if the Component's event signature is different, specify a processEvent configuration which accepts the event's parameters and returns a key event.
///
/// Functions specified in bindings are called with this signature : (String key, Ext.EventObject e) (if the match is a multi-key combination the callback will still be called only once). A KeyMap can also handle a string representation of keys. By default KeyMap starts enabled.
/// </summary>
[Meta]
[ToolboxData("<{0}:KeyMap runat=\"server\"></{0}:KeyMap>")]
[ToolboxBitmap(typeof(KeyMap), "Build.ToolboxIcons.KeyMap.bmp")]
[Designer(typeof(EmptyDesigner))]
[Description("Handles mapping keys to actions for an element.")]
public partial class KeyMap : LazyObservable, ICustomConfigSerialization
{
/// <summary>
///
/// </summary>
[Description("")]
public KeyMap() { }
/// <summary>
///
/// </summary>
[Category("0. About")]
[Description("")]
public override string InstanceOf
{
get
{
return "Ext.util.KeyMap";
}
}
protected internal bool BelongsToCmp
{
get;
set;
}
private KeyBindingCollection binding;
/// <summary>
/// Either a single object describing a handling function for s specified key (or set of keys), or an array of such objects.
/// </summary>
[Meta]
[Category("3. KeyMap")]
[NotifyParentProperty(true)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Description("Either a single object describing a handling function for s specified key (or set of keys), or an array of such objects.")]
public virtual KeyBindingCollection Binding
{
get
{
if (this.binding == null)
{
this.binding = new KeyBindingCollection { Owner = this };
}
return this.binding;
}
}
[ConfigOption("binding", JsonMode.Raw)]
[DefaultValue("")]
protected virtual string BindingProxy
{
get
{
if (this.Binding.Count == 0)
{
return "";
}
if (this.Binding.Count == 1)
{
return new ClientConfig().SerializeInternal(this.Binding[0], this);
}
else
{
StringBuilder sb = new StringBuilder();
bool comma = false;
sb.Append("[");
foreach (KeyBinding keyBinding in this.Binding)
{
if (comma)
{
sb.Append(",");
}
sb.Append(new ClientConfig().SerializeInternal(keyBinding, this));
comma = true;
}
sb.Append("]");
return sb.ToString();
}
}
}
/// <summary>
/// The event to listen for to pick up key events. Defaults to: "keydown"
/// </summary>
[Meta]
[ConfigOption]
[Category("3. KeyMap")]
[DefaultValue("")]
[Description("The event to listen for to pick up key events. Defaults to: \"keydown\"")]
public virtual string EventName
{
get
{
return this.State.Get<string>("EventName", "");
}
set
{
this.State.Set("EventName", value);
}
}
/// <summary>
/// True to listen component event instead underlying element
/// </summary>
[Meta]
[ConfigOption]
[Category("3. KeyMap")]
[DefaultValue(false)]
[Description("True to listen component event instead underlying element")]
public virtual bool ComponentEvent
{
get
{
return this.State.Get<bool>("ComponentEvent", false);
}
set
{
this.State.Set("ComponentEvent", value);
}
}
/// <summary>
/// Element name of target component (can be used if KeyMap belongs to a component)
/// </summary>
[Meta]
[ConfigOption("cmpEl")]
[Category("3. KeyMap")]
[DefaultValue("")]
[Description("Element name of target component (can be used if KeyMap belongs to a component)")]
public virtual string ComponentElement
{
get
{
return this.State.Get<string>("ComponentElement", "");
}
set
{
this.State.Set("ComponentElement", value);
}
}
/// <summary>
/// Configure this as true if there are any input fields within the target, and this KeyNav should not process events from input fields, (<input>, <textarea> and elements withcontentEditable="true"`). Defaults to: false
/// </summary>
[Meta]
[ConfigOption]
[Category("3. KeyMap")]
[DefaultValue(false)]
[Description("Configure this as true if there are any input fields within the target, and this KeyNav should not process events from input fields, (<input>, <textarea> and elements withcontentEditable=\"true\"). Defaults to: false")]
public virtual bool IgnoreInputFields
{
get
{
return this.State.Get<bool>("IgnoreInputFields", false);
}
set
{
this.State.Set("IgnoreInputFields", value);
}
}
private JFunction processEvent;
/// <summary>
/// An optional event processor function which accepts the argument list provided by the configured event of the target, and returns a keyEvent for processing by the KeyMap.
///
/// This may be useful when the target is a Component with s complex event signature, where the event is not the first parameter. Extra information from the event arguments may be injected into the event for use by the handler functions before returning it.
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
[Description("")]
public virtual JFunction ProcessEvent
{
get
{
if (this.processEvent == null)
{
this.processEvent = new JFunction();
}
return this.processEvent;
}
}
/// <summary>
/// The scope (this context) in which the processEvent method is executed.
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[DefaultValue("")]
[NotifyParentProperty(true)]
[Description("The scope (this context) in which the processEvent method is executed.")]
public virtual string ProcessEventScope
{
get
{
return this.State.Get<string>("ProcessEventScope", "");
}
set
{
this.State.Set("ProcessEventScope", value);
}
}
/// <summary>
/// The object on which to listen for the event specified by the eventName config option.
/// </summary>
[Meta]
[Category("3. KeyMap")]
[DefaultValue("")]
[Description("The object on which to listen for the event specified by the eventName config option.")]
public virtual string Target
{
get
{
return this.State.Get<string>("Target", "");
}
set
{
this.State.Set("Target", value);
}
}
[ConfigOption("target", JsonMode.Raw)]
[DefaultValue("")]
protected virtual string TargetProxy
{
get
{
if(this.Target.IsEmpty())
{
return "";
}
string parsedTarget = TokenUtils.ParseTokens(this.Target, this);
if (TokenUtils.IsRawToken(parsedTarget))
{
return TokenUtils.ReplaceRawToken(parsedTarget);
}
return "\"".ConcatWith(parsedTarget, "\"");
}
}
/* Public Methods
-----------------------------------------------------------------------------------------------*/
/// <summary>
/// Enables this KeyMap
/// </summary>
public virtual void Enable()
{
this.Call("enable");
}
/// <summary>
/// Disable this KeyMap
/// </summary>
public virtual void Disable()
{
this.Call("disable");
}
/// <summary>
/// Convenience function for setting disabled/enabled by boolean.
/// </summary>
/// <param name="disabled"></param>
public virtual void SetDisabled(bool disabled)
{
this.Call("setDisabled", disabled);
}
/// <summary>
///
/// </summary>
/// <param name="keyBinding"></param>
public virtual void AddKeyBinding(KeyBinding keyBinding)
{
RequestManager.EnsureDirectEvent();
this.Call("addBinding", JRawValue.From(new ClientConfig().Serialize(keyBinding, true)));
}
/// <summary>
/// Destroys the KeyMap instance and removes all handlers.
/// </summary>
/// <param name="removeTarget">True to also remove the target</param>
public virtual void Destroy(bool removeTarget)
{
this.Call("destroy", removeTarget);
}
/// <summary>
/// Destroys the KeyMap instance and removes all handlers.
/// </summary>
public override void Destroy()
{
this.Call("destroy");
}
public string ToScript(Control owner)
{
string config = new ClientConfig().Serialize(this, true);
if(this.BelongsToCmp)
{
return config;
}
string script;
if (this.IsIdRequired)
{
script = string.Format("window.{0}=Ext.create(\"{1}\",{2})", this.ClientID, this.InstanceOf, config);
}
else
{
script = string.Format("Ext.create(\"{0}\",{1})", this.InstanceOf, config);
}
return this.IsLazy ? script : (script + ";");
}
}
}