3回に分けてお送りしているdragdrop.jsの解説の、第2回目です。次回でこの連載も最終回となります。
Draggable
ドラッグ可能要素のクラスです。機能としては、ドラッグ操作にエフェクトをかける、ドラッグにあわせて画面をスクロールする、ドラッグ位置をスナップするなどがあります。ここでクラスに登場するプロパティの意味を解説します。
- element
- ドラッグ可能になる要素です。
- handle
- ドラッグの”把手”になる要素です。デフォルトではelementの要素と同一です。ドラッグ開始のためのmousedownイベントハンドラはこの要素を監視します。
- dragging
- 現在ドラッグ中かどうかのフラグです。
- delta
- ドラッグの出発地点です。[x,y]の配列です。
- offset
- ドラッグを開始したときの、マウスポインタの位置と要素の位置のズレの量です。
- _clone
- options.ghostingが有効のときに出発地点に表示される、要素のクローンです。
- _isScrollChild
- element要素が、options.scroll要素の子要素かどうかです。
- originalScrollLeft、originalScrollTop
- ドラッグを開始したときのoptions.scroll要素のスクロール位置です。
- options.handle
- ドラッグの”把手”になる要素を指定します。指定方法は、DOM idか、element要素の子要素が含むクラス名です。デフォルトはドラッグ可能要素と同一です。
- options.starteffect
- ドラッグを開始したときのフックです。デフォルトではEffect.Opacityで要素をフェードアウトします。
- options.change
- ドラッグ中に位置が変化するたびに呼ぶフックです。
- options.reverteffect
- ドラッグをキャンセルしたとき、または、ドロップが失敗したときのフックです。デフォルトではEffect.Moveで要素が元の位置に戻る様子をアニメーションで表現します。
- options.endeffect
- ドラッグを終了したときのフックです。デフォルトではEffect.Opacityで要素をフェードインします。
- options.onDropped
- ドロップした直後に呼ぶフックです。
- options.zindex
- ドラッグ中の要素のCSSのzindexプロパティの値を指定します。デフォルトは1000です。
- options.revert
- ドラッグを終了したときのフックを呼ぶかどうかです。デフォルトではfalseです。真偽値を与えるほかに、関数を与えることもできます。この関数は、ドラッグの終了時に、ドラッグした要素を引数に呼ばれるので、そこで真偽値を返すようにします。
- options.quiet
- ドラッグ中に、ドロップ先の変化の表示を一切しないオプションです。デフォルトではfalseです。
- options.scroll
- ドラッグにあわせてスクロールする要素を指定します。デフォルトはwindowで、ブラウザのスクロールが動きます。
- options.scrollSensitivity
- マウスポインタと、options.scroll要素の短形領域の枠がこの値以下に近づくと、スクロールを始めます。デフォルトは20pxです。大きければ大きいほどスクロールが始まりやすくなります。
- options.scrollSpeed
- スクロールの速度です。デフォルトは15px毎秒です。
- options.snap
- スナップするかどうか、するならばその幅を指定します。デフォルトではfalseです。3つの指定方法があります。配列[x,y]か、数値aか(配列[a,a]を与えるのと同じです)、関数(引数にx座標,y座標をとり、配列[x,y]を返すようにします)です。
- options.delay
- Draggablesのactivate関数で、処理を指定ミリ秒間遅延するためのオプションです。デフォルトは0です。
- options.ghosting
- ドラッグ中に元の場所に要素のクローンを表示するかどうかです。デフォルトはfalseです。
それではコードを見ていきましょう。
227~290行目のinitializeは、インスタンスの初期化をする関数です。種々のプロパティは上述の通りです。
256~263行目で、デフォルトのstarteffectのフェードアウトは、デフォルトのendeffectのフェードインと一対になる必要があるので、ユーザが両方ともデフォルトから変更していないことを確かめてから、starteffectを追加しています。
269行目で、まずoptions.handleに、element要素の子要素が含むクラス名を与えた場合を扱います。
その場合、270行目で、Element.downメソッドで該当する要素を取得します。
272行目で、次に、options.handleにDOM idを与えた場合を扱います。
273行目で、何も与えていない場合は、element要素になります。
275~278行目で、options.scrollに、DOM idが与えられた場合は、$関数を適用し、さらに、それがelementの親要素かどうかを_isScrollChildに保存します。
280行目で、Element.makePositionedで、要素の移動に備えます。
286行目で、ハンドル(把手)の要素にmousedownイベントハンドラを設定します。
288行目で、Draggablesクラスに登録します。
291~295行目のdestroyは、ドラッグ機能を解除する関数です。
292行目で、イベントハンドラを解除します。
293行目で、Draggablesクラスから削除します。
296~301行目のcurrentDeltaは、現在のelement要素のCSSのleft、topプロパティの値を[x,y]の配列のかたちで返す関数です。
302~323行目のinitDragは、handle要素のmousedownイベントハンドラで、ドラッグの開始直前に呼ばれる関数です。
303行目で、Draggable._draggingを調べて、本当にドラッグの直前かどうかを確かめます。
Firefoxでは、フォームを構成する要素はドラッグ&ドロップに対応しません。306~313行目で、要素のタグ名を調べて、input、select、option、button、textareaの要素であれば処理を中止します。
317行目で、offsetは、ドラッグを開始したときの、マウスポインタの位置と要素の位置のズレです。
319行目で、Draggables.activateで、この要素を現在ドラッグ中とします。
324~357行目のstartDragは、ドラッグの開始時に呼ばれる関数です。はじめてupdateDragが呼ばれたときに呼ばれます。
325行目で、ドラッグ中であることを示すdraggingフラグをたてます。
326行目で、deltaは、ドラッグの出発地点を表します。この要素にとってドラッグでの移動が初めてであれば、ここで現在の位置を出発地点とします。
329~333行目で、options.zindexの設定がある場合は、originalZに要素のCSSのz-indexプロパティの元の値を保存してから、値を書きかえます。
334~341行目で、options.ghostingの設定がある場合は、element要素のクローンを作り、それを要素のDOMツリーの直前に挿入します。その際に表示が乱れないよう、Position.absolutizeで要素をフローから外します。このとき、要素のCSSのpositionプロパティの元の値を_originallyAbsoluteに保存しておきます。
342~352行目で、originalScrollTop、同Leftを設定します。options.scrollがwindowであればページのスクロールの位置を、そうでなければoptions.scrollの要素のスクロールの位置とします。
353行目で、Draggables.notifyで、'onStart'関係のフックを呼びます。
355行目で、options.starteffectフックがあれば呼びます。
358~397行目のupdateDragは、ドラッグ中にマウスポインタの位置が変化するたびに呼ばれる関数です。
359行目で、初めての呼び出しのとき、startDragを呼びます。
361~364行目で、options.quietの設定がある場合は、Droppables.showによるドロップ先の変化の表示を一切しません。
366行目で、Draggables.notifyで、'onDrag'関係のフックを呼びます。
368行目で、draw関数を呼んで、ドラッグ中の要素を描画します。
369行目で、options.changeフックがあれば呼びます。
371~388行目で、options.scrollの設定がある場合は、マウスポインタの位置の、options.scroll要素の表示領域からはみ出している分をスクロール量として求めます。
389行目で、startScrollingでスクロールを開始します。
393行目で、Safari系ブラウザには、再描画を促します。
398~444行目のfinishDragは、ドラッグの終了時の処理を行う関数です。この終了時には、ドラッグがESCキーでキャンセルされた場合も含みます。引数に、イベント情報と、キャンセルされずに成功したかの真偽値をとります。
399行目で、ドラッグ中であることを示すdraggingフラグを戻します。
401~405行目で、options.quietの設定がある場合は、Droppables.showによるドロップ先の変化の表示を一切しません。
407~413行目で、options.ghostingで要素のクローンを表示していた場合は、それを削除します。
408行目で、elementのCSSのpositionプロパティを元に戻します。
411行目で、_clone要素を削除します。
416~419行目で、ドラッグがESCキーでキャンセルされたのでない場合は、ドロップを試みます。
417行目で、Droppables.fireで、この座標、このドラッグ要素で、ドロップが成功するか調べます。
420行目で、ドロップが成功した場合、onDroppedフックがあれば呼びます。
421行目のDraggables.notifyで、'onEnd'関係のフックを呼びます。
423行目のoptions.revertは、ドラッグを終了したときのフックを呼ぶかどうかです。真偽値を与えるほかに、関数を与えることもできます。
424行目で、options.revertに関数が与えられた場合を処理します。
427~430行目で、revertが有効で、かつドロップが失敗した場合、options.reverteffectフックを呼びます。このフックには、ドラッグの出発地点からの移動量を計算して渡します。
431行目で、revertが無効なら、ドラッグの終了地点がここに定まるので、ドラッグの出発地点deltaを現在地点に更新します。
435行目で、options.zindexの設定がある場合は、要素のCSSのz-indexプロパティをoriginalZの情報で元に戻します。
438行目で、options.endeffectフックがあれば呼びます。
441行目のDraggables.deactivateで、現在ドラッグ中、としていた情報を元に戻します。
442行目のDroppables.resetで、ドロップ先の情報を元に戻します。
445~450行目のkeyPressは、ドラッグ中にESCキーを押すとドラッグをキャンセルする関数です。documentオブジェクトのkeypressイベントのハンドラから呼ばれます。
447行目で、finishDrag関数を、2番目の引数をfalseで呼びます。
451~457行目のendDragは、ドラッグの終了時に呼ばれる関数です。DraggablesのendDragイベントハンドラから呼ばれます。
453行目で、スクロールを中止します。
454行目で、finishDrag関数を、2番目の引数をtrueで呼びます。
458~498行目のdraw関数は、ドラッグ中の要素を描画する関数です。ドラッグ中の要素の適切な位置は、Position.cumulativeOffsetやrealOffsetを駆使して求めます。
459行目のPosition.cumulativeOffsetで、ドキュメント基点からのオフセットを求めます。
460~463行目では、options.ghostingで要素のクローンを作った分、座標にズレが生じているので、補正します。Position.realOffsetで、スクロール可能なオブジェクトの階層を遡って、すべてのスクロール量を積算します。さらにそこから、ページ自体のスクロール量であるdeltaX、deltaYとの差分をとって、posを補正します。
466行目で、現在の要素の位置を引きます。
468~471行目で、options.scrollが有効で、かつ、それがwindowで無い場合は、options.scroll要素のスクロール量について補正します。
473行目で、pに、ドラッグ中の要素の実際の描画位置を求めます。このとき、ドラッグ開始時のマウスポインタと要素の位置のズレであるoffsetの量も補正します。
477~488行目で、optiotns.snapの設定がある場合は、もう一手間あります。
478行目で、それが関数なら、その呼び出しの結果をpにします。
481行目で、それが配列なら、座標をsnapの値で割ってからround関数で丸めてsnapの値をかけるという操作を行います。これはグラフにすると幅snapの階段状になることから、ドラッグの座標の動きが幅snapごとに引っかかるようになります。
484行目で、それが値なら、配列と同様の処理をします。
490~494行目で、実際にelement要素のCSSのleft、topプロパティの値に代入して、描画位置を更新します。このとき、options.constraintの制限があるときは、水平方向の動きだけ、あるいは、垂直方向の動きだけを、反映します。
499~506行目のstopScrollingは、スクロールを中止する関数です。
501行目で、タイマを無効にします。その他の状態も初期化します。
507~513行目のstartScrollingは、スクロールを開始する関数です。
511行目で、10ミリ秒ごとにscroll関数を呼ぶタイマをセットします。
510行目で、lastScrolledに、現在時刻を代入します。タイマの10ミリ秒間は信用できないので、ブラウザの現在時刻の差分に頼る仕組みになっています。
514~546行目のscroll関数は、実際にスクロールを行う関数です。
516行目で、前回の時刻との差を計算します。
518~524行目で、options.scrollがwindowならば、scrollTo関数でブラウザのスクロールを動かします。
そうでなければ、525行目で、scrollLeft、同Topプロパティを更新して、要素のスクロールを動かします。
520行目で、Position.prepareを呼んで、スクロール位置の変更がうまく働くように調整します。
531行目で、このスクロールによって、ドラッグが上空にきたドロップ先があるかもしれません。それを表示します。
532行目で、Draggables.notifyで、'onDrag'関係のフックを呼びます。
533~542行目で、_isScrollChildがtrueのとき、つまり、element要素がoptions.scrollの子要素であるときは、このスクロールによってelement要素の位置関係に影響があるので、再描画する必要があります。
535~540行目で、スクロールによって生じたズレを求めて、_lastScrollPointerに加算します。
541行目で、drawメソッドで再描画します。
544行目で、options.changeフックがあれば呼びます。
547~571行目で、_getWindowScrollは、ブラウザが現在表示している領域を返す関数です。
550~556行目で、スクロールの位置を求めます。
550行目で、ブラウザの標準モードではdocumentElementを参照します。
553行目で、互換モードではbodyを参照します。そのscrollTop、scrollLeftを調べます。
557~566行目で、領域のサイズを求めます。
557行目で、innerWidthはNetscapeとSafariとMozillaベースのブラウザがサポートしています。
560行目で、そのサポートがないとき、ブラウザの標準モードではdocumentElementを参照します。そのclientWidth、clientHeightを調べます。
563行目で、互換モードではbodyを参照します。そのoffsetWidth、offsetHeightを調べます。
572行目の_draggingは、現在ドラッグ中かどうか、ドラッグ可能要素ごとに真偽値で表すためのハッシュテーブルです。キーにドラッグ可能要素、値に真偽値をとります。