jQuery UI API - マウスインタラクション(Mouse Interaction)

所属カテゴリ

インタラクション(Interactions) | ユーティリティ(Utilities)

使用法

説明:基本インタラクションレイヤー。

依存:

注記:とjQuery.Widget同様に、マウスインタラクションは直接使用することを目的としていません。これは、他のウィジェットが継承するための純粋な基本レイヤーです。このページには、jQuery.Widget追加されたドキュメントがありますが、それにはオーバーライドできない内部メソッドが含まれています。パブリック API は_mouseStart()、_mouseDrag()、_mouseStop()と_mouseCapture()。

クイックナビゲーション

オプション メソッド イベント

オプション 型 説明 デフォルト値
cancel Selector 指定された要素上でのインタラクションの開始を防止します。

コード例:

指定されたcancelオプションを持つ mouse を初期化します:

$( ".selector" ).mouse({ cancel: ".title" });
    

初期化後、取得または設定します:cancelオプション:

// getter
var cancel = $( ".selector" ).mouse( "option", "cancel" );
 
// setter
$( ".selector" ).mouse( "option", "cancel", ".title" );
    
"input, textarea, button, select, option"
delay Number マウスを押してからインタラクションが開始されるまでの時間(ミリ秒単位)。このオプションは、要素をクリックしたときの不要なインタラクションを防ぐために使用できます。

コード例:

指定されたdelayオプションを持つ mouse を初期化します:

$( ".selector" ).mouse({ delay: 300 });
    

初期化後、取得または設定します:delayオプション:

// getter
var delay = $( ".selector" ).mouse( "option", "delay" );
 
// setter
$( ".selector" ).mouse( "option", "delay", 300 );
    
0
distance Number マウスを押した後、インタラクションが開始されるまでにマウスが移動しなければならない距離(ピクセル単位)。このオプションは、要素をクリックしたときの不要なインタラクションを防ぐために使用できます。

コード例:

指定されたdistanceオプションを持つ mouse を初期化します:

$( ".selector" ).mouse({ distance: 10 });
    

初期化後、取得または設定します:distanceオプション:

// getter
var distance = $( ".selector" ).mouse( "option", "distance" );
 
// setter
$( ".selector" ).mouse( "option", "distance", 10 );
    
1

メソッド 戻り値 説明
_mouseCapture() Boolean インタラクションのイベントターゲットに基づいて、インタラクションを開始すべきかどうかを決定します。デフォルトの実装は常に false を返します。true。
  • このメソッドは引数を受け付けません。

コード例:

_mouseCapture メソッドを呼び出す:

$( ".selector" ).mouse( "_mouseCapture" );
    
_mouseDelayMet() Boolean 決定:delayオプションが現在のインタラクションで満たされているかどうか。
  • このメソッドは引数を受け付けません。

コード例:

_mouseDelayMet メソッドを呼び出す:

$( ".selector" ).mouse( "_mouseDelayMet" );
    
_mouseDestroy() jQuery (plugin only) インタラクションイベントハンドラーを破棄します。これは、拡張するウィジェットの_destroy()メソッドを呼び出す必要があります。
  • このメソッドは引数を受け付けません。

コード例:

_mouseDestroy メソッドを呼び出す:

$( ".selector" ).mouse( "_mouseDestroy" );
    
_mouseDistanceMet() Boolean 決定:distanceオプションが現在のインタラクションで満たされているかどうか。
  • このメソッドは引数を受け付けません。

コード例:

_mouseDistanceMet メソッドを呼び出す:

$( ".selector" ).mouse( "_mouseDistanceMet" );
    
_mouseDown() jQuery (plugin only) インタラクションの開始を処理します。イベントが主マウスボタンに関連付けられていることを確認し、delayとdistanceインタラクションを開始する前に条件が満たされていることを確認します。インタラクションの開始準備ができると、拡張ウィジェットが処理するための_mouseStartメソッドを呼び出します。
  • このメソッドは引数を受け付けません。

コード例:

_mouseDown メソッドを呼び出す:

$( ".selector" ).mouse( "_mouseDown" );
    
_mouseDrag() jQuery (plugin only) 拡張ウィジェットは、_mouseDrag()インタラクションの各移動を処理するメソッドを実装する必要があります。このメソッドは、移動に関連付けられたマウスイベントを受け取ります。
  • このメソッドは引数を受け付けません。

コード例:

_mouseDrag メソッドを呼び出す:

$( ".selector" ).mouse( "_mouseDrag" );
    
_mouseInit() jQuery (plugin only) インタラクションイベントハンドラーを初期化します。これは、拡張するウィジェットの_create()メソッドを呼び出す必要があります。
  • このメソッドは引数を受け付けません。

コード例:

_mouseInit メソッドを呼び出す:

$( ".selector" ).mouse( "_mouseInit" );
    
_mouseMove() jQuery (plugin only) インタラクションの各移動を処理します。拡張ウィジェットが処理するための_mouseDragメソッドを呼び出します。
  • このメソッドは引数を受け付けません。

コード例:

_mouseMove メソッドを呼び出す:

$( ".selector" ).mouse( "_mouseMove" );
    
_mouseStart() jQuery (plugin only) 拡張ウィジェットは、_mouseStart()インタラクションの開始を処理するメソッドを実装する必要があります。このメソッドは、インタラクションの開始に関連付けられたマウスイベントを受け取ります。
  • このメソッドは引数を受け付けません。

コード例:

_mouseStart メソッドを呼び出す:

$( ".selector" ).mouse( "_mouseStart" );
    
_mouseStop() jQuery (plugin only) 拡張ウィジェットは、_mouseStop()インタラクションの終了を処理するメソッドを実装する必要があります。このメソッドは、インタラクションの終了に関連付けられたマウスイベントを受け取ります。
  • このメソッドは引数を受け付けません。

コード例:

_mouseStop メソッドを呼び出す:

$( ".selector" ).mouse( "_mouseStop" );
    
_mouseUp() jQuery (plugin only) インタラクションの終了を処理します。拡張ウィジェットが処理するための_mouseStopメソッドを呼び出します。
  • このメソッドは引数を受け付けません。

コード例:

_mouseUp メソッドを呼び出す:

$( ".selector" ).mouse( "_mouseUp" );
その他の拡張