Объект виджета

Объект Виджета является объектом JavaScript, обеспечивающим Специфичные для инструментальной панели расширения. Когда Ваш виджет загружается, Инструментальная панель автоматически создает экземпляр этого объекта для использования в коде JavaScript Вашего виджета. Имя этого экземпляра widget.

Свойства

Следующие разделы описывают свойства объекта Виджета.

идентификатор

Содержит уникальный идентификатор для этого экземпляра виджета.

widget.identifier

Это свойство только для чтения содержит строковое значение, которое уникально среди всех экземпляров единственного виджета. Это значение присваивается Инструментальной панелью и сохраняется между инстанцированиями каждого экземпляра виджета.

ondragstart

Содержит обработчик событий, который вызовут на запуск виджета, перетаскивают.

widget.ondragstart

Присвойте функцию этому свойству, если Вы хотите быть уведомленными, когда Ваш виджет начал перетаскивание. Вы используете эту функцию для изменения пользовательского интерфейса виджета, в то время как это перетаскивается. Ваше объявление функции должно быть похожим на следующее:

function MyDragStartHandler() { ... }

ondragend

Содержит обработчик событий, который вызовут на конец виджета, перетаскивают.

widget.ondragend

Присвойте функцию этому свойству, если Вы хотите быть уведомленными, когда Ваш виджет закончил перетаскивание. Вы используете эту функцию для изменения пользовательского интерфейса виджета после того, как это было перетащено. Ваше объявление функции должно быть похожим на следующее:

function MyDragEndHandler() { ... }

onhide

Содержит обработчик событий, который вызовут, когда скрыт уровень Dashboard.

widget.onhide

Присвойте функцию этому свойству, если Вы хотите быть уведомленными, когда скрыт Ваш виджет. Вы используете эту функцию, чтобы деактивировать Ваш виджет и поместить его в состояние покоя. Ваше объявление функции должно быть похожим на следующее:

function MyHiddenHandler() { ... }

onremove

Содержит функцию, которую вызовут, когда Ваш виджет удален из уровня Dashboard.

widget.onremove

Присвойте функцию этому свойству, если Вы хотите быть уведомленными, когда Ваш виджет удален из уровня Dashboard. После получения этого события Ваш виджет должен выполнить любые необходимые операции очистки, те, которые сохраняют ее предпочтения, удаляют файлы кэша и высвобождают любые средства, которые это в настоящее время содержит. Ваше объявление функции должно быть похожим на следующее:

function MyRemoveHandler() { ... }

onshow

Содержит функцию, которую вызовут, когда показан уровень Dashboard.

widget.onshow

Присвойте функцию этому свойству, если Вы хотите быть уведомленными, когда показан Ваш виджет. Вы используете эту функцию, чтобы активировать Ваш виджет и начать обрабатывать данные снова будучи статическими. Ваше объявление функции должно быть похожим на следующее:

function MyShowHandler() { ... }

Методы

Следующие разделы описывают методы объекта Виджета.

openApplication

Запускает приложение с указанным идентификатором пакета.

widget.openApplication(bundleId)

Используйте этот метод для запуска приложения, обозначенного bundleId в целевой системе. Вызов этого метода отклоняет уровень Dashboard.

openURL

Открывает указанный URL в предпочтительном браузере пользователя.

widget.openURL(url)

Этот метод открывает указанный URL и отклоняет уровень Dashboard. Этот метод не разрешает открытие URLs, использующего file: схема, если AllowFileAccessOutsideOfWidget ключ устанавливается в информационном файле списка свойств виджета.

preferenceForKey

Возвращает предпочтение, связанное с указанным ключом.

widget.preferenceForKey(key)

Используйте этот метод для получения предпочтительного значения, ранее сохраненного вызовом к setPreferenceForKey. Метод возвращает строку с содержанием предпочтения, или undefined если не существует никакое такое предпочтение.

prepareForTransition

Уведомляет Инструментальную панель, что Вы собираетесь выполнить переход к или от его обратной стороны.

widget.prepareForTransition(transition)

Этот метод подготавливает Ваш виджет или к показу или к сокрытию его обратной стороны.

