Dashboard

Виджет объект

Виджет объект является объектом JavaScript, который обеспечивает Dashboard конкретным расширением. Когда ваш виджет загружен, Dashboard автоматически создает экземпляр этого объекта для использования в коде JavaScript в вашем виджете. Название этого экземпляра widget.

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

Свойства

identifier

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

widget.identifier

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

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

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

widget.openApplication(bundleId)

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

openURL

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

widget.openURL(url)

Этот метод открывает указанный URL и закрывает Dashboard слой. Этот метод не позволяет открывать URL-адреса, которые используют file:, если только не установлен ключ AllowFileAccessOutsideOfWidget в Info.plist виджета.

preferenceForKey

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

widget.preferenceForKey(key)

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

prepareForTransition

Сообщает Dashboard, что вы собираетесь выполнить переход в или из его обратной стороны.

widget.prepareForTransition(transition)

Этот метод готовит свой ​​виджет как для отображения, так и скрытия своей обратной стороны.

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

performTransition

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

widget.performTransition()

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

setCloseBoxOffset

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

widget.setCloseBoxOffset(x, y)

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

setPreferenceForKey

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

widget.setPreferenceForKey(preference, key)

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

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

system

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

widget.system(command, endHandler)

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

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

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

СвойствоОпределениеИспользование
outputStringвывод команды, как stdoutvar output = widget.system("/usr/bin/id -un", null).outputString;
errorStringвывод команды, как stderrvar error = widget.system("/usr/bin/id -un", null).errorString;
statusстатус завершения команды.var status = widget.system("/usr/bin/d -un", null).status;
 

Если указан endHandler, команда выполняется асинхронно, что означает, что команда выполняется одновременно с кодом виджета и обработчик вызывается по завершении выполнения утилиты командной строки. При запуске асинхронно, 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).
 

Примечание: Чтобы использовать widget.system, необходимо установить ключ AllowSystem в Info.plist. Для получения дополнительной информации см. раздел "Ключи Dashboard Info.plist".

 
 
homeЗаметили ошибкукарта сайта 
   Made on a Mac