Объектные спецификаторы и KVC

Сценарии какао полагаются на кодирование значения ключа (KVC) при оценке объектных спецификаторов. Когда приложение сначала должно работать с scriptability информацией, Какао, пишущее сценарий информации о загрузках от sdef файла приложения в глобальный экземпляр NSScriptSuiteRegistry. В то время это регистрирует описания класса для Ваших scriptable классов. В результате Какао и Ваше приложение могут получить информацию об описании класса сценария, включая ключи, о scriptable классах для использования с объектными спецификаторами.

Для получения дополнительной информации посмотрите Загрузку информация о Scriptability.

Когда реализовать объектный метод спецификатора

Любой класс в Вашем приложении, которое является частью иерархии вместимости для Вашей поддержки scriptability, наиболее вероятно потребует объектного метода спецификатора. Когда оператор сценария предназначается для Вашего приложения, приложение, возможно, должно возвратить ответ. Например, результат a get команда часто является объектом или списком объектов. Когда Какао возвращает эти объекты в событии Apple ответа, оно не возвращает указатели на объекты Objective C, оно возвращает объектные спецификаторы, определяющие местоположение scriptable объектов в иерархии вместимости. Как часть создания этих спецификаторов, Какао обращается к Вашим scriptable объектам предоставить спецификаторы для себя.

Вы обеспечиваете объектный спецификатор для scriptable класса путем реализации objectSpecifier метод. Тот метод определяется в NSScriptObjectSpecifiers (отметьте запаздывание «s»), категория на NSObject это реализует просто возвращающуюся версию nil.

Об объектных классах спецификатора

objectSpecifier метод возвращает экземпляр одного из классов, перечисленных в Таблице 6-1, которые являются подклассами NSScriptObjectSpecifier. Классы такой как NSNameSpecifier и NSUniqueIDSpecifier представляйте стандартные ссылочные формы AppleScript, таким образом, Вы не должны должны быть разделять их на подклассы. Вы выбираете лучшую версию для объекта, который необходимо указать — см. Инструкции по Интерфейсу Сценариев для руководства. Например, если объект имеет уникальное имя или уникальный идентификатор, используйте соответствующий тип спецификатора. Для безымянного объекта без ID, такого как прямоугольник или абзац текста, можно хотеть возвратить индексный спецификатор.

Большинство подклассов NSScriptObjectSpecifier имейте определенный инициализатор, который необходимо использовать.

Большинство методов инициализатора для объектного класса спецификатора включает следующие параметры:

• (NSScriptClassDescription *)classDescription

  Здесь Вы предоставляете описание класса для контейнерного класса указанного объекта. Необходимо всегда предоставлять описание класса для спецификатора.

  Если у Вас уже есть объектный спецификатор для контейнера, можно получить описание класса для того контейнерного объекта с помощью NSScriptObjectSpecifier метод keyClassDescription, как показано в Перечислении 6-1.

  Когда можно получить класс контейнерного объекта (например, путем вызова [NSApp class]), можно использовать classDescriptionForClass метод для определения контейнерного описания, как показано в Перечислении 6-2. Если у Вас есть экземпляр класса контейнера, можно вместо этого использовать NSObject метод экземпляра classDescription получить контейнерное описание.

• (NSScriptObjectSpecifier *)specifier

  Здесь Вы предоставляете объектный спецификатор для родительского контейнера указанного объекта. Вы обычно получаете его путем вызова objectSpecifier метод содержания объекта.

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

• (NSString *)key

  Здесь Вы предоставляете ключ, говорящий родительский контейнер, как найти указанный объект. Ключ, который Вы передаете, основывается на информации, предоставленной в Вашем sdef файле. Например, Эскиз определяет "graphics" ключ для идентификации графического массива в документе Эскиза. (Эскиз фактически определяет исключительное "graphic" как элемент document класс, но сценарии Какао применяет свои стандартные правила, описанный в Обеспечивают Ключи для Кодирования Значения ключа, для преобразования этого ключа в строку "graphics".)

Для аннотируемого примера objectSpecifier метод, посмотрите Объектный Метод Спецификатора для Прямоугольника в Эскизе.

Более внимательное рассмотрение в объектном спецификаторе

Рассмотрите схему объектной модели и иерархии вместимости для примера приложения Эскиза, показанного на рисунке 6-1. Левая сторона этой иллюстрации показывает scriptable объекты Эскиза, правая сторона соответствующая иерархия вместимости приложения. Для оператора сценария, идентифицирующего a rectangle возразите слева, сценарии Какао предоставляют объектный спецификатор, определяющий местоположение прямоугольника и его содержания документа в иерархии вместимости справа.

Каждый объектный спецификатор содержит ссылку на свое содержание объекта, позволяющего объектным спецификаторам представлять объекты, которые могут быть глубоко вложены в иерархии объектов. Наиболее удаленный контейнер, представленный нулевым спецификатором объекта, обычно application объект, несмотря на то, что это может быть объектный спецификатор, вовлеченный в a whose пункт (NSWhoseSpecifier) или контейнер для оценки диапазона.

Рисунок 6-2 показывает спецификаторы вложенного объекта для оператора first rectangle in document "SketchDocOne":

Вот то, как интерпретировать информацию в этом числе:

