Publishers of technology books, eBooks, and videos for creative people

Home > Articles > Apple > Operating Systems

  • Print
  • + Share This
This chapter is from the book

Step 7: Implement and Validate the Search Field

The Vermont Recipes application has a general Find command in the Edit menu, courtesy of the Cocoa document-based application template. Try it out. It finds any text in the diary window, whether the text is located in an entry's title, its tag title, or its text.

But that isn't the only kind of text-based search you want for the Vermont Recipes application. You went to a lot of trouble to provide a tag list in the diary window. It is now time to put it to use by enabling the user to search for tags alone.

The idea behind tags is that you tag every entry with words or very short phrases that describe the content of the entry. Examples of interesting tags are dessert and appetizers. In this step, you implement the search field at the bottom of the diary window so that it finds tags only in tag lists, not in an entry's text, and it selects and highlights the tags so that you can see them while scrolling through the diary. To find every entry that is tagged with the dessert tag, for example, type dessert in the search field. Assuming that multiple entries have that tag, the first dessert tag scrolls into view and briefly highlights. Repeatedly clicking Return in the search field scrolls to each successive instance of the dessert tag and highlights it. All instances remain selected as you scroll up and down using the scroll bar.

  1. To start with, add placeholder text to the search field. In Interface Builder, select the search field and go to the Search Field Attributes inspector. Enter tag in the Placeholder field. This word will appear dimmed in the search field when it does not have keyboard focus, to remind the user that the search field filters the diary on the basis of tags. When the user clicks in the search field to begin typing a tag, the placeholder text disappears automatically.

  2. Write the -findTag: action method. For search fields, the action method you write must search for and display the found text.

    In the DiaryWindowController.h header file, declare the action method immediately following the existing action methods, like this:

    - (void)findTag:(id)sender;

    In the corresponding source file, implement it like this:

    - (IBAction)findTag:(id)sender {
        NSTextView *keyView = [self keyDiaryView];
        NSString *tagString = [sender stringValue];
        NSArray *tagRangeArray = [[self document]
        if ([tagRangeArray count] > 0) {
            [keyView setSelectedRanges:tagRangeArray];
            static NSUInteger highlightIndex = 0;
            static NSUInteger tagStringLength = 0;
            if (tagStringLength != [tagString length]) highlightIndex = 0;
            NSRange highlightRange =
                   [[tagRangeArray objectAtIndex:highlightIndex] rangeValue];
            tagStringLength = [tagString length];
            highlightIndex =
                  (highlightIndex < [tagRangeArray count] - 1)
                  ? highlightIndex + 1 : 0;
            [keyView scrollRangeToVisible:highlightRange];
            [keyView showFindIndicatorForRange:highlightRange];

    The -findTag: action method uses many techniques that you have already seen and used for working with text.

    It starts by determining which of the two text fields has keyboard focus, using the -keyDiaryView method you wrote earlier. Then it reads the search field's text to ascertain the target tag by calling the -stringValue method on the sender argument, which in this case is the search field. The algorithm it uses is very simple: There are no tag separator characters. Every character you type into the search field is considered to be part of the tag you're looking for, including spaces and punctuation.

    The method then sets up a search for all the tags in the text, from beginning to end, looking for the tag marker character and the immediately following tag label, Tags:. It looks only in tag lists. To do this, it calls another range method you will write in the DiaryDocument class, -foundTagRangeArrayForTag:. As you will see in a moment, that method calls two supporting methods you will write shortly, -firstTagRange and -nextTagRangeForIndex:. The actual search uses NSString's fast and efficient -rangeOfString:options:range: method, which you have already encountered. In the search loop, the range of the first found tag in every tag list is added to a mutable array, tagRangeArray.

    In the final section of the code, the array of tag ranges is used by NSTextView's -setSelectedRanges: method, which selects and highlights all of them wherever they appear in the text. Next, one of the selected tags is scrolled into view, and it is then highlighted with a brief, eye-catching animation generated by NSTextView's -showFindIndicatorForRange: method.

    The final section of the code implements a simple algorithm to control the order in which instances of the same tag are highlighted on successive presses of the Return key. The search field is configured to display found tags as you type each character into the field. When you type the h in ho, for example, it highlights the first h in the first tag containing an h. If you then hit the Return key while h is still the tag you're searching for, it highlights the first h in the second tag containing an h. It continues in this fashion until it runs out of found h tags, and then it cycles back to the beginning. If, instead of pressing Return after typing h, the user types the o in ho, the method notices that the length of the search text has changed and restarts the cycle. To keep track of the length of the search text and the index of the tag it highlighted the last time the user pressed Return, it uses two static variables, highlightIndex and tagStringLength. The values of static variables are saved between invocations of the method. It is safe to use static variables here, instead of instance variables, because you will eventually take steps to ensure that there can never be more than one diary window.

  3. Now write the -foundTagRangeArrayForTag: method. Like the range methods you have written previously, it belongs in the DiaryDocument class.

    In the DiaryDocument.h header file, declare it:

    - (NSArray *)foundTagRangeArrayForTag:(NSString *)tag;

    In the DiaryDocument.m implementation file, define it:

    - (NSArray *)foundTagRangeArrayForTag:(NSString *)tag {
        if ([tag length] > 0) {
             NSString *tagLabel = [NSString stringWithFormat:
                    NSLocalizedString(@"%@ Tags: ",
                    @"search string for diary document tag string"),
                    [self tagMarker]];
                    NSMutableArray *tagRangeArray = [NSMutableArray array];
                    NSRange searchRange = [self firstTagRange];
                    NSRange foundRange;
                    while (searchRange.location != NSNotFound) {
                         searchRange.location += [tagLabel length];
                         searchRange.length -= [tagLabel length];
                         foundRange =     
                                [[[self diaryDocTextStorage] string]     
                                rangeOfString:tag options:0 range:searchRange];
                         if (foundRange.location != NSNotFound)     
                                [tagRangeArray addObject:     
                                [NSValue valueWithRange:foundRange]];
                         searchRange = [self nextTagRangeForIndex:     
                                searchRange.location + searchRange.length];
                  return [[tagRangeArray copy] autorelease];
           return nil;

    The method returns nil if no tag or an empty tag is provided.

    Otherwise, it creates a search string tailored to the design of the application's tag list label. Then it searches repeatedly through every tag list in the diary matching that pattern. Using NSString's now-familiar -rangeOfString:options:range: method, it accumulates the ranges of every appearance of the tag in the Chef's Diary's tag lists into the tagRangeArray variable and returns it.

  4. Now write the two supporting methods required by -foundTagRangeArrayForTag:, -firstTagRange, and -nextTagRangeForIndex:.

    In the DiaryDocument.h header file, add these two declarations before the @end directive at the end of the DiaryWindowController class:

    - (NSRange)firstTagRange;
    - (NSRange)nextTagRangeForIndex:(NSUInteger)index;

    In the DiaryDocument.m source file, implement them like this:

    - (NSRange)firstTagRange {
         if ([[self diaryDocTextStorage] length] == 0)
                return NSMakeRange(NSNotFound, 0);
         NSUInteger markerIndex = [[[self diaryDocTextStorage] string]
                rangeOfString:[self tagMarker] options:0
                [[self diaryDocTextStorage] length])].location;
         return [self rangeOfLineFromMarkerIndex:markerIndex];
    - (NSRange)nextTagRangeForIndex:(NSUInteger)index {
         if ([[self diaryDocTextStorage] length] == 0)
                return NSMakeRange(NSNotFound, 0);
         NSUInteger markerIndex = [[[self diaryDocTextStorage] string]
                rangeOfString:[self tagMarker] options:0
                [[self diaryDocTextStorage] length] - index)].location;
         return [self rangeOfLineFromMarkerIndex:markerIndex];

    These are very similar to methods you've already written to return entry title ranges, -firstEntryTitleRange and -nextEntryTitleRangeForIndex:, and they shouldn't require further explanation.

  5. Don't forget to validate the search field. Set this up exactly the way you set up validation for the date picker, except test whether the diary contains any tag lists. Declare and implement the ValidatedDiarySearchField class in DiaryWindowController as a subclass of NSSearchField, declaring that it conforms to the VRValidatedControl protocol. Set this subclass as the search field's class in Interface Builder. Finally, add a clause at the end of the -validateUserInterfaceItem: method, testing for the -findTag: action that you just wrote and checking whether the -firstTagRange is found.

  6. Open the DiaryWindow nib file in Interface Builder. Control-drag from the search field in the diary window to the First Responder proxy in the Diary-Window nib file's window, and then select the findTag: action in the Received Actions section of the HUD. The search field is now connected.

  7. Run the application and test the search field. To start, you have to create a few entries and add tags to them, using the Add Entry and Add Tag buttons. I like to add three entries with these tags: try entering hi ho for the first entry; for the second entry, ho hum; and for the third entry, ho ho ho. Then type ho in the search field. The ho tag in the first entry is highlighted with animation for a moment, and the first instance of the ho tag in each entry remains selected. Press Return several times in succession. All of the ho tags remain selected, but the animated highlight appears on a different entry's ho tag with each press of the Return key. If you spaced out the entries with lines of text, each ho tag in turn scrolls into view before it is highlighted.

  • + Share This
  • 🔖 Save To Your Account

Peachpit Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from Peachpit and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about Peachpit products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites; develop new products and services; conduct educational research; and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by Adobe Press. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive:

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020