Class: Mask

Додає напівпрозорий шар поверх DOM-елемента.

Реалізує

• Options, Events

Див. також

• Spinner

Mask Method: constructor

Синтаксис

new Mask(target[, options]);

Аргументи

1. target - (mixed) Рядок з id або посилання на Element або Element для накладання; за замовчуванням document.body
2. options - (object) набір пар ключ/значення опцій

Опції

• inject - (object) куди вставити шар. Якщо не вказано, маска вставляється в document body. Приклад: inject: { where: 'after', target: element }
• hideOnClick - (boolean) якщо true, маска сховається при кліку. За замовчуванням false.
• id - (string) якщо визначено, шар накладки отримає цей id. Якщо не визначено, id за замовчуванням буде 'mask-'
• destroyOnHide - (boolean) якщо true, шар маски знищується приховуванні. Клас більше не буде функціонувати після цього. За замовчуванням false.
• class - (string) CSS-клас для застосування до шару; за замовчуванням 'mask'.
• style - (object) якщо визначено, буде застосовано до маски за допомогою Element.setStyles. Ви також можете стилізувати шар, просто визначивши стиль для імені класу шару (за замовчуванням ".mask"). Стилі за замовчуванням можна знайти в директорії Styles бібліотеки MooTools More на GitHub або завантажити в More builder на MooTools.net.
• maskMargins - (boolean) якщо true, маска розширюватиметься до полів цілі. За замовчуванням false.
• useIframeShim - (boolean) якщо true, маска використовуватиме IframeShim для приховування системних елементів (select boxes, flash тощо) для IE6.
• iframeShimOptions - (object) опції, передавані в IframeShim.

Події

• show - (function) callback для виконання при показі шару; передається цільовий елемент, до якого був приєднаний Mask.
• hide - (function) callback для виконання при приховуванні шару; передається цільовий елемент, до якого був приєднаний Mask.
• destroy - (function) callback для виконання при знищенні шару.
• click - (function) callback для виконання при кліку на шар.

Приклади

var myMask = new Mask();
var myMask = new Mask($('myElement'));

Стилі

Елемент маски не має стилів, тому якщо ви не додасте CSS-правило до своїх таблиць стилів, він буде невидимим. Ви можете завантажити стилі за замовчуванням тут: mask.css

Mask Method: toggle

Перемикає видимість Mask. Якщо Mask зараз видимий, він сховається. Інакше він відобразиться.

Синтаксис

myMask.toggle(element);

Аргументи

1. element - (mixed, optional) Рядок з id або посилання на Element або Element для накладання; за замовчуванням ціль, передана при ініціалізації, але ви можете вказати інший елемент, якщо бажаєте повторно використовувати клас.

Повертає

• (object) Цей екземпляр Mask

Mask Method: show

Відображає шар Mask.

Синтаксис

myMask.show();

Повертає

• (object) Цей екземпляр Mask

Mask Method: hide

Ховає шар Mask.

Синтаксис

myMask.hide();

Повертає

• (object) Цей екземпляр Mask

Mask Method: destroy

Знищує шар Mask. Це робить екземпляр цього класу неактивним (далі виклики його методів викликатимуть помилки).

Синтаксис

myMask.destroy()

Повертає

• (object) Цей екземпляр Mask

Mask Method: position

Повторно встановлює позицію накладного шару.

Синтаксис

myMask.position()

Повертає

• (object) Цей екземпляр Mask

Mask Method: resize

Повторно встановлює розміри накладного шару. Примітка: цей метод викликається, коли викликається Mask.position, тому вам не потрібно викликати його, якщо ви викликаєте position.

Синтаксис

myMask.resize()

Повертає

• (object) Цей екземпляр Mask

Type: Element

Розширює тип Element методами Mask.

Element Property: mask

Сеттер

Встановлює екземпляр Mask за замовчуванням для Element.

Синтаксис

el.set('mask'[, options]);

Аргументи

1. options - (object, optional) Опції Mask.

Повертає

• (element) Цей Element.

Приклади

el.set('mask', {onClick: function(){..etc..}});
el.mask(); //obscure the element with the overlay
el.unmask(); //hide the overlay

Геттер

Отримує екземпляр Mask за замовчуванням для Element.

Синтаксис

el.get('mask');

Аргументи

1. name - (string) Це завжди має бути 'mask'.

Повертає

• (object) Внутрішній екземпляр Mask Element.

Приклади

el.set('mask', {onClick: function(){..etc..}});
el.mask(); //show the mask
el.get('mask'); //The Mask instance.

Type: Element

Додає скорочення Mask до класу Element.

Element Method: mask

Отримує "вбудований" екземпляр Mask і викликає його метод show.

Синтаксис

$('myElement').mask([options]);

Аргументи

1. options - (object - optional) опції для маски за замовчуванням.

Повертає

• (element) Цей Element

Element Method: unmask

Отримує "вбудований" екземпляр Mask і викликає його метод hide.

Синтаксис

$('myElement').unmask();

Повертає

• (element) Цей Element