forked from extnet/Ext.NET
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathKeyNav.cs
More file actions
649 lines (575 loc) · 19.4 KB
/
KeyNav.cs
File metadata and controls
649 lines (575 loc) · 19.4 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
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
/********
* @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.Web.UI;
using System.Drawing;
using Ext.Net.Utilities;
namespace Ext.Net
{
/// <summary>
/// Provides a convenient wrapper for normalized keyboard navigation. KeyNav allows you to bind navigation keys to function calls that will get called when the keys are pressed, providing an easy way to implement custom navigation schemes for any UI component.
/// The following are all of the possible keys that can be implemented: enter, space, left, right, up, down, tab, esc, pageUp, pageDown, del, backspace, home, end.
/// </summary>
[Meta]
[ToolboxData("<{0}:KeyNav runat=\"server\"></{0}:KeyNav>")]
[ToolboxBitmap(typeof(KeyNav), "Build.ToolboxIcons.KeyMap.bmp")]
[Designer(typeof(EmptyDesigner))]
[Description("Provides a convenient wrapper for normalized keyboard navigation. KeyNav allows you to bind navigation keys to function calls that will get called when the keys are pressed, providing an easy way to implement custom navigation schemes for any UI component.")]
public partial class KeyNav : Observable
{
/// <summary>
///
/// </summary>
[Description("")]
public KeyNav() { }
/// <summary>
///
/// </summary>
[Category("0. About")]
[Description("")]
public override string InstanceOf
{
get
{
return "Ext.util.KeyNav";
}
}
protected internal bool BelongsToCmp
{
get;
set;
}
/// <summary>
/// True to listen component event instead underlying element
/// </summary>
[Meta]
[ConfigOption]
[Category("3. KeyNav")]
[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>
/// The method to call on the Ext.EventObject after this KeyNav intercepts a key. Valid values are Ext.EventObject.stopEvent, Ext.EventObject.preventDefault and Ext.EventObject.stopPropagation.
/// If a falsy value is specified, no method is called on the key event.
/// Defaults to: "stopEvent"
/// </summary>
[Meta]
[ConfigOption]
[Category("3. KeyNav")]
[DefaultValue(EventAction.StopEvent)]
[NotifyParentProperty(true)]
[Description("The method to call on the Ext.EventObject after this KeyNav intercepts a key. Valid values are Ext.EventObject.stopEvent, Ext.EventObject.preventDefault and Ext.EventObject.stopPropagation.")]
public virtual EventAction DefaultEventAction
{
get
{
return this.State.Get<EventAction>("DefaultEventAction", EventAction.StopEvent);
}
set
{
this.State.Set("DefaultEventAction", value);
}
}
/// <summary>
/// True to disable this KeyNav instance (defaults to false)
/// </summary>
[Meta]
[ConfigOption]
[Category("3. KeyNav")]
[DefaultValue(false)]
[NotifyParentProperty(true)]
[DirectEventUpdate(MethodName = "SetDisabled")]
[Description("True to disable this KeyNav instance (defaults to false)")]
public virtual bool Disabled
{
get
{
return this.State.Get<bool>("Disabled", false);
}
set
{
this.State.Set("Disabled", value);
}
}
/// <summary>
/// The event to listen for to pick up key events. Defaults to: "keypress"
/// </summary>
[Meta]
[ConfigOption]
[Category("3. KeyMap")]
[DefaultValue("")]
[Description("The event to listen for to pick up key events. Defaults to: \"keypress\"")]
public virtual string EventName
{
get
{
return this.State.Get<string>("EventName", "");
}
set
{
this.State.Set("EventName", value);
}
}
/// <summary>
/// Handle the keydown event instead of keypress. KeyNav automatically does this for IE since IE does not propagate special keys on keypress, but setting this to true will force other browsers to also handle keydown instead of keypress. Defaults to: false
/// </summary>
[Meta]
[ConfigOption]
[Category("3. KeyNav")]
[DefaultValue(false)]
[NotifyParentProperty(true)]
[Description("Handle the keydown event instead of keypress. KeyNav automatically does this for IE since IE does not propagate special keys on keypress, but setting this to true will force other browsers to also handle keydown instead of keypress. Defaults to: false")]
public virtual bool ForceKeyDown
{
get
{
return this.State.Get<bool>("ForceKeyDown", false);
}
set
{
this.State.Set("ForceKeyDown", value);
}
}
/// <summary>
/// Element name of target component (can be used if KeyNav belongs to a component)
/// </summary>
[Meta]
[ConfigOption("cmpEl")]
[Category("3. KeyMap")]
[DefaultValue("")]
[Description("Element name of target component (can be used if KeyNav 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 { Owner = this };
}
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 element to bind to
/// </summary>
[Meta]
[Category("3. KeyNav")]
[DefaultValue("")]
[Description("The element to bind to")]
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, "\"");
}
}
private JFunction space;
/// <summary>
///
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[Category("3. KeyNav")]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
[Description("")]
public JFunction Space
{
get
{
if (this.space == null)
{
this.space = new JFunction { Args = new string[] { "e" }, Owner = this };
}
return this.space;
}
}
private JFunction left;
/// <summary>
///
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[Category("3. KeyNav")]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
[Description("")]
public JFunction Left
{
get
{
if (this.left == null)
{
this.left = new JFunction { Args = new string[] { "e" }, Owner = this };
}
return this.left;
}
}
private JFunction right;
/// <summary>
///
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[Category("3. KeyNav")]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
[Description("")]
public JFunction Right
{
get
{
if (this.right == null)
{
this.right = new JFunction { Args = new string[] { "e" }, Owner = this };
}
return this.right;
}
}
private JFunction up;
/// <summary>
///
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[Category("3. KeyNav")]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
[Description("")]
public JFunction Up
{
get
{
if (this.up == null)
{
this.up = new JFunction { Args = new string[] { "e" }, Owner = this };
}
return this.up;
}
}
private JFunction down;
/// <summary>
///
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[Category("3. KeyNav")]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
[Description("")]
public JFunction Down
{
get
{
if (this.down == null)
{
this.down = new JFunction { Args = new string[] { "e" }, Owner = this };
}
return this.down;
}
}
private JFunction pageUp;
/// <summary>
///
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[Category("3. KeyNav")]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
[Description("")]
public JFunction PageUp
{
get
{
if (this.pageUp == null)
{
this.pageUp = new JFunction { Args = new string[] { "e" }, Owner = this };
}
return this.pageUp;
}
}
private JFunction pageDown;
/// <summary>
///
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[Category("3. KeyNav")]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
[Description("")]
public JFunction PageDown
{
get
{
if (this.pageDown == null)
{
this.pageDown = new JFunction { Args = new string[] { "e" }, Owner = this };
}
return this.pageDown;
}
}
private JFunction del;
/// <summary>
///
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[Category("3. KeyNav")]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
[Description("")]
public JFunction Del
{
get
{
if (this.del == null)
{
this.del = new JFunction { Args = new string[] { "e" }, Owner = this };
}
return this.del;
}
}
private JFunction home;
/// <summary>
///
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[Category("3. KeyNav")]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
[Description("")]
public JFunction Home
{
get
{
if (this.home == null)
{
this.home = new JFunction { Args = new string[] { "e" }, Owner = this };
}
return this.home;
}
}
private JFunction end;
/// <summary>
///
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[Category("3. KeyNav")]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
[Description("")]
public JFunction End
{
get
{
if (this.end == null)
{
this.end = new JFunction { Args = new string[] { "e" }, Owner = this };
}
return this.end;
}
}
private JFunction enter;
/// <summary>
///
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[Category("3. KeyNav")]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
[Description("")]
public JFunction Enter
{
get
{
if (this.enter == null)
{
this.enter = new JFunction { Args = new string[] { "e" }, Owner = this };
}
return this.enter;
}
}
private JFunction esc;
/// <summary>
///
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[Category("3. KeyNav")]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
[Description("")]
public JFunction Esc
{
get
{
if (this.esc == null)
{
this.esc = new JFunction { Args = new string[] { "e" }, Owner = this };
}
return this.esc;
}
}
private JFunction tab;
/// <summary>
///
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[Category("3. KeyNav")]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
[Description("")]
public JFunction Tab
{
get
{
if (this.tab == null)
{
this.tab = new JFunction { Args = new string[] { "e" }, Owner = this };
}
return this.tab;
}
}
/// <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>
/// 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");
}
}
}