TweetFollow Us on Twitter

Introduction To AppleScript Studio

Volume Number: 21 (2005)
Issue Number: 4
Column Tag: Programming

AppleScript Essentials

by Benjamin S. Waldie

Introduction To AppleScript Studio

In past articles, we have discussed many AppleScript-related topics. However, one of the topics that we have yet to touch on is AppleScript Studio, which is quickly becoming the tool of choice for AppleScript developers.

What Is AppleScript Studio

AppleScript Studio, contrary to what some of you may think, is not an application itself. Rather, it is the AppleScript development environment that is part of the Mac OS X developer tools.


Figure 1. The Interface Builder and Xcode Applications

The two main developer tools that AppleScript developers need to be concerned with in order to get started with AppleScript Studio are Interface Builder and Xcode. If you don't have these applications on your machine, you need to install the Mac OS X developer tools, which you should have gotten along with your Mac OS X system software.

Interface Builder, as the name implies, is what you may use to build interfaces for your scripts. Your interfaces may range from the very simple, to the extremely complex, depending on your programming skill, and the requirements of the task you want to automate. When building an interface in Interface Builder, you will have access to most of the standard interface elements that you see in Mac OS X, allowing you to design your interface with the look and feel of a regular application.

Xcode is the application in which you will write your AppleScript code, and link it to the objects in your interface. Xcode is not for the faint of heart. It is a real, live, professional development environment, and it has a learning curve. However, during this article, we will get started with some basics by creating a very simple AppleScript Studio application. Then, I'll make some suggestions for next steps in the learning process, and in future articles, we'll return to AppleScript Studio to discuss additional topics.

Building a Simple AppleScript Studio Application

For this initial project, we are going to build a fairly basic AppleScript Studio application, complete with an interface. This particular script will be used to select a random number that falls between two user-specified numbers.

Step 1 - Prepare Your Project

First, launch the Xcode application. Depending on whether or not you have launched Xcode before, you may see an initial dialog. Go ahead and dismiss any dialogs that may appear. Next, select New Project from the File menu, and you will be presented with a list of templates from which to choose. In the list, under Application, you will notice that there are a few types of templates with the word AppleScript in the name. In order to develop an AppleScript Studio application, you will want to select one of these. For this initial project, select AppleScript Application, and click the Next button.

The next interface will allow you to specify a name for your project, as well as a location. Enter the name Number Picker, specify a location, and click the Next button. At this time, Xcode will create your project in the specified location, and open the project in an interface window. Depending on the way your Xcode application has been configured, your window may look similar to figure 2.


Figure 2. An Xcode Project Window

An Xcode project contains a variety of components. However, at this initial stage, we are only going to be concerned about the following two:

    Number Picker.applescript - This file, located under the Scripts folder in your project, is your main AppleScript file. Here, you will write the AppleScript code we will be linking to your interface.

    MainMenu.nib - This file, located under the Resources folder in your project, is your interface file. This is where you will design your interface.

Step 2 - Design Your Interface

For this particular project, the next thing we are going to do is build our interface. To begin editing the project's interface, double click on the MainMenu.nib file in Xcode. This should automatically launch Interface Builder, and load the interface. If all goes well, you should see a MainMenu.nib window in Interface Builder, as well as a blank window titled Window. Click on the blank window.

Depending on the way your Interface Builder application is configured, you may or may not see an Info palette. To make this window visible, select Show Info from the Tools menu in the menu bar. If not already selected, choose Attributes from the popup menu at the top of the Info palette. Enter the text Number Picker into the Window Title field in the Info palette.


Figure 3. The Info Palette

Now, it is time to begin adding some interface elements to the window. Depending on the way your Interface Builder application is configured, you may or may not see a palette of interface elements. If this palette is not visible, you can make it visible by selecting Show Palettes from the Tools > Show Palettes menu in the menu bar.


Figure 4. The Interface Builder Object Palette

