TweetFollow Us on Twitter

ObjectWare

Volume Number: 13 (1997)
Issue Number: 6
Column Tag: Openstep

ObjectWare

by Michael Rutman, independent consultant

Selling your technology to developers as a drop-in

What is ObjectWare?

As functionality in different applications start to overlap, many programmers are forced to reinvent existing technology. Most modern word processors have drawing packages built into them, and most modern drawing packages have word processors built into them. Normally, each developer must create both a word processor and a drawing package. With ObjectWare, the philosophy is to create a great word processor object, which can be dropped into any application and then sell it to application developers.

Why is ObjectWare a philosophy rather than a technique? There are many techniques to add technology to an application, ranging from shared libraries to publicly sold source code. ObjectWare differs in the process. If an application is already object oriented, and you can isolate the objects needed to use a technology, then those objects can be easily bundled and resold. Not only can you sell your application to end users, but you can sell your technology to other application developers. Using shared libraries is a technique for doing ObjectWare.

OPENSTEP's support of ObjectWare is done through custom palettes for InterfaceBuilder. A palette is a bundle of object files, interface files, and any other resource that InterfaceBuilder would need to add the technology to an application. Once loaded into InterfaceBuilder, all the functionality of the custom objects are accessable as if NeXT had bundled them into InterfaceBuilder in the first place.

NeXT provides a wonderful tutorial, called CustomPalette.rtfd. I have been assured that this documentation will become available to all Macintosh developers soon. Many of the details, as well as source code, for implementing custom palettes, which are the user interface to an ObjectWare package, are located in that tutorial.

The code in this article is built using NEXTSTEP 3.3 for the development, and all coding is done in Objective-C. OPENSTEP is slightly different, and Rhapsody has not been fully defined as of the writing of this article.

How do I use ObjectWare?

Under OPENSTEP, ObjectWare is easier than ever before. Adding a new technology to your application can be as easy as a double-click and drag and drop. Bundled objects are built with palettes and then can be loaded into InterfaceBuilder. Once loaded into InterfaceBuilder, they can be dragged into your UI just like any existing OPENSTEP object. At that point, there is no difference between adding a button, a graph or any other object to your application. To load the libraries, just drag and drop the library into your project, and it's ready for compilation.

Unfortunately, as a developer you will probably have to write some code. Not always, though, as there are some Objects that just work and require no setup. A graphing object, for example, will probably require some custom code to interact between the user and the application. On the other hand, an ObjectWare package of pretty buttons could be hooked up to your application using InterfaceBuilder without any code changes.

Related to ObjectWare is loadable bundles. Loadable bundles are functionality that can be added to existing applications at run time. Metrowerks and Adobe Plugins are very similar to loadable bundles.

Creating an ObjectWare Palette

ObjectWare under OPENSTEP requires an InterfaceBuilder palette and a library, both of which are created using ProjectBuilder. When ProjectBuilder creates a new project, it will ask for a project type such as palette, bundle, library or application. When creating a palette, ProjectBuilder will create a folder, a nib (InterfaceBuilder file), and some starting source files.

The starting source files ProjectBuilder creates will be enough to load custom objects into InterfaceBuilder. Unlike Constructor on the Macintosh, these objects are more than placeholders. InterfaceBuilder allows user interfaces to be tested without adding any code. An example of this is the Text Object. Many times OPENSTEP's power has been demonstrated by placing a Text Object in a window and testing it from InterfaceBuilder. Without adding a single line of code, the Text Object is able to spell check, word wrap, place tabs, and many other features found only in more powerful text editors. Likewise, any ObjectWare created will be as full-featured from InterfaceBuilder as from any application they are used in.

The starting source files created by ProjectBuilder are mostly complete. If you are adding only View elements, then you need not edit the starting source files. However, to add non-View object you must first associate it with a View object so InterfaceBuilder has a way to represent the object. This requires your overriding the finishInstantiate() method and adding a line of code to associate each non-view object with a custom view. In other words, if there is a non-graphical object, both the non-graphical object and a custom view representing that object must be created. When the developer grabs the custom view and drags it to where it belongs, InterfaceBuilder will create the correct non-view object instead. The view object is required to draw something to provide feedback in InterfaceBuilder.

When the project is created ProjectBuilder creates a default palette to represent your objects in InterfaceBuilder. You must use InterfaceBuilder to modify this palette to populate it with whatever interface elements are necessary for the ObjectWare package. Palettes can contain custom views, menus, windows, or objects with no interface element. Each element must have a subclass of view created and placed in the palette window.

Basic palettes don't require any special code to make them work, but more sophisticated palettes might. For example, your palette might have an Inspector panel where various attributes, such as initial settings, can be set. These attributes should probably be saved as the application is being built. Use of the Inspector and reading and writing attributes require custom code. OPENSTEP provides objects to help perform these tasks. One such object is typed streams, which are an interesting mechanism for saving and restoring objects with disk files.

Typed Streams

Typed streams are a private data format for archiving objects. Each object declares the types in the stream, then writes those types. An object can declare another object, and write that object to the stream. In practice, it is usually easiest to write the document object to a stream, and have the document object's write method declare all other objects. Listing 1 shows sample code that archives some integers and subsidiary objects. One of the powers of typed stream is not having to worry about big endian/little endian issues. Typed streams work correctly with everything but bit fields.

Listing 1:
- read:(NXTypedStream*)stream
{
	[super read:stream];
	NXReadTypes( stream, "ii", &total, &stepSize );
	helperObject = NXReadObject( stream );
	return self;
}

- write:(NXTypedStream*)stream
{
	[super write:stream];
	NXWriteTypes( stream, "ii", &total, &stepSize );
	NXWriteObject( stream, helperObject );
	return self;
}

Typed streams are very easy to implement, but they do have some drawbacks. Each written stream must be read correctly. In the read method, the code has to specify that it is reading integers. If the stream and the code don't match, then the read will raise an exception. Typed streams support versioning, though, and each object can specify that objects version. So, if only one object changes, then that object would up its version number without any changes outside of that object.

Another drawback of typed streams is the lack of random access. Typed streams are meant to be read in their entirety. Each object is created in turn. Deferred loading of part of a document would be difficult.

The final problem I have had with typed streams is lack of portability. Despite OPENSTEP running on Intel, HP, Sun, and now Macintosh hardware, some people still need Windows applications. Some developers also need the file format to be the same across their Windows and OPENSTEP applications. This just isn't going to work.

Inspectors

Most objects will require an inspector to examine and modify attributes of the object in InterfaceBuilder. The inspector code is only used by InterfaceBuilder, but it is still important. There are 4 inspectors for each object, Attribute, Connection, Size, and Help. Default inspectors are provided automatically if custom inspectors are not created. Custom Connection and Help inspectors are rarely used.

Custom palette objects are identified by adding one or more of the following factory methods to the object:

getInspectorClassName
getConnectInspectorClassName
getSizeInspectorClassName
getHelpInspectorClassName

Factory methods are, for all intensive purposes, the same as C++ static methods. There are some differences, but most of those are implementation details. Here, factory methods are used to retrieve global objects.

Each custom inspector object must be added to the palette project. There is no theoretical limit on the number of custom objects that can be placed in a palette of a project, as each custom object identifies which custom objects apply. Likewise, a custom inspector object can inspect multiple objects.

Each custom inspector is an object and a nib file. Interface Builder has a command for creating the nib and object templates. Unlike the palette object, the inspector objects require some code, but not much.

The inspector object inherits from IBInspector, which has outlets for connecting to the inspector. Once these outlets are hooked up, then the object is able to communicate with InterfaceBuilder.

There are four methods that need to be overridden. The first is the init method. The init method is called automatically by InterfaceBuilder and is responsible for loading the nib file. As well as the nib file, the init method can instantiate any helper objects it will require.

The second method required is the wantsButtons method. InterfaceBuilder will call each custom Inspectors wantsButtons to determine if an OK and Revert button are needed. If the inspector is doing live updating, then there is no reason for the OK and Revert buttons to be present. Most objects don't do live updating, but wait for the OK button to be hit.

The last two methods are OK and Revert. These methods are automatically called when the user clicks on the OK and Revert buttons. Both of these methods must access the API created for the custom object to set and retrieve values. InterfaceBuilder saves settings by writing objects into a nib file. When an application loads a nib file, the retrieval method unarchives the objects. In reality, every object displayed in InterfaceBuilder is an instantiation of the object that will appear in the application.

Library

The last step is to distribute the object files for application programmers to use. Unfortunately, the palette is only usable in InterfaceBuilder. Fortunately, the same objects used in the palette can be used in the library.

The best mechanism, but the least used, is to distribute the source code. Of course, every programmer wants to be able to fix bugs in other programmer's libraries, but giving away your source code is rarely used.

If there is only one custom object, then distributing the object file created by gcc will work. The object file can be included in a project without any problems. If there are many objects, then the objects can be linked into a library. ProjectBuilder can create libraries as easily as creating palettes or applications. Each directory can only hold one project, so a second directory will have to be created.

The standard way of creating the libraries is to bundle the objects with any nib files needed. Again, ProjectBuilder can create Bundles automatically. Bundles are a collection of objects and, nib files, and other resources that can either linked in or loaded at run-time. Shipping as a bundle allows applications to load functionality as needed.

Conclusion

With ObjectWare, not only can developers market their technologies for other developers to use, but they can incorporate the latest technologies without re-inventing the them. OPENSTEP's architecture and development tools make bundling technology simple. There is no set source code language, any resources can be included, any call made by an application can be made by the custom objects. Furthermore, developers that are testing their interfaces in InterfaceBuilder using the custom palettes will see the objects live instead of an abstract box that might work once the application is done.

Overall, ObjectWare under OPENSTEP opens possibilities that other platforms have long struggled to achieve.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Boom 2 1.0.1 - System-wide pro audio app...
Boom 2 is a system-wide volume booster and equalizer app that is designed especially for OS X 10.10 Yosemite. It comes with a smart interface, self-calibrates itself according to your Mac, offers... Read more
Apple Security Update 2015-001 - For OS...
Apple Security Update 2015-001 is recommended for all users and improves the security of OS X. For detailed information about the security content of this update, please visit: http://support.apple.... Read more
Drive Genius 4.0.1 - Powerful system uti...
Drive Genius 4 gives you faster performance from your Mac while also protecting it. The award-winning and improved DrivePulse feature alerts you to hard drive issues before they become major problems... Read more
Yosemite Cache Cleaner 9.0.3 - Clear cac...
Yosemite Cache Cleaner is an award-winning general purpose tool for OS X. YCC makes system maintenance simple with an easy point-and-click interface to many OS X functions. Novice and expert users... Read more
xScope 4.1.1 - Onscreen graphic measurem...
xScope is powerful set of tools that are ideal for measuring, inspecting, and testing on-screen graphics and layouts. Its tools float above your desktop windows and can be accessed via a toolbar,... Read more
OS X Yosemite 10.10.2 - Apple's lat...
OS X Yosemite is Apple's newest operating system for Mac. An elegant design that feels entirely fresh, yet inherently familiar. The apps you use every day, enhanced with new features. And a... Read more
Apple iOS 8.1.3 - The latest version of...
The latest version of iOS can be downloaded through iTunes. Apple iOS 8 comes with big updates to apps you use every day, like Messages and Photos. A whole new way to share content with your family.... Read more
SpamSieve 2.9.19 - Robust spam filter fo...
SpamSieve is a robust spam filter for major email clients that uses powerful Bayesian spam filtering. SpamSieve understands what your spam looks like in order to block it all, but also learns what... Read more
RapidWeaver 6.0.5 - Create template-base...
RapidWeaver is a next-generation Web design application to help you easily create professional-looking Web sites in minutes. No knowledge of complex code is required, RapidWeaver will take care of... Read more
Duet 1.2.2 - Use your iPad as an externa...
Duet is the first app that allows you to use your iDevice as an extra display for your Mac using the Lightning or 30-pin cable. Note: This app requires a $14.99 iOS companion app. Version 1.2.2:... Read more

Storm & Skye – Magical Adventure Sto...
Storm & Skye – Magical Adventure Story For Kids Review By Amy Solomon on January 28th, 2015 Our Rating: iPhone App - Designed for the iPhone, compatible with the iPad The first book in the Storm & Skye series includes... | Read more »
New WOTA: U-Boat Compass ‘Wets’ Your App...
New WOTA: U-Boat Compass ‘Wets’ Your Appetite for WOTA: Wolves of the Atlantic. Posted by Jessica Fisher on January 27th, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Warship Solitaire Review
Warship Solitaire Review By Nadia Oxford on January 27th, 2015 Our Rating: :: A WAR OF NUMBERSUniversal App - Designed for iPhone and iPad Warship Solitaire might lack frills and looks, but it offers some thought provoking... | Read more »
Keep Track of Your Hectic Work Schedule...
Keep Track of Your Hectic Work Schedule With Shifts Posted by Jessica Fisher on January 27th, 2015 [ permalink ] iPhone App - Designed for the iPhone, compatible with the iPad | Read more »
All Star Quarterback Review
All Star Quarterback Review By Campbell Bird on January 27th, 2015 Our Rating: :: PLAY YOUR PARTUniversal App - Designed for iPhone and iPad Train your way to the Super Bowl in this free-to-play sports management game.   | Read more »
Sentinel 4: Dark Star Adds New Campaign...
Sentinel 4: Dark Star Adds New Campaign and More Posted by Ellis Spice on January 27th, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Wheel & Deal Review
Wheel & Deal Review By Tre Lawrence on January 27th, 2015 Our Rating: :: SIMPLE FUNUniversal App - Designed for iPhone and iPad A simple arcade shooter that has a retro feel.   | Read more »
Join the NAVY in a Big New Update for WW...
Join the NAVY in a Big New Update for WW2: Sandbox. Strategy & Tactics Posted by Jessica Fisher on January 27th, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Earthworm Alchemy Review
Earthworm Alchemy Review By Campbell Bird on January 27th, 2015 Our Rating: :: FEED THE WORMUniversal App - Designed for iPhone and iPad Feed this funny looking worm and dodge bombs in this charming, free-to-play arcade game.   | Read more »
Graphic Novel App netwars – The Butterfl...
Graphic Novel App netwars – The Butterfly Attack has Received Some New Episodes Posted by Jessica Fisher on January 27th, 2015 [ permalink ] | Read more »

Price Scanner via MacPrices.net

New Good Management Suite Simplifies Enterpri...
Good Technology has announced the availability of the Good Management Suite, a comprehensive cross-platform solution for organizations getting started with mobile business initiatives. Built on the... Read more
15-inch 2.0GHz Retina MacBook Pro (refurbishe...
The Apple Store has Apple Certified Refurbished previous-generation 15″ 2.0GHz Retina MacBook Pros available for $1489 including free shipping plus Apple’s standard one-year warranty. Their price is... Read more
15-inch 2.5GHz Retina MacBook Pro on sale for...
Amazon has the 15″ 2.5GHz Retina MacBook Pro on sale for $2319.99 including free shipping. Their price is $180 off MSRP, and it’s the lowest price available for this model from any reseller. Read more
iPad Turns Five – The ”Book Mystique
Five years ago this week, the late Steve Jobs took the stage at an Apple special press event to unveil the first Apple iPad — a slab-shaped, hand-holdable device that was to shake the personal... Read more
Sale! 15-inch Retina MacBook Pros for up to $...
B&H Photo has the new 2014 15″ Retina MacBook Pros on sale for $150 off MSRP for a limited time. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $1889.99... Read more
Apple refurbished Mac minis for up to $150 of...
The Apple Store has restocked Apple Certified Refurbished 2014 Mac minis, with models available starting at $419. Apple’s one-year warranty is included with each mini, and shipping is free: - 1.4GHz... Read more
Apple Releases New Tranche Of OS Updates For...
Apple has released incremental bugfix and security updates for its most recent Mac and iOS versions. OS X Yosemite 10.10.2 Update Apple says this update includes the following improvements: Resolves... Read more
Samsung To Be Main Supplier Of A9 Chips For i...
Korea’s Maeil Business Newspaper reports that Samsung has beat out its chipmaking rivals, Taiwan’s Qualcomm and TSMC, as supplier of chipsets for the next generations of both its own Galaxy S6 and... Read more
Save up to $340 on iMacs with Apple Certified...
The Apple Store has Apple Certified Refurbished iMacs available for up to $340 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free. These are the best prices on... Read more
AppleCare Protection Plans on sale for up to...
B&H Photo has 3-Year AppleCare Warranties on sale for up to $105 off MSRP including free shipping plus NY sales tax only: - Mac Laptops 15″ and Above: $244 $105 off MSRP - Mac Laptops 13″ and... Read more

Jobs Board

*Apple* Solutions Consultant - Retail Sales...
As an ambassador of the Apple brand, the ASC is accountable for driving sales performance by: Connecting with customers. Discovering customers' needs and values. Showing Read more
*Apple* Solutions Consultant - Retail Sales...
As an ambassador of the Apple brand, the ASC is accountable for driving sales performance by: Connecting with customers. Discovering customers' needs and values. Showing Read more
*Apple* Tree Children's Center is hirin...
Apple Tree Learning Center is Hiring Preschool Teachers! Phoenix Childrens Academy is a national leader in the early childhood education industry and we are currently Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
*Apple* Solutions Consultant - Retail Sales...
As an ambassador of the Apple brand, the ASC is accountable for driving sales performance by: Connecting with customers. Discovering customers' needs and values. Showing Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.