Взаимодействие с мышью

Аналогично jQuery.Widget, взаимодействие с мышью не предназначено для прямого использования. Это чисто базовый уровень для наследования другими виджетами. На этой странице документируется то, что добавлено к jQuery.Widget, но она включает внутренние методы, которые не предназначены для перезаписи. Предполагаемый публичный API — _mouseStart(), _mouseDrag(), _mouseStop() и _mouseCapture().

Зависимости

Фабрика виджетов

Параметры

cancel

Тип: Селектор

Значение по умолчанию: "input,textarea,button,select,option"

Препятствует началу взаимодействия на указанных элементах.

Примеры кода:

Инициализируйте мышь с заданным параметром cancel.

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

Получите или установите параметр cancel, после инициализации:

// Getter
var cancel = $( ".selector" ).mouse( "option", "cancel" );
 
// Setter
$( ".selector" ).mouse( "option", "cancel", ".title" );

delay

Тип: Число

Значение по умолчанию: 0

Время в миллисекундах после нажатия левой кнопки мыши, до начала взаимодействия. Этот параметр может использоваться для предотвращения нежелательных взаимодействий при нажатии на элемент. (версия устаревшая: 1.12)

Примеры кода:

Инициализируйте мышь с заданным параметром delay.

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

Получите или установите параметр delay, после инициализации:

// Getter
var delay = $( ".selector" ).mouse( "option", "delay" );
 
// Setter
$( ".selector" ).mouse( "option", "delay", 300 );

расстояние

Тип: Число

Значение по умолчанию: 1

Расстояние в пикселях после нажатия левой кнопки мыши, которое мышь должна преодолеть, прежде чем начнется взаимодействие. Этот параметр может использоваться для предотвращения нежелательных взаимодействий при нажатии на элемент. (версия устаревшая: 1.12)

Примеры кода:

Инициализируйте мышь с заданным параметром distance.

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

Получите или установите параметр distance, после инициализации:

// Getter
var distance = $( ".selector" ).mouse( "option", "distance" );
 
// Setter
$( ".selector" ).mouse( "option", "distance", 10 );

Методы

_mouseCapture()Возвращает: Boolean

Определяет, следует ли начинать взаимодействие на основе целевого элемента события взаимодействия. По умолчанию всегда возвращает true.

Этот метод не принимает аргументов.

Примеры кода:

Вызов метода _mouseCapture:

$( ".selector" ).mouse( "_mouseCapture" );

_mouseDelayMet()Возвращает: Boolean

Определяет, достигнуто ли значение опции delay для текущего взаимодействия.

Этот метод не принимает аргументов.

Примеры кода:

Вызов метода _mouseDelayMet:

$( ".selector" ).mouse( "_mouseDelayMet" );

_mouseDestroy()Возвращает: jQuery (только для плагинов)

Удаляет обработчики событий взаимодействия. Должен вызываться из метода _destroy() расширяемого виджета.

Этот метод не принимает аргументов.

Примеры кода:

Вызов метода _mouseDestroy:

$( ".selector" ).mouse( "_mouseDestroy" );

_mouseDistanceMet()Возвращает: Boolean

Определяет, достигнуто ли значение опции distance для текущего взаимодействия.

Этот метод не принимает аргументов.

Примеры кода:

Вызов метода _mouseDistanceMet:

$( ".selector" ).mouse( "_mouseDistanceMet" );

_mouseDown()Возвращает: jQuery (только для плагинов)

Обрабатывает начало взаимодействия. Проверяет, что событие связано с основной кнопкой мыши, и гарантирует, что опции delay и distance выполнены перед началом взаимодействия. Когда взаимодействие готово к запуску, вызывает метод _mouseStart() расширяемого виджета для обработки.

Этот метод не принимает аргументов.

Примеры кода:

Вызов метода _mouseDown:

$( ".selector" ).mouse( "_mouseDown" );

_mouseDrag()Возвращает: jQuery (только для плагинов)

Расширяемый виджет должен реализовать метод _mouseDrag() для обработки каждого движения взаимодействия. Этот метод получит событие мыши, связанное с движением.

Этот метод не принимает аргументов.

Примеры кода:

Вызов метода _mouseDrag:

$( ".selector" ).mouse( "_mouseDrag" );

_mouseInit()Возвращает: jQuery (только для плагинов)

Инициализирует обработчики событий взаимодействия. Должен вызываться из метода _create() расширяемого виджета.

Этот метод не принимает аргументов.

Примеры кода:

Вызов метода _mouseInit:

$( ".selector" ).mouse( "_mouseInit" );

_mouseMove()Возвращает: jQuery (только для плагинов)

Обрабатывает каждое движение взаимодействия. Вызывает метод mouseDrag() для обработки расширяемым виджетом.

Этот метод не принимает аргументов.

Примеры кода:

Вызов метода _mouseMove:

$( ".selector" ).mouse( "_mouseMove" );

_mouseStart()Возвращает: jQuery (только для плагина)

Расширяемый виджет должен реализовать метод _mouseStart() для обработки начала взаимодействия. Этот метод получит событие мыши, связанное с началом взаимодействия.

Этот метод не принимает никаких аргументов.

Примеры кода:

Вызов метода _mouseStart:

$( ".selector" ).mouse( "_mouseStart" );

_mouseStop()Возвращает: jQuery (только для плагина)

Расширяемый виджет должен реализовать метод _mouseStop() для обработки завершения взаимодействия. Этот метод получит событие мыши, связанное с завершением взаимодействия.

Этот метод не принимает никаких аргументов.

Примеры кода:

Вызов метода _mouseStop:

$( ".selector" ).mouse( "_mouseStop" );

_mouseUp()Возвращает: jQuery (только для плагина)

Обрабатывает завершение взаимодействия. Вызывает метод mouseStop() для обработки расширяемого виджета.

Этот метод не принимает никаких аргументов.

Примеры кода:

Вызов метода _mouseUp:

$( ".selector" ).mouse( "_mouseUp" );