Передача строки «ToBack» для transition отключает экранные обновления в пользовательском интерфейсе Вашего виджета так, чтобы можно было подготовить его к отображению обратной стороны виджета. Передача строки «ToFront» для transition замораживает пользовательский интерфейс Вашего виджета так, чтобы можно было подготовить его к отображению основного содержания снова. Когда Ваши уровни HTML будут готовы, вызвать performTransition вывести на экран их.

performTransition

Выполняет анимацию для переключения между реверсом и содержанием виджета.

widget.performTransition()

Вы вызываете этот метод после первого вызова prepareForTransition, который указывает, выводите ли Вы на экран обратную сторону или содержание своего виджета. Когда Вы вызываете performTransition, Инструментальная панель начинает анимацию, заставляющую виджет, казаться, перевернуть и вывести на экран новое содержание.

До вызова этого метода необходимо также скорректировать свойства таблицы стилей HTML для отражения изменения в том, что собирается быть выведенным на экран. Например, прежде, чем вызвать этот метод для показа обратной стороны необходимо показать элементы HTML, связанные с обратной стороной, и скрыть те элементы, связанные с содержанием виджета.

setCloseBoxOffset

Изменяет местоположение рамки для закрытия виджета.

widget.setCloseBoxOffset(x, y)

Используйте этот метод для перемещения рамки для закрытия виджета. Этот метод центрирует пиксели рамки для закрытия x от левого края виджета и y пиксели вниз от вершины виджета. Только значения между 0 и 100 допускаются x и y.

setPreferenceForKey

Связывает предпочтение с данным ключом.

widget.setPreferenceForKey(preference, key)

Предпочтение и основные параметры содержат строки, представляющие предпочтение, которое Вы хотите сохранить и ключ, с которым Вы хотите связать его. Указание null для предпочтения параметр удаляет указанный ключ из предпочтений.

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

система

Выполняет утилиту командной строки.

widget.system(command, endHandler)

Параметр команды является строкой, указывающей утилиту команды, которая будет выполняться. Это должно указать полный или относительный путь к утилите командной строки и включать любые параметры. Например:

widget.system(“/usr/bin/id -un”, null);

endHandler параметр указывает обработчик, который вызовут, когда команда закончила выполняться. Если NULL, весь метод выполняется синхронно, означая, что закончено все выполнение в остановах виджета до команды. При выполнении синхронно, эти опции доступны:

Таблица 1-1  widget.system свойства, доступные во время синхронного использования

Свойство

Определение

Использование

outputString

Вывод команды, как помещено в stdout.

var output = widget.system(“/usr/bin/id -un”, null).outputString;

errorString

Вывод команды, как помещено в stderr.

var error = widget.system(“/usr/bin/id -un”, null).errorString;

status

Статус выхода команды.

var status = widget.system(“/usr/bin/d -un”, null).status;

Если endHandler указан, команда выполняется асинхронно, означая, что команда работает одновременно, и обработчик вызывают, когда закончено выполнение. Когда выполнено асинхронно, widget.system возвращает объект, который может сохраняться и использоваться для выполнения других операций после команды:

Таблица 1-2  widget.system свойства и методы, доступные во время асинхронного использования

Опция

Цель

Описание

command.outputString

Свойство

Текущая строка, записанная в stdout (стандартный вывод) командой.

command.errorString

Свойство

Текущая строка, записанная в stderr (вывод стандартной погрешности) командой.

command.status

Свойство

Статус выхода команды, как определено командой.

command.onreadoutput

Обработчик событий

Функция вызвала каждый раз, когда команда пишет в stdout. Обработчик должен принять отдельный аргумент; когда вызвано, параметр содержит текущую строку, помещенную в stdout.

command.onreaderror

Обработчик событий

Функция вызвала каждый раз, когда команда пишет в stderr. Обработчик должен принять отдельный аргумент; когда вызвано, параметр содержит текущую строку, помещенную в stderr.

command.cancel()

Метод

Отменяет выполнение команды.

command.write(string)

Метод

Пишет строка в stdin (стандартный ввод).

command.close()

Метод

Завершения stdin (EOF).