WebSVN – SmartDukaan – Blame – /trunk/GoogleAppDatalog/src/main/webapp/DataTables/extras/AutoFill/media/docs/symbols/AutoFill.html

Rev	Author	Line No.	Line
2629	vikas	1	`<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">`
		2	`<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">`
		3	`<head>`
		4	`<meta http-equiv="content-type" content="text/html; charset=utf-8" />`
		5	`<meta name="generator" content="JsDoc Toolkit" />`
		6
		7	`<title>JsDoc Reference - AutoFill</title>`
		8	`<link href="../css/default.css" type="text/css" rel="stylesheet" media="all" />`
		9	`</head>`
		10
		11	`<body>`
		12	`<div id="header">`
		13	`</div>`
		14
		15	`<div class="index">`
		16	`<div class="menu">`
		17	`<!-- begin publish.classesIndex -->`
		18	`<div align="center"><a href="../index.html">Class Index</a> \| <a href="../files.html">File Index</a></div>`
		19
		20	`<h2 class="heading1">Classes</h2>`
		21
		22	`<ul class="classList">`
		23
		24	`<li><a href="../symbols/_global_.html">_global_</a></li>`
		25
		26	`<li><a href="../symbols/AutoFill.html">AutoFill</a></li>`
		27
		28	`<li><a href="../symbols/AutoFill%23dom.html">AutoFill#dom</a></li>`
		29
		30	`<li><a href="../symbols/AutoFill%23s.html">AutoFill#s</a></li>`
		31
		32	`<li><a href="../symbols/AutoFill%23s.border.html">AutoFill#s.border</a></li>`
		33
		34	`<li><a href="../symbols/AutoFill%23s.columns.html">AutoFill#s.columns</a></li>`
		35
		36	`<li><a href="../symbols/AutoFill%23s.drag.html">AutoFill#s.drag</a></li>`
		37
		38	`<li><a href="../symbols/AutoFill%23s.filler.html">AutoFill#s.filler</a></li>`
		39
		40	`<li><a href="../symbols/AutoFill%23s.screen.html">AutoFill#s.screen</a></li>`
		41
		42	`<li><a href="../symbols/AutoFill%23s.scroller.html">AutoFill#s.scroller</a></li>`
		43
		44	`</ul>`
		45
		46	`<!-- end publish.classesIndex -->`
		47	`</div>`
		48
		49	`<div class="fineprint" style="clear:both">`
		50
		51	`Generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Sun Jun 26 2011 09:40:59 GMT+0100 (BST)<br />`
		52	`HTML template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a>`
		53	`</div>`
		54	`</div>`
		55
		56	`<div class="content">`
		57	`<div class="innerContent">`
		58	`<h1 class="classTitle">`
		59
		60	`Class <span>AutoFill</span>`
		61	`</h1>`
		62
		63	`<p class="description summary">`
		64
		65
		66
		67
		68	`AutoFill`
		69
		70
		71	`<br /><em>Defined in: </em> <a href="../symbols/src/js_AutoFill.js.html">AutoFill.js</a>.`
		72
		73	`</p>`
		74
		75
		76	`<div class="props">`
		77	`<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class AutoFill.">`
		78	`<caption>Class Summary</caption>`
		79	`<thead>`
		80	`<tr>`
		81	`<th scope="col">Constructor Attributes</th>`
		82	`<th scope="col">Constructor Name and Description</th>`
		83	`</tr>`
		84	`</thead>`
		85	`<tbody>`
		86	`<tr>`
		87	`<td class="attributes"> </td>`
		88	`<td class="nameDescription" >`
		89	`<div class="fixedFont">`
		90	`<b><a href="../symbols/AutoFill.html#constructor">AutoFill</a></b>(DataTables, Configuration)`
		91	`</div>`
		92	`<div class="description">AutoFill provides Excel like auto fill features for a DataTable</div>`
		93	`</td>`
		94	`</tr>`
		95	`</tbody>`
		96	`</table>`
		97	`</div>`
		98
		99
		100
		101
		102
		103	`<div class="props">`
		104	`<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class AutoFill.">`
		105	`<caption>Field Summary</caption>`
		106
		107	`<thead>`
		108	`<tr>`
		109	`<th scope="col">Field Attributes</th>`
		110	`<th scope="col">Field Name and Description</th>`
		111	`</tr>`
		112	`</thead>`
		113
		114	`<tbody>`
		115
		116	`<tr>`
		117	`<td class="attributes"><constant>  </td>`
		118	`<td class="nameDescription">`
		119	`<div class="fixedFont">`
		120	`<b><a href="../symbols/AutoFill.html#CLASS">CLASS</a></b>`
		121	`</div>`
		122	`<div class="description">Name of this class</div>`
		123	`</td>`
		124	`</tr>`
		125
		126	`<tr>`
		127	`<td class="attributes"><static> <constant>  </td>`
		128	`<td class="nameDescription">`
		129	`<div class="fixedFont">`
		130	`AutoFill.<b><a href="../symbols/AutoFill.html#.VERSION">VERSION</a></b>`
		131	`</div>`
		132	`<div class="description">AutoFill version</div>`
		133	`</td>`
		134	`</tr>`
		135
		136	`</tbody>`
		137	`</table>`
		138	`</div>`
		139
		140
		141
		142
		143
		144	`<!--`
		145	`#### METHODS SUMMARY`
		146	`-->`
		147
		148
		149
		150	`<div class="props">`
		151	`<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class AutoFill.">`
		152	`<caption>Method Summary</caption>`
		153
		154	`<thead>`
		155	`<tr>`
		156	`<th scope="col">Method Attributes</th>`
		157	`<th scope="col">Method Name and Description</th>`
		158	`</tr>`
		159	`</thead>`
		160
		161	`<tbody>`
		162
		163	`<tr>`
		164	`<td class="attributes"><private>  </td>`
		165	`<td class="nameDescription">`
		166	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnAddColumn">_fnAddColumn</a></b>(i)`
		167	`</div>`
		168	`<div class="description"></div>`
		169	`</td>`
		170	`</tr>`
		171
		172	`<tr>`
		173	`<td class="attributes"><private>  </td>`
		174	`<td class="nameDescription">`
		175	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnColumnDefs">_fnColumnDefs</a></b>(aoColumnDefs)`
		176	`</div>`
		177	`<div class="description"></div>`
		178	`</td>`
		179	`</tr>`
		180
		181	`<tr>`
		182	`<td class="attributes"><private>  </td>`
		183	`<td class="nameDescription">`
		184	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnColumnOptions">_fnColumnOptions</a></b>(i, opts)`
		185	`</div>`
		186	`<div class="description"></div>`
		187	`</td>`
		188	`</tr>`
		189
		190	`<tr>`
		191	`<td class="attributes"><private>  </td>`
		192	`<td class="nameDescription">`
		193	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnColumnsAll">_fnColumnsAll</a></b>(aoColumns)`
		194	`</div>`
		195	`<div class="description"></div>`
		196	`</td>`
		197	`</tr>`
		198
		199	`<tr>`
		200	`<td class="attributes"><private>  </td>`
		201	`<td class="nameDescription">`
		202	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnFillerDisplay">_fnFillerDisplay</a></b>(e)`
		203	`</div>`
		204	`<div class="description">Display the drag handle on mouse over cell</div>`
		205	`</td>`
		206	`</tr>`
		207
		208	`<tr>`
		209	`<td class="attributes"><private>  </td>`
		210	`<td class="nameDescription">`
		211	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnFillerDragMove">_fnFillerDragMove</a></b>(e)`
		212	`</div>`
		213	`<div class="description">Mouse move event handler for during a move.</div>`
		214	`</td>`
		215	`</tr>`
		216
		217	`<tr>`
		218	`<td class="attributes"><private>  </td>`
		219	`<td class="nameDescription">`
		220	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnFillerDragStart">_fnFillerDragStart</a></b>(e)`
		221	`</div>`
		222	`<div class="description">Mouse down event handler for starting a drag</div>`
		223	`</td>`
		224	`</tr>`
		225
		226	`<tr>`
		227	`<td class="attributes"><private>  </td>`
		228	`<td class="nameDescription">`
		229	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnFillerFinish">_fnFillerFinish</a></b>(e)`
		230	`</div>`
		231	`<div class="description">Mouse release handler - end the drag and take action to update the cells with the needed values</div>`
		232	`</td>`
		233	`</tr>`
		234
		235	`<tr>`
		236	`<td class="attributes"><private>  </td>`
		237	`<td class="nameDescription">`
		238	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnFillerPosition">_fnFillerPosition</a></b>(nTd)`
		239	`</div>`
		240	`<div class="description">Position the filler icon over a cell</div>`
		241	`</td>`
		242	`</tr>`
		243
		244	`<tr>`
		245	`<td class="attributes"><private>  </td>`
		246	`<td class="nameDescription">`
		247	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnInit">_fnInit</a></b>(oDT, oConfig)`
		248	`</div>`
		249	`<div class="description">Initialisation</div>`
		250	`</td>`
		251	`</tr>`
		252
		253	`<tr>`
		254	`<td class="attributes"><private>  </td>`
		255	`<td class="nameDescription">`
		256	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnPrep">_fnPrep</a></b>(sStr)`
		257	`</div>`
		258	`<div class="description">Chunk a string such that it can be filled in by the stepper function</div>`
		259	`</td>`
		260	`</tr>`
		261
		262	`<tr>`
		263	`<td class="attributes"><private>  </td>`
		264	`<td class="nameDescription">`
		265	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnReadCell">_fnReadCell</a></b>(nTd)`
		266	`</div>`
		267	`<div class="description">Read informaiton from a cell, possibly using live DOM elements if suitable</div>`
		268	`</td>`
		269	`</tr>`
		270
		271	`<tr>`
		272	`<td class="attributes"><private>  </td>`
		273	`<td class="nameDescription">`
		274	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnStep">_fnStep</a></b>(nTd, oPrepped, iDiff, bIncrement, sToken)`
		275	`</div>`
		276	`<div class="description">Render a string for it's position in the table after the drag (incrememt numbers)</div>`
		277	`</td>`
		278	`</tr>`
		279
		280	`<tr>`
		281	`<td class="attributes"><private>  </td>`
		282	`<td class="nameDescription">`
		283	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnTargetCoords">_fnTargetCoords</a></b>(nTd)`
		284	`</div>`
		285	`<div class="description">Find out the coordinates of a given TD cell in a table</div>`
		286	`</td>`
		287	`</tr>`
		288
		289	`<tr>`
		290	`<td class="attributes"><private>  </td>`
		291	`<td class="nameDescription">`
		292	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnUpdateBorder">_fnUpdateBorder</a></b>(nStart, nEnd)`
		293	`</div>`
		294	`<div class="description">Display the border around one or more cells (from start to end)</div>`
		295	`</td>`
		296	`</tr>`
		297
		298	`<tr>`
		299	`<td class="attributes"><private>  </td>`
		300	`<td class="nameDescription">`
		301	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#_fnWriteCell">_fnWriteCell</a></b>(nTd, sVal, bLast)`
		302	`</div>`
		303	`<div class="description">Write informaiton to a cell, possibly using live DOM elements if suitable</div>`
		304	`</td>`
		305	`</tr>`
		306
		307	`<tr>`
		308	`<td class="attributes"> </td>`
		309	`<td class="nameDescription">`
		310	`<div class="fixedFont"><b><a href="../symbols/AutoFill.html#fnSettings">fnSettings</a></b>()`
		311	`</div>`
		312	`<div class="description">Retreieve the settings object from an instance</div>`
		313	`</td>`
		314	`</tr>`
		315
		316	`</tbody>`
		317	`</table>`
		318	`</div>`
		319
		320
		321
		322
		323
		324	`<!--`
		325	`#### EVENTS SUMMARY`
		326	`-->`
		327
		328
		329	`<!--`
		330	`#### CONSTRUCTOR DETAILS`
		331	`-->`
		332
		333	`<div class="details props">`
		334	`<div class="innerProps">`
		335	`<a name="constructor"></a>`
		336
		337	`<div class="sectionTitle">`
		338	`Class Detail`
		339	`</div>`
		340
		341	`<div class="fixedFont">`
		342	`<b>AutoFill</b>(DataTables, Configuration)`
		343	`</div>`
		344
		345	`<div class="description">`
		346	`AutoFill provides Excel like auto fill features for a DataTable`
		347
		348	`</div>`
		349
		350
		351
		352
		353	`<dl class="detailList params">`
		354	`<dt class="heading">Parameters:</dt>`
		355
		356	`<dt>`
		357	`<span class="light fixedFont">{object}</span> <b>DataTables</b>`
		358
		359	`</dt>`
		360	`<dd>settings object</dd>`
		361
		362	`<dt>`
		363	`<span class="light fixedFont">{object}</span> <b>Configuration</b>`
		364
		365	`</dt>`
		366	`<dd>object for AutoFill</dd>`
		367
		368	`</dl>`
		369
		370
		371
		372	`</div>`
		373	`</div>`
		374
		375
		376	`<!--`
		377	`#### FIELD DETAILS`
		378	`-->`
		379
		380	`<div class="details props">`
		381	`<div class="innerProps">`
		382
		383	`<div class="sectionTitle">`
		384	`Field Detail`
		385	`</div>`
		386
		387
		388	`<a name="CLASS"></a>`
		389
		390	`<div class="fixedFont heading">`
		391	`<span class='lighter'>`
		392	`<constant>`
		393	`</span>`
		394
		395	`<span class="light">{String}</span>`
		396
		397	`<b>CLASS</b>`
		398	`</div>`
		399
		400	`<div class="description">`
		401	`Name of this class`
		402
		403
		404
		405	`</div>`
		406
		407
		408
		409
		410	`<dl class="detailList nomargin">`
		411
		412
		413
		414
		415
		416	`<dt class="heading">Default Value:</dt>`
		417	`<dd>`
		418	`AutoFill`
		419	`</dd>`
		420
		421	`</dl>`
		422
		423
		424	`<div class="hr"></div>`
		425
		426	`<a name=".VERSION"></a>`
		427
		428	`<div class="fixedFont heading">`
		429	`<span class='lighter'>`
		430	`<static> <constant>`
		431	`</span>`
		432
		433	`<span class="light">{String}</span>`
		434
		435	`<span class="light">AutoFill.</span><b>VERSION</b>`
		436	`</div>`
		437
		438	`<div class="description">`
		439	`AutoFill version`
		440
		441
		442
		443	`</div>`
		444
		445
		446
		447
		448	`<dl class="detailList nomargin">`
		449
		450
		451
		452
		453
		454	`<dt class="heading">Default Value:</dt>`
		455	`<dd>`
		456	`1.1.1`
		457	`</dd>`
		458
		459	`</dl>`
		460
		461
		462
		463
		464	`</div>`
		465	`</div>`
		466
		467
		468	`<!--`
		469	`#### METHOD DETAILS`
		470	`-->`
		471
		472	`<div class="details props">`
		473	`<div class="innerProps">`
		474	`<div class="sectionTitle">`
		475	`Method Detail`
		476	`</div>`
		477
		478
		479	`<a name="_fnAddColumn"></a>`
		480
		481	`<div class="fixedFont heading">`
		482	`<span class='lighter'>`
		483	`<private>`
		484	`</span>`
		485
		486
		487
		488	`<b>_fnAddColumn</b>(i)`
		489	`</div>`
		490
		491	`<div class="description">`
		492
		493
		494
		495
		496
		497	`</div>`
		498
		499
		500
		501
		502	`<dl class="detailList params">`
		503	`<dt class="heading">Parameters:</dt>`
		504
		505	`<dt>`
		506	`<b>i</b>`
		507
		508	`</dt>`
		509	`<dd></dd>`
		510
		511	`</dl>`
		512
		513
		514
		515
		516	`<div class="hr"></div>`
		517
		518	`<a name="_fnColumnDefs"></a>`
		519
		520	`<div class="fixedFont heading">`
		521	`<span class='lighter'>`
		522	`<private>`
		523	`</span>`
		524
		525
		526
		527	`<b>_fnColumnDefs</b>(aoColumnDefs)`
		528	`</div>`
		529
		530	`<div class="description">`
		531
		532
		533
		534
		535
		536	`</div>`
		537
		538
		539
		540
		541	`<dl class="detailList params">`
		542	`<dt class="heading">Parameters:</dt>`
		543
		544	`<dt>`
		545	`<b>aoColumnDefs</b>`
		546
		547	`</dt>`
		548	`<dd></dd>`
		549
		550	`</dl>`
		551
		552
		553
		554
		555	`<div class="hr"></div>`
		556
		557	`<a name="_fnColumnOptions"></a>`
		558
		559	`<div class="fixedFont heading">`
		560	`<span class='lighter'>`
		561	`<private>`
		562	`</span>`
		563
		564
		565
		566	`<b>_fnColumnOptions</b>(i, opts)`
		567	`</div>`
		568
		569	`<div class="description">`
		570
		571
		572
		573
		574
		575	`</div>`
		576
		577
		578
		579
		580	`<dl class="detailList params">`
		581	`<dt class="heading">Parameters:</dt>`
		582
		583	`<dt>`
		584	`<b>i</b>`
		585
		586	`</dt>`
		587	`<dd></dd>`
		588
		589	`<dt>`
		590	`<b>opts</b>`
		591
		592	`</dt>`
		593	`<dd></dd>`
		594
		595	`</dl>`
		596
		597
		598
		599
		600	`<div class="hr"></div>`
		601
		602	`<a name="_fnColumnsAll"></a>`
		603
		604	`<div class="fixedFont heading">`
		605	`<span class='lighter'>`
		606	`<private>`
		607	`</span>`
		608
		609
		610
		611	`<b>_fnColumnsAll</b>(aoColumns)`
		612	`</div>`
		613
		614	`<div class="description">`
		615
		616
		617
		618
		619
		620	`</div>`
		621
		622
		623
		624
		625	`<dl class="detailList params">`
		626	`<dt class="heading">Parameters:</dt>`
		627
		628	`<dt>`
		629	`<b>aoColumns</b>`
		630
		631	`</dt>`
		632	`<dd></dd>`
		633
		634	`</dl>`
		635
		636
		637
		638
		639	`<div class="hr"></div>`
		640
		641	`<a name="_fnFillerDisplay"></a>`
		642
		643	`<div class="fixedFont heading">`
		644	`<span class='lighter'>`
		645	`<private>`
		646	`</span>`
		647
		648
		649
		650	`<b>_fnFillerDisplay</b>(e)`
		651	`</div>`
		652
		653	`<div class="description">`
		654	`Display the drag handle on mouse over cell`
		655
		656
		657
		658
		659	`</div>`
		660
		661
		662
		663
		664	`<dl class="detailList params">`
		665	`<dt class="heading">Parameters:</dt>`
		666
		667	`<dt>`
		668	`<span class="light fixedFont">{Object}</span> <b>e</b>`
		669
		670	`</dt>`
		671	`<dd>Event object</dd>`
		672
		673	`</dl>`
		674
		675
		676
		677	`<dl class="detailList nomargin">`
		678
		679
		680
		681
		682
		683
		684
		685
		686	`<dt class="heading">Returns:</dt>`
		687
		688	`<dd>void</dd>`
		689
		690
		691
		692
		693
		694
		695
		696	`</dl>`
		697
		698
		699	`<div class="hr"></div>`
		700
		701	`<a name="_fnFillerDragMove"></a>`
		702
		703	`<div class="fixedFont heading">`
		704	`<span class='lighter'>`
		705	`<private>`
		706	`</span>`
		707
		708
		709
		710	`<b>_fnFillerDragMove</b>(e)`
		711	`</div>`
		712
		713	`<div class="description">`
		714	`Mouse move event handler for during a move. See if we want to update the display based on the`
		715	`new cursor position`
		716
		717
		718
		719
		720	`</div>`
		721
		722
		723
		724
		725	`<dl class="detailList params">`
		726	`<dt class="heading">Parameters:</dt>`
		727
		728	`<dt>`
		729	`<span class="light fixedFont">{Object}</span> <b>e</b>`
		730
		731	`</dt>`
		732	`<dd>Event object</dd>`
		733
		734	`</dl>`
		735
		736
		737
		738	`<dl class="detailList nomargin">`
		739
		740
		741
		742
		743
		744
		745
		746
		747	`<dt class="heading">Returns:</dt>`
		748
		749	`<dd>void</dd>`
		750
		751
		752
		753
		754
		755
		756
		757	`</dl>`
		758
		759
		760	`<div class="hr"></div>`
		761
		762	`<a name="_fnFillerDragStart"></a>`
		763
		764	`<div class="fixedFont heading">`
		765	`<span class='lighter'>`
		766	`<private>`
		767	`</span>`
		768
		769
		770
		771	`<b>_fnFillerDragStart</b>(e)`
		772	`</div>`
		773
		774	`<div class="description">`
		775	`Mouse down event handler for starting a drag`
		776
		777
		778
		779
		780	`</div>`
		781
		782
		783
		784
		785	`<dl class="detailList params">`
		786	`<dt class="heading">Parameters:</dt>`
		787
		788	`<dt>`
		789	`<span class="light fixedFont">{Object}</span> <b>e</b>`
		790
		791	`</dt>`
		792	`<dd>Event object</dd>`
		793
		794	`</dl>`
		795
		796
		797
		798	`<dl class="detailList nomargin">`
		799
		800
		801
		802
		803
		804
		805
		806
		807	`<dt class="heading">Returns:</dt>`
		808
		809	`<dd>void</dd>`
		810
		811
		812
		813
		814
		815
		816
		817	`</dl>`
		818
		819
		820	`<div class="hr"></div>`
		821
		822	`<a name="_fnFillerFinish"></a>`
		823
		824	`<div class="fixedFont heading">`
		825	`<span class='lighter'>`
		826	`<private>`
		827	`</span>`
		828
		829
		830
		831	`<b>_fnFillerFinish</b>(e)`
		832	`</div>`
		833
		834	`<div class="description">`
		835	`Mouse release handler - end the drag and take action to update the cells with the needed values`
		836
		837
		838
		839
		840	`</div>`
		841
		842
		843
		844
		845	`<dl class="detailList params">`
		846	`<dt class="heading">Parameters:</dt>`
		847
		848	`<dt>`
		849	`<span class="light fixedFont">{Object}</span> <b>e</b>`
		850
		851	`</dt>`
		852	`<dd>Event object</dd>`
		853
		854	`</dl>`
		855
		856
		857
		858	`<dl class="detailList nomargin">`
		859
		860
		861
		862
		863
		864
		865
		866
		867	`<dt class="heading">Returns:</dt>`
		868
		869	`<dd>void</dd>`
		870
		871
		872
		873
		874
		875
		876
		877	`</dl>`
		878
		879
		880	`<div class="hr"></div>`
		881
		882	`<a name="_fnFillerPosition"></a>`
		883
		884	`<div class="fixedFont heading">`
		885	`<span class='lighter'>`
		886	`<private>`
		887	`</span>`
		888
		889
		890
		891	`<b>_fnFillerPosition</b>(nTd)`
		892	`</div>`
		893
		894	`<div class="description">`
		895	`Position the filler icon over a cell`
		896
		897
		898
		899
		900	`</div>`
		901
		902
		903
		904
		905	`<dl class="detailList params">`
		906	`<dt class="heading">Parameters:</dt>`
		907
		908	`<dt>`
		909	`<span class="light fixedFont">{Node}</span> <b>nTd</b>`
		910
		911	`</dt>`
		912	`<dd>Cell to position filler icon over</dd>`
		913
		914	`</dl>`
		915
		916
		917
		918	`<dl class="detailList nomargin">`
		919
		920
		921
		922
		923
		924
		925
		926
		927	`<dt class="heading">Returns:</dt>`
		928
		929	`<dd>void</dd>`
		930
		931
		932
		933
		934
		935
		936
		937	`</dl>`
		938
		939
		940	`<div class="hr"></div>`
		941
		942	`<a name="_fnInit"></a>`
		943
		944	`<div class="fixedFont heading">`
		945	`<span class='lighter'>`
		946	`<private>`
		947	`</span>`
		948
		949
		950
		951	`<b>_fnInit</b>(oDT, oConfig)`
		952	`</div>`
		953
		954	`<div class="description">`
		955	`Initialisation`
		956
		957
		958
		959
		960	`</div>`
		961
		962
		963
		964
		965	`<dl class="detailList params">`
		966	`<dt class="heading">Parameters:</dt>`
		967
		968	`<dt>`
		969	`<span class="light fixedFont">{object}</span> <b>oDT</b>`
		970
		971	`</dt>`
		972	`<dd>DataTables settings object</dd>`
		973
		974	`<dt>`
		975	`<span class="light fixedFont">{object}</span> <b>oConfig</b>`
		976
		977	`</dt>`
		978	`<dd>Configuration object for AutoFill</dd>`
		979
		980	`</dl>`
		981
		982
		983
		984	`<dl class="detailList nomargin">`
		985
		986
		987
		988
		989
		990
		991
		992
		993	`<dt class="heading">Returns:</dt>`
		994
		995	`<dd>void</dd>`
		996
		997
		998
		999
		1000
		1001
		1002
		1003	`</dl>`
		1004
		1005
		1006	`<div class="hr"></div>`
		1007
		1008	`<a name="_fnPrep"></a>`
		1009
		1010	`<div class="fixedFont heading">`
		1011	`<span class='lighter'>`
		1012	`<private>`
		1013	`</span>`
		1014
		1015	`<span class="light">{Object}</span>`
		1016
		1017	`<b>_fnPrep</b>(sStr)`
		1018	`</div>`
		1019
		1020	`<div class="description">`
		1021	`Chunk a string such that it can be filled in by the stepper function`
		1022
		1023
		1024
		1025
		1026	`</div>`
		1027
		1028
		1029
		1030
		1031	`<dl class="detailList params">`
		1032	`<dt class="heading">Parameters:</dt>`
		1033
		1034	`<dt>`
		1035	`<span class="light fixedFont">{String}</span> <b>sStr</b>`
		1036
		1037	`</dt>`
		1038	`<dd>String to prep</dd>`
		1039
		1040	`</dl>`
		1041
		1042
		1043
		1044	`<dl class="detailList nomargin">`
		1045
		1046
		1047
		1048
		1049
		1050
		1051
		1052
		1053	`<dt class="heading">Returns:</dt>`
		1054
		1055	`<dd><span class="light fixedFont">{Object}</span> with parameters, iStart, sStr and sPostFix</dd>`
		1056
		1057
		1058
		1059
		1060
		1061
		1062
		1063	`</dl>`
		1064
		1065
		1066	`<div class="hr"></div>`
		1067
		1068	`<a name="_fnReadCell"></a>`
		1069
		1070	`<div class="fixedFont heading">`
		1071	`<span class='lighter'>`
		1072	`<private>`
		1073	`</span>`
		1074
		1075	`<span class="light">{String}</span>`
		1076
		1077	`<b>_fnReadCell</b>(nTd)`
		1078	`</div>`
		1079
		1080	`<div class="description">`
		1081	`Read informaiton from a cell, possibly using live DOM elements if suitable`
		1082
		1083
		1084
		1085
		1086	`</div>`
		1087
		1088
		1089
		1090
		1091	`<dl class="detailList params">`
		1092	`<dt class="heading">Parameters:</dt>`
		1093
		1094	`<dt>`
		1095	`<span class="light fixedFont">{Node}</span> <b>nTd</b>`
		1096
		1097	`</dt>`
		1098	`<dd>Cell to read</dd>`
		1099
		1100	`</dl>`
		1101
		1102
		1103
		1104	`<dl class="detailList nomargin">`
		1105
		1106
		1107
		1108
		1109
		1110
		1111
		1112
		1113	`<dt class="heading">Returns:</dt>`
		1114
		1115	`<dd><span class="light fixedFont">{String}</span> Read value</dd>`
		1116
		1117
		1118
		1119
		1120
		1121
		1122
		1123	`</dl>`
		1124
		1125
		1126	`<div class="hr"></div>`
		1127
		1128	`<a name="_fnStep"></a>`
		1129
		1130	`<div class="fixedFont heading">`
		1131	`<span class='lighter'>`
		1132	`<private>`
		1133	`</span>`
		1134
		1135	`<span class="light">{String}</span>`
		1136
		1137	`<b>_fnStep</b>(nTd, oPrepped, iDiff, bIncrement, sToken)`
		1138	`</div>`
		1139
		1140	`<div class="description">`
		1141	`Render a string for it's position in the table after the drag (incrememt numbers)`
		1142
		1143
		1144
		1145
		1146	`</div>`
		1147
		1148
		1149
		1150
		1151	`<dl class="detailList params">`
		1152	`<dt class="heading">Parameters:</dt>`
		1153
		1154	`<dt>`
		1155	`<span class="light fixedFont">{Node}</span> <b>nTd</b>`
		1156
		1157	`</dt>`
		1158	`<dd>Cell being written to</dd>`
		1159
		1160	`<dt>`
		1161	`<span class="light fixedFont">{Object}</span> <b>oPrepped</b>`
		1162
		1163	`</dt>`
		1164	`<dd>Prepared object for the stepper (from _fnPrep)</dd>`
		1165
		1166	`<dt>`
		1167	`<span class="light fixedFont">{Int}</span> <b>iDiff</b>`
		1168
		1169	`</dt>`
		1170	`<dd>Step difference</dd>`
		1171
		1172	`<dt>`
		1173	`<span class="light fixedFont">{Boolean}</span> <b>bIncrement</b>`
		1174
		1175	`</dt>`
		1176	`<dd>Increment (true) or decriment (false)</dd>`
		1177
		1178	`<dt>`
		1179	`<span class="light fixedFont">{String}</span> <b>sToken</b>`
		1180
		1181	`</dt>`
		1182	`<dd>Token to replace</dd>`
		1183
		1184	`</dl>`
		1185
		1186
		1187
		1188	`<dl class="detailList nomargin">`
		1189
		1190
		1191
		1192
		1193
		1194
		1195
		1196
		1197	`<dt class="heading">Returns:</dt>`
		1198
		1199	`<dd><span class="light fixedFont">{String}</span> Rendered information</dd>`
		1200
		1201
		1202
		1203
		1204
		1205
		1206
		1207	`</dl>`
		1208
		1209
		1210	`<div class="hr"></div>`
		1211
		1212	`<a name="_fnTargetCoords"></a>`
		1213
		1214	`<div class="fixedFont heading">`
		1215	`<span class='lighter'>`
		1216	`<private>`
		1217	`</span>`
		1218
		1219	`<span class="light">{Object}</span>`
		1220
		1221	`<b>_fnTargetCoords</b>(nTd)`
		1222	`</div>`
		1223
		1224	`<div class="description">`
		1225	`Find out the coordinates of a given TD cell in a table`
		1226
		1227
		1228
		1229
		1230	`</div>`
		1231
		1232
		1233
		1234
		1235	`<dl class="detailList params">`
		1236	`<dt class="heading">Parameters:</dt>`
		1237
		1238	`<dt>`
		1239	`<span class="light fixedFont">{Node}</span> <b>nTd</b>`
		1240
		1241	`</dt>`
		1242	`<dd></dd>`
		1243
		1244	`</dl>`
		1245
		1246
		1247
		1248	`<dl class="detailList nomargin">`
		1249
		1250
		1251
		1252
		1253
		1254
		1255
		1256
		1257	`<dt class="heading">Returns:</dt>`
		1258
		1259	`<dd><span class="light fixedFont">{Object}</span> x and y properties, for the position of the cell in the tables DOM</dd>`
		1260
		1261
		1262
		1263
		1264
		1265
		1266
		1267	`</dl>`
		1268
		1269
		1270	`<div class="hr"></div>`
		1271
		1272	`<a name="_fnUpdateBorder"></a>`
		1273
		1274	`<div class="fixedFont heading">`
		1275	`<span class='lighter'>`
		1276	`<private>`
		1277	`</span>`
		1278
		1279
		1280
		1281	`<b>_fnUpdateBorder</b>(nStart, nEnd)`
		1282	`</div>`
		1283
		1284	`<div class="description">`
		1285	`Display the border around one or more cells (from start to end)`
		1286
		1287
		1288
		1289
		1290	`</div>`
		1291
		1292
		1293
		1294
		1295	`<dl class="detailList params">`
		1296	`<dt class="heading">Parameters:</dt>`
		1297
		1298	`<dt>`
		1299	`<span class="light fixedFont">{Node}</span> <b>nStart</b>`
		1300
		1301	`</dt>`
		1302	`<dd>Starting cell</dd>`
		1303
		1304	`<dt>`
		1305	`<span class="light fixedFont">{Node}</span> <b>nEnd</b>`
		1306
		1307	`</dt>`
		1308	`<dd>Ending cell</dd>`
		1309
		1310	`</dl>`
		1311
		1312
		1313
		1314	`<dl class="detailList nomargin">`
		1315
		1316
		1317
		1318
		1319
		1320
		1321
		1322
		1323	`<dt class="heading">Returns:</dt>`
		1324
		1325	`<dd>void</dd>`
		1326
		1327
		1328
		1329
		1330
		1331
		1332
		1333	`</dl>`
		1334
		1335
		1336	`<div class="hr"></div>`
		1337
		1338	`<a name="_fnWriteCell"></a>`
		1339
		1340	`<div class="fixedFont heading">`
		1341	`<span class='lighter'>`
		1342	`<private>`
		1343	`</span>`
		1344
		1345
		1346
		1347	`<b>_fnWriteCell</b>(nTd, sVal, bLast)`
		1348	`</div>`
		1349
		1350	`<div class="description">`
		1351	`Write informaiton to a cell, possibly using live DOM elements if suitable`
		1352
		1353
		1354
		1355
		1356	`</div>`
		1357
		1358
		1359
		1360
		1361	`<dl class="detailList params">`
		1362	`<dt class="heading">Parameters:</dt>`
		1363
		1364	`<dt>`
		1365	`<span class="light fixedFont">{Node}</span> <b>nTd</b>`
		1366
		1367	`</dt>`
		1368	`<dd>Cell to write</dd>`
		1369
		1370	`<dt>`
		1371	`<span class="light fixedFont">{String}</span> <b>sVal</b>`
		1372
		1373	`</dt>`
		1374	`<dd>Value to write</dd>`
		1375
		1376	`<dt>`
		1377	`<span class="light fixedFont">{Boolean}</span> <b>bLast</b>`
		1378
		1379	`</dt>`
		1380	`<dd>Flag to show if this is that last update</dd>`
		1381
		1382	`</dl>`
		1383
		1384
		1385
		1386	`<dl class="detailList nomargin">`
		1387
		1388
		1389
		1390
		1391
		1392
		1393
		1394
		1395	`<dt class="heading">Returns:</dt>`
		1396
		1397	`<dd>void</dd>`
		1398
		1399
		1400
		1401
		1402
		1403
		1404
		1405	`</dl>`
		1406
		1407
		1408	`<div class="hr"></div>`
		1409
		1410	`<a name="fnSettings"></a>`
		1411
		1412	`<div class="fixedFont heading">`
		1413	`<span class='lighter'>`
		1414
		1415	`</span>`
		1416
		1417	`<span class="light">{object}</span>`
		1418
		1419	`<b>fnSettings</b>()`
		1420	`</div>`
		1421
		1422	`<div class="description">`
		1423	`Retreieve the settings object from an instance`
		1424
		1425
		1426
		1427
		1428	`</div>`
		1429
		1430
		1431
		1432
		1433
		1434
		1435	`<dl class="detailList nomargin">`
		1436
		1437
		1438
		1439
		1440
		1441
		1442
		1443
		1444	`<dt class="heading">Returns:</dt>`
		1445
		1446	`<dd><span class="light fixedFont">{object}</span> AutoFill settings object</dd>`
		1447
		1448
		1449
		1450
		1451
		1452
		1453
		1454	`</dl>`
		1455
		1456
		1457
		1458
		1459	`</div>`
		1460	`</div>`
		1461
		1462
		1463	`<!--`
		1464	`#### EVENT DETAILS`
		1465	`-->`
		1466
		1467	`</div>`
		1468	`</div>`
		1469	`</body>`
		1470	`</html>`

Subversion Repositories SmartDukaan

(root)/trunk/GoogleAppDatalog/src/main/webapp/DataTables/extras/AutoFill/media/docs/symbols/AutoFill.html – Rev 2629