If you have never worked with Interface Builder before, you may want to browse through the various interface elements under each toolbar button in this palette. This should give you some idea of the types of interfaces you will be able to build in the future.

    NOTE: Holding your mouse over a toolbar button in the interface elements palette will display a tool tip identifying the category of objects associated with the button. Likewise, holding your mouse over an interface object in the palette will display its name.

For this interface, we're going to add only a few basic elements to our Number Picker window. We'll start by adding two text fields. To do this, click on the Cocoa Text Controls button, and select and drag the NSTextField object from the upper left of the palette into your window. Do this again, and you should have two text fields on your window.


Figure 5. Text Fields Added to an Interface Window

Next, select the NSTextField object labeled System Font Text, located in the lower right of the palette, and drag it twice into your window. Double click on each of these text fields that you have added to your window, and set their text to Starting Number and Ending Number.

Select the Cocoa Controls and Indicators button in the toolbar of the interface elements palette, select the NSButton object in the upper left corner of the palette, and drag it into your window. Double click on the button that has been added to the window, and change its name to Pick.

At this point, you may drag the various elements around the window until they are in the desired location. Notice as you drag elements around the window, that Interface Builder will display dashed lines suggesting proper placement of the objects, in relationship to other objects on the window. Try to arrange your interface similar to the one displayed in figure 6.


Figure 6. Interface Window Design

Step 3 - Add AppleScript Names to Inte face Objects

In order for the AppleScript code we are about to write to interact with the objects in our interface, we will first need to assign names to these objects. Sure, we could interact with objects by their index reference, such as text field 1 of window 1. However, when you start getting lots of interface elements, it becomes difficult to keep track of which objects are which. To assign a name to an object, first, select the object. Next, select AppleScript from the popup menu in the Info palette. You may then enter the desired name for the object into the Name field in the Info palette. For our interface, assign the name Main Window to the window. Next, assign the names Starting Number and Ending Number to the two empty text fields. Finally, assign the name Pick Number to the button in the window.

Step 4 - Link Interface Objects to AppleScript Code

Since we would like AppleScript code to trigger when we click the Pick button in our interface, we now need to link the button to our script. To do this, select the Pick button in the interface. Next, select AppleScript from the popup menu in the Info palette. You may have noticed already that when you have selected AppleScript from this popup menu, various event handlers appear below the Name field in the Info palette. These event handlers are actions that may be configured to cause the corresponding object to trigger specific AppleScript code. For example, for a button, the clicked event handler would cause the button to trigger AppleScript code whenever it is clicked by a user. Select the checkbox next to the clicked option.

Once you have selected the clicked event handler, you need to specify which AppleScript file to which the event handler will link. In this case, we only have one AppleScript file. However, for complex projects, we may have multiple files from which to choose. To specify our AppleScript file, select the checkbox next to Number Picker.applescript under Script at the bottom of the Info palette.


Figure 7. The Properly Configured Info Window for the Pick Button

Step 5 - Adding AppleScript Code

Now that we have created our interface, and linked the interface elements to our AppleScript file, it is time to begin editing our AppleScript code. Since we have configured our interface to trigger code when a user clicks the Pick button, we are going to edit the code that will trigger when this action occurs. To get started, ensure that the Pick button is still selected, and click the Edit Script button at the bottom of the Info palette. This should bring Xcode back to the front, and display the Number Picker.applescript script. You should notice that the script already contains some initial AppleScript code.

The first thing that we need to do is get the values entered by the user into the Starting Number and Ending Number fields in our interface. Next, we are going to want to select a number in between those two numbers.

tell window "Main Window"
   set theStartingNumber to contents of text field "Starting Number"
   set theEndingNumber to contents of text field "Ending Number"
   set theNumberList to {}
   repeat with i from theStartingNumber to theEndingNumber
      set end of theNumberList to i
   end repeat
   display dialog "And the number is... " & some item of theNumberList
