NSTextFinder

Реализация панели находки

Респондент performTextFinderAction: ответственно за создание и владение экземпляром NSTextFinder. Прежде чем любые другие сообщения отправляются в NSTextFinder, необходимо установить client свойство к объекту, реализующему NSTextFinderClient протокол.

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

Этот метод определит желаемое действие от тега и сделает различные обратные вызовы к client выполнять то действие. Эти обратные вызовы определяются в NSTextFinderClient протокол.

Проверка происходит подобным образцом. Респондент должен реализовать validateUserInterfaceItem: и, когда действие элемента performTextFinderAction: метод, это должно передать тег элемента следующему методу и возвратить результат:

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

Когда действие будет выполняться, текстовое средство поиска попросит, чтобы искал его клиент строку. Существует два способа, которыми клиент может обеспечить эту строку. Это может или реализовать string метод, и просто возвращается NSString экземпляр, или это может реализовать следующие методы: stringAtIndex:effectiveRange:endsWithSearchBoundary: и stringLength.

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

Например, если у клиента были строки “Быстрое”, “коричневая лиса”, “перепрыгнул через ленивое”, и «собаку» и a NSTextFinder экземпляр запрашивает строку в индексе 18, тогда клиент должен возвратить «коричневую лису”. Если бы все строки были связаны, то вместе был бы ‘x’ у «лисы». Кроме того, клиент должен возвратиться, ссылкой через outRange параметр, диапазон измерений возвращающейся строки. В этом примере диапазон “коричневой лисы” {9, 10}, потому что в предполагаемой связи подстрока запускается в индексе 9 и является 10 символами долго.

В некоторых случаях не желательно для соответствия быть найденным, который перекрывает многократные строки, возвращенные stringAtIndex:effectiveRange:endsWithSearchBoundary: метод. Например, предположите, что у клиента есть список имен как «Джон Доу» и «Джейн Доу», и т.д. Обычно, если строка связывается вместе как так: «Джон Доу Джейн Доу», затем поиск «Доу Джейн» успешно выполнился бы. Для предотвращения этого часто нежелательное поведение клиент должен возвратиться YEStrue, ссылкой, через outFlag параметр, при возврате каждой отдельной строки. Это указывает, что существует граница между текущей строкой и следующей строкой, которая не должна быть пересечена при поиске соответствия.

Один из двух подходов (реализующий string метод stringAtIndex:effectiveRange:endsWithSearchBoundary: и stringLength методы), должен быть реализован клиентом или NSTextFinder экземпляр не будет функционировать. Если все три метода реализованы, stringAtIndex:effectiveRange:endsWithSearchBoundary: будет использоваться по умолчанию.

Текстовое средство поиска может запросить дополнительную информацию от client объект выполнить действие, или это может потребовать client выполнять некоторые части действия от своего лица. Методы и свойства, описанные в текстовых Клиентских Требованиях Реализации Средства поиска, описывают рычаги, которых текстовое средство поиска требует для каждого из действий, которые это поддерживает. Если клиент не реализует один из этих методов или свойств, то действие, требующее его, будет отключено.

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

Типичная функция, использованная в сочетании с панелью находки, является инкрементным поиском. Эта функция позволяет пользователям сразу найти соответствия, поскольку они вводят. В OS X v10.7, текстовое средство поиска обеспечивает эту функцию своих клиентов с минимальным дополнительным API.

Инкрементный поиск может быть включен путем установки incrementalSearchingEnabled свойство YEStrue. Одно только это свойство достаточно, чтобы начать искать инкрементно.

Для улучшенной скорости отклика, когда документ будет достаточно длинен, текстовое средство поиска будет искать документ в фоновом режиме. Для обеспечения потокобезопасности клиент, использующий инкрементный поиск, должен вызвать noteClientStringWillChange метод перед любыми изменениями сделан к строке, предоставленной для текстового средства поиска.

Во время инкрементного поиска выделяются все видимые соответствия. Если client объект, соответствующий NSTextFinderClient протокол реализует только для чтения visibleCharacterRanges свойство, тогда по умолчанию серое наложение появится по Вашему представлению содержания контейнера панели находки с прозрачными областями для каждого соответствия. Это представление должно быть суперпредставлением всех подпредставлений, о которых сообщает текстовый клиент средства поиска. NSScrollView класс уже реализует это свойство, таким образом, только необходимо реализовать это свойство при использовании различного контейнерного класса.

Наконец, этот режим также требует тех же двух NSTextFinderClient методы протокола, использующиеся для отображения индикатора находки: contentViewAtIndex:effectiveCharacterRange: и rectsForCharacterRange: быть реализованным. Однако реализация этих методов идентична в обеих целях, таким образом, никакая дополнительная работа не требуется, чтобы поддерживать инкрементный поиск.

Замена текста

Методы замены текста:shouldReplaceCharactersInRanges:withStrings:, replaceCharactersInRange:withString:, и didReplaceCharacters используются заменой, заменяют все, заменяют все в разделе, и заменяют и находят действия.

Прежде чем работа замены выполняется, NSTextFinder экземпляр вызывает client объект shouldReplaceCharactersInRanges:withStrings: метод, чтобы определить, должна ли замена иметь место. Если это возвращается NOfalse, тогда символы в данных диапазонах не будут заменены. Если возвращается метод YEStrue, или не реализован, тогда второй метод, replaceCharactersInRange:withString:, то, чтобы давать команду клиенту выполнить замену. Наконец, didReplaceCharacters, если реализовано, вызывается, чтобы указать, что была завершена замена.

Для замены все действия эти методы вызовут многократно, запускающийся с последнего соответствия и перемещающийся к первому, для сохранения индексов соответствий, предшествующих текущему.

Текстовый контейнер средства поиска

Для отображения панели находки контейнер для панели находки должен быть указан. Контейнер является объектом, соответствующим NSTextFinderBarContainer протокол. Вы указываете контейнер панели находки использование следующего класса NSTextFinder findBarContainer свойство.

Когда новый экземпляр NSTextFinder будет создан и проинструктирован для отображения панели находки, он создаст представление для панели находки и присвоит это контейнеру через NSTextFinderBarContainer класс findBarView свойство. Когда контейнер освобожден, контейнер тогда владеет тем представлением и должен выпустить его. Контейнер должен сделать панель находки видимой когда контейнер findBarVisible свойство установлено в YEStrue. Контейнер должен реализовать findBarViewDidChangeHeight метод, таким образом, это может изменить местоположение панели находки, когда ее высота изменяется, обычно в ответ на пользовательское действие.

Реализация классами набора приложения

Два класса Набора Приложения уже предоставляют поддержку для NSTextFinder класс, включая: NSScrollView и NSTextView классы.