Класс Speller позволяет запустить проверку правописания, показать диалог настроек Яндекс.Спеллера, а также содержит средства для управления параметрами сервиса.
Константы
| Имя |
Значение (десятичное) |
Описание |
|
IGNORE_UPPERCASE
|
1 |
Пропускать слова, написанные заглавными буквами, например, "ВПК". |
|
IGNORE_DIGITS
|
2 |
Пропускать слова с цифрами, например, "авп17х4534". |
|
IGNORE_URLS
|
4 |
Пропускать интернет-адреса, почтовые адреса и имена файлов. |
|
FIND_REPEAT
|
8 |
Подсвечивать повторы слов, идущие подряд. Например, "я полетел на на Кипр". |
|
IGNORE_LATIN
|
16 |
Пропускать слова, написанные латиницей, например, "madrid". |
|
FLAG_LATIN
|
128 |
Отмечать слова, написанные латиницей, как ошибочные. |
Конструктор
| Имя |
Описание |
|
Speller(args)
|
Задает параметры Яндекс.Спеллера. Единственным параметром конструктора является объект args со следующими полями: |
Поля
| Имя |
Описание |
|
url
|
URL каталога, в который установлен Яндекс.Спеллер, см. шаг 1 в инструкции по подключению Веб-Спеллера.
|
|
lang
|
Язык словаря проверки орфографии. Возможные значения:
- “ru” (русский);
- “uk” (украинский);
- “en” (английский).
Значение по умолчанию: “ru” (русский).
|
|
options
|
Сумма значений констант, соответствующих выбранным опциям Веб-Спеллера. Значение по умолчанию:
0 (ничего не выбрано).
|
|
spellDlg
|
Размеры окна «Проверка правописания» {width,height}. |
|
optDlg
|
Размеры окна «Параметры Яндекс.Спеллера» {width,height}. |
|
userDicDlg
|
Размеры окна «Редактирование словаря пользователя» {width,height}. |
Пример:
Создает объект speller с заданными настройками.
var speller = new Speller(
{ url: "/speller",
lang: "ru", options: Speller.IGNORE_LATIN + Speller.IGNORE_URLS,
spellDlg: { width: 500, height: 320 }
}
);
Параметры lang и options задают «начальные» параметры Спеллера. Их значения могут быть изменены пользователем в диалоговом окне «Параметры». Введенные значения сохраняются в файле cookie для дальнейшего использования.
Размеры диалоговых окон задаются объектом с полями width и height (соответственно, ширина и высота окна в пикселах). Размеры окон – это единственные параметры пользовательского интерфейса, которые возможно изменять средствами API. Все прочие параметры изменяются посредством редактирования HTML- и CSS-файлов.
Методы
| Имя |
Описание |
|
check(ctrls)
|
Показывает диалоговое окно «Проверка правописания» и начинает проверять правописание в указанных полях. |
| optionsDialog() |
Показывает диалоговое окно «Параметры», в котором пользователь может выбрать язык словаря и изменить настройки Яндекс.Спеллера. |
Подробное описание методов
check
Показывает диалоговое окно «Проверка правописания» и начинает проверять правописание в указанных полях.
Параметры:
| Имя |
Тип |
Описание |
|
ctrls
|
HTMLElement[] |
Массив текстовых полей, которые необходимо проверить. |
Пример:
Проверка правописания в элементах subj и message HTML-формы myForm:
speller.check( [ myForm.subj, myForm.message ] );
optionsDialog
Показывает диалоговое окно «Параметры», в котором пользователь может выбрать язык словаря и изменить настройки Яндекс.Спеллера.