end tell

Add the above code to the on clicked theObject event handler in your script.


Figure 8. AppleScript Code in the Xcode Script

Step 6 - Building and Testing the Project

Now that we have added our AppleScript code, it's time to build and test our project. To do this, click the Build and Go button in the toolbar of your Xcode window. If all goes well, your application should build and launch. Test the application by entering a starting number and an ending number, and then click the Pick button.


Figure 9. Our Completed Application

Step 7 - Expand Your Application

Obviously, the example application we created during this article is very simple, to say the least. In a real-world solution, you would want to add much more functionality. For example, we did not add any kind of protection to ensure that a user actually enters a number into the Starting Number and Ending Number text fields. Right now, a user could enter text, and the solution would produce an error.

There are many other things you could do to make this solution more robust, and I encourage you to explore ways that you can expand and enhance it. I also invite you to download an application that I created and released as a freeware tool. My application, titled Ticket Picker, was the basis for this exercise. I created the application to distribute to Macintosh User Groups for use during raffles and drawings. You can download the application from the Freeware Products section of my website at http://www.automatedworkflows.com.

Next Steps

So, where do you go from here? Well, as I mentioned before, AppleScript Studio has a lot to learn. However, there are some good resources that can help you in your journey. For one, when you install the Mac OS X developer tools, Apple provides numerous AppleScript Studio examples. These examples are completely unlocked and fully editable, and I encourage you to explore them. They can be found in the Developer > Examples > AppleScript Studio folder. Additional example scripts can be found on the AppleScript website at http://www.apple.com/applescript/studio/.

Another good way to learn about AppleScript Studio is to look over the extensive documentation provided by Apple. For the most up to date documentation, visit http://developer.apple.com/documentation/AppleScript/.

I've said it before, and I'll say it again. One of the best resources for learning about AppleScript is the growing community of developers. If you are interested in learning AppleScript Studio, you should consider joining the AppleScript Studio Mailing List, hosted by Apple at http://lists.apple.com/mailman/listinfo/applescript-studio. The thousands of developers who currently subscribe to this list will no doubt be a valuable resource as you get started.

In Closing

As the title of this article indicates, this article is by no means meant to serve as a comprehensive tutorial on AppleScript Studio. It is simply meant to serve as an introduction, and to show how it is not too complicated to begin putting together your own applications with interfaces. Of course, creating more complex applications in AppleScript Studio requires some hard work and dedication. However, with a little practice, you will be on your way in no time. In future articles, we'll delve deeper into the AppleScript Studio world, and explore some more exciting things that you can do.

Until next time, keep scripting!