1. Индексный спецификатор указывает первый прямоугольник, который является объектом класса SKTRectangle. Спецификатор имеет эти компоненты:

   • Индекс для указанного объекта, в этом примере имеющего значение 0.

     Это - основанный на нуле индекс указанного прямоугольника в его содержании массива. Поскольку графические массивы Эскиза могут содержать другие виды графики, индекс для первого прямоугольника будет не всегда иметь значение 0— например, если бы предшествуется четырьмя круговой графикой, индекс имел бы значение 4.

   • Ключ, указывающий набор для указанного объекта, в этом примере имеющего значение "graphics".

     Графический массив является набором для индексируемого объекта. Ключ соответствует информацию, предоставленную Вашим sdef и сделанную доступный в запущенном приложении, как описано в Объектных Спецификаторах и KVC.

   • Контейнерная ссылка, указывающая родителя для этого объектного спецификатора. В этом примере контейнер является объектным спецификатором для документа "SketchDocOne".

2. Спецификатор имени указывает документ, содержащий первый прямоугольник, который является объектом класса SKTDrawDocument. Спецификатор имеет эти компоненты:

   • Имя для указанного объекта, в этом примере имеющего значение "SketchDocOne".

   • Ключ, указывающий набор для указанного объекта, в этом примере имеющего значение "orderedDocuments".

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

   • Контейнерная ссылка, указывающая родителя для этого объектного спецификатора. В этом примере ссылка nil, указание, что массив документов содержится application объект.

   Оператор сценария, и таким образом объектный спецификатор, могут указать объекты, в настоящее время не существующие в приложении, вызывая состояние ошибки, когда выполняется сценарий. Например, указанный документ может не существовать, или он может не содержать указанную диаграмму. Код в классе команды должен проверить на и быть подготовлен обработать условия распространенной ошибки. (Проверку не считают подходящей для методов получателя KVC и методов установщика.)

Оценка вложенных спецификаторов

Когда сценарии Какао подготавливают команду сценария к сценарию, содержащему ссылку, они преобразовывают ссылку во вложенную серию объектных спецификаторов, таких как те показанные на рисунке 6-2. Это упаковывает эти спецификаторы вложенного объекта как получатель команды (или в некоторых случаях как параметр команды). Когда команда выполняется, приложение оценивает объектные спецификаторы в своем собственном контексте для обнаружения указанных объектов.

Оценка запускается со спецификатора верхнего уровня и продолжает вниз цепочку объектных спецификаторов, оценивая и разрешая каждого, пока не определяются идентификационные данные заключительного, вложенного дочернего объекта. Этот объект является получателем (или получателями) команды или одного из параметров команды. Кодирование значения ключа используется в качестве стандартного механизма для оценки. Объектный спецификатор запрашивает свой оцененный контейнер для значения ключа, связанного с объектным спецификатором.

Оценка объектных спецификаторов описана более подробно в Командах Сценария и Объектных Спецификаторах.

Объектный метод спецификатора для прямоугольника в эскизе

Перечисление 6-1 показывает, как пример приложения Эскиза (доступный от Apple) реализует objectSpecifier метод для SKTGraphic класс.

Перечисление 6-1  объектный метод спецификатора для прямоугольника

- (NSScriptObjectSpecifier *)objectSpecifier{

    NSArray *graphics = [[self document] graphics];// 1

    unsigned index = [graphics indexOfObjectIdenticalTo:self];// 2

    if (index != NSNotFound) {

       NSScriptObjectSpecifier *containerRef = [[self document] objectSpecifier];// 3

        return [[[NSIndexSpecifier allocWithZone:[self zone]]

            initWithContainerClassDescription:[containerRef keyClassDescription]

            containerSpecifier:containerRef key:@"graphics" index:index] autorelease];// 4

    } else {

        return nil;// 5

    }

}

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

1. Из его документа это получает массив графики и определяет индекс графического получения, если это содержится в массиве.

2. Это получает объектный спецификатор документа, содержащего диаграмму.

   Эскиз определяет SKTDrawDocument класс как подкласс NSDocument. Объектный метод спецификатора для NSDocument возвращает экземпляр NSNameSpecifier это идентифицирует документ по имени в массиве приложения упорядоченных документов.

3. Это создает и инициализирует индексный спецификатор (тип NSIndexSpecifier) для графического получения и возвраты это.

   Спецификатор определяет местоположение диаграммы индексом в графике в ее документе. Несмотря на то, что сценарий AppleScript просит индексируемые элементы, как будто они на основе одни, этот индексный спецификатор, определяющий местоположение объектов в массиве, соответствующих указанным элементам, работам с основанными на нуле значениями. Для получения информации о других параметрах займитесь Объектными Классами Спецификатора.

Указание объекта приложения как контейнер

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

Перечисление 6-2  , Указывающее приложение как контейнер

NSScriptClassDescription *containerClassDesc = (NSScriptClassDescription *)

    [NSScriptClassDescription classDescriptionForClass:[NSApp class]];// 1

return [[[NSNameSpecifier alloc]

    initWithContainerClassDescription:containerClassDesc

    containerSpecifier:nil key:@"orderedDocuments"

    name:[self lastComponentOfFileName]] autorelease];// 2

Вот описание того, что делает этот фрагмент кода:

1. Приложение является контейнером для списка упорядоченных документов, таким образом, этот код сначала получает описание класса из глобального объекта приложения, NSApp. (Вы никогда не передаете nil для описания класса.)

2. Это тогда создает и возвращает автовыпущенный объектный спецификатор типа NSNameSpecifier, передача nil для containerSpecifier параметр для указания контейнера верхнего уровня, приложения. (Это - единственный случай, в котором можно передать nil для контейнера.)

   Это вызывает NSDocument метод lastComponentOfFileName получить имя документа и использования это для построения объекта спецификатора имени.