Benjamin Waldie is president of Automated Workflows, LLC, a firm specializing in AppleScript and workflow automation consulting. In addition to his role as a consultant, Benjamin is an evangelist of AppleScript, and can frequently be seen presenting at Macintosh User Groups, Seybold Seminars, and MacWorld. For additional information about Benjamin, please visit http://www.automatedworkflows.com, or email Benjamin at applescriptguru@mac.com.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Fantastical 2.4.1 - Create calendar even...
Fantastical 2 is the Mac calendar you'll actually enjoy using. Creating an event with Fantastical is quick, easy, and fun: Open Fantastical with a single click or keystroke Type in your event... Read more
Live Home 3D Pro 3.2.2 - $69.99
Live Home 3D Pro, a successor of Live Interior 3D, is the powerful yet intuitive home design software that lets you build the house of your dreams right on your Mac. It has every feature of Live Home... Read more
Live Home 3D Pro 3.2.2 - $69.99
Live Home 3D Pro, a successor of Live Interior 3D, is the powerful yet intuitive home design software that lets you build the house of your dreams right on your Mac. It has every feature of Live Home... Read more
FileZilla 3.27.0.1 - Fast and reliable F...
FileZilla (ported from Windows) is a fast and reliable FTP client and server with lots of useful features and an intuitive interface. Version 3.27.0.1: MSW: Add misssing file to .zip binary package... Read more
Spotify 1.0.59.395. - Stream music, crea...
Spotify is a streaming music service that gives you on-demand access to millions of songs. Whether you like driving rock, silky R&B, or grandiose classical music, Spotify's massive catalogue puts... Read more
Sierra Cache Cleaner 11.0.6 - Clear cach...
Sierra Cache Cleaner is an award-winning general purpose tool for macOS X. SCC makes system maintenance simple with an easy point-and-click interface to many macOS X functions. Novice and expert... Read more
DiskCatalogMaker 7.1.2 - Catalog your di...
DiskCatalogMaker is a simple disk management tool which catalogs disks. Simple, light-weight, and fast Finder-like intuitive look and feel Super-fast search algorithm Can compress catalog data for... Read more
Live Home 3D Pro 3.1.2 - $69.99
Live Home 3D Pro, a successor of Live Interior 3D, is the powerful yet intuitive home design software that lets you build the house of your dreams right on your Mac. It has every feature of Live Home... Read more
Deeper 2.2.1 - Enable hidden features in...
Deeper is a personalization utility for macOS which allows you to enable and disable the hidden functions of the Finder, Dock, QuickTime, Safari, iTunes, login window, Spotlight, and many of Apple's... Read more
Pinegrow 3.04 - Mockup and design webpag...
Pinegrow (was Pinegrow Web Designer) is desktop app that lets you mockup and design webpages faster with multi-page editing, CSS and LESS styling, and smart components for Bootstrap, Foundation,... Read more

Latest Forum Discussions

See All

The best deals on the App Store this wee...
There are quite a few truly superb games on sale on the App Store this week. If you haven't played some of these, many of which are true classics, now's the time to jump on the bandwagon. Here are the deals you need to know about. [Read more] | Read more »
Realpolitiks Mobile (Games)
Realpolitiks Mobile 1.0 Device: iOS Universal Category: Games Price: $5.99, Version: 1.0 (iTunes) Description: PLEASE NOTE: The game might not work properly on discontinued 1GB of RAM devices (iPhone 5s, iPhone 6, iPhone 6 Plus, iPad... | Read more »
Layton’s Mystery Journey (Games)
Layton’s Mystery Journey 1.0.0 Device: iOS Universal Category: Games Price: $15.99, Version: 1.0.0 (iTunes) Description: THE MUCH-LOVED LAYTON SERIES IS BACK WITH A 10TH ANNIVERSARY INSTALLMENT! Developed by LEVEL-5, LAYTON’S... | Read more »
Full Throttle Remastered (Games)
Full Throttle Remastered 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Originally released by LucasArts in 1995, Full Throttle is a classic graphic adventure game from industry legend Tim... | Read more »
Stunning shooter Morphite gets a new tra...
Morphite is officially landing on iOS in September. The game looks like the space shooter we've been needing on mobile, and we're going to see if it fits the bill quite shortly. The game's a collaborative effort between Blowfish Studios, We're Five... | Read more »
Layton's Mystery Journey arrives to...
As you might recall, Layton's Mystery Journey is headed to iOS and Android -- tomorrow! To celebrate the impending launch, Level-5's released a new trailer, complete with an adorable hamster. [Read more] | Read more »
Sidewords (Games)
Sidewords 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Grab a cup of coffee and relax with Sidewords. Sidewords is part logic puzzle, part word game, all original. No timers. No... | Read more »
Noodlecake Games' 'Leap On!...
Noodlecake Games is always good for some light-hearted arcade fun, and its latest project, Leap On! could carry on that tradition. It's a bit like high stakes tetherball in a way. Your job is to guide a cute little blob around a series of floating... | Read more »
RuneScape goes mobile later this year
Yes, RuneScape still exists. In fact, it's coming to iOS and Android in just a few short months. Jagex, creators of the hit fantasy MMORPG of yesteryear, is releasing RuneScape Mobile and Old School RuneScape for mobile devices, complete with... | Read more »
Crash of Cars wants you to capture the c...
Crash of Cars is going full on medieval in its latest update, introducing castles and all manner of new cars and skins fresh from the Dark Ages. The update introduces a new castle-themed map (complete with catapults) and a gladiator-style battle... | Read more »

Price Scanner via MacPrices.net

13″ 2.3GHz/128GB Space Gray MacBook Pro on sa...
MacMall has the 13″ 2.3GHz/128GB Space Gray MacBook Pro (MPXQ2LL/A) on sale for $1219 including free shipping. Their price is $80 off MSRP. Read more
Clearance 2016 12-inch Retina MacBooks, Apple...
Apple recently dropped prices on Certified Refurbished 2016 12″ Retina MacBooks, with models now available starting at $1019. Apple will include a standard one-year warranty with each MacBook, and... Read more
Save or Share
FotoJet Designer, is a simple but powerful new graphic design apps available on both Mac and Windows. With FotoJet Designer’s 900+ templates, thousands of resources, and powerful editing tools you... Read more
Logo Maker Shop iOS App Lets Businesses Get C...
A newly released app is designed to help business owners to get creative with their branding by designing their own logos. With more than 1,000 editable templates, Logo Maker Shop 1.0 provides the... Read more
Sale! New 15-inch MacBook Pros for up to $150...
Amazon has the new 2017 15″ MacBook Pros on sale for up to $150 off MSRP including free shipping: – 15″ 2.8GHz MacBook Pro Space Gray: $2249 $150 off MSRP – 15″ 2.89Hz MacBook Pro Space Gray: $2779 $... Read more
DEVONthink To Go 2.1.7 For iOS Brings Usabili...
DEVONtechnologies has updated DEVONthink To Go, the iOS companion to DEVONthink for Mac, with enhancements and bug fixes. Version 2.1.7 adds an option to clear the Global Inbox and makes the grid... Read more
15-inch 2.2GHz Retina MacBook Pro, Apple refu...
Apple has Certified Refurbished 2015 15″ 2.2GHz Retina MacBook Pros available for $1699. That’s $300 off MSRP, and it’s the lowest price available for a 15″ MacBook Pro. An Apple one-year warranty is... Read more
13-inch 2.3GHz Silver MacBook Pro on sale for...
B&H Photo has the new 2017 13″ 2.3GHz/256GB Silver MacBook Pro (MPXU2LL/A) on sale for $1399 including free shipping plus NY & NJ sales tax only. Their price is $100 off MSRP. Read more
Apple Tackles Distracted Driving With iOS 11...
One of the most important new features coming in iOS 11 is Do Not Disturb while driving, intended to help drivers stay more focused on the road. With Do Not Disturb while driving, your iPhone can... Read more
iMazing Mini for Mac: Free Automatic and Priv...
Geneva, Switzerland-based indie developer DigiDNA has released iMazing Mini, their free macOS utility designed to automatically back up iOS devices over any local Wi-Fi network. The app offers users... Read more

Jobs Board

Frameworks Engineering Manager, *Apple* Wat...
Frameworks Engineering Manager, Apple Watch Job Number: 41632321 Santa Clara Valley, California, United States Posted: Jun. 15, 2017 Weekly Hours: 40.00 Job Summary Read more
Product Manager - *Apple* Pay on the *Appl...
Job Summary Apple is looking for a talented product manager to drive the expansion of Apple Pay on the Apple Online Store. This position includes a unique Read more
*Apple* Retail - Multiple Positions - Apple...
SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions - Apple...
SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
Senior Payments Architect - *Apple* Pay - A...
Changing the world is all in a day's work at Apple . If you love innovation, here's your chance to make a career of it. You'll work hard. But the job comes with more Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.