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

Capto 1.2.9 - $29.99
Capto (was Voila) is an easy-to-use app that takes capturing, recording, video and image editing to the next level. With an intelligent file manager and quick sharing options, Capto is perfect for... Read more
Opera 51.0.2830.40 - High-performance We...
Opera is a fast and secure browser trusted by millions of users. With the intuitive interface, Speed Dial and visual bookmarks for organizing favorite sites, news feature with fresh, relevant content... Read more
GarageSale 7.0.13 - Create outstanding e...
GarageSale is a slick, full-featured client application for the eBay online auction system. Create and manage your auctions with ease. With GarageSale, you can create, edit, track, and manage... Read more
1Password 6.8.7 - Powerful password mana...
1Password is a password manager that uniquely brings you both security and convenience. It is the only program that provides anti-phishing protection and goes beyond password management by adding Web... Read more
Evernote 7.0.1 - Create searchable notes...
Evernote allows you to easily capture information in any environment using whatever device or platform you find most convenient, and makes this information accessible and searchable at anytime, from... Read more
MacUpdate Desktop 6.2.0 - $20.00
MacUpdate Desktop brings seamless 1-click app installs and version updates to your Mac. With a free MacUpdate account and MacUpdate Desktop 6, Mac users can now install almost any Mac app on... Read more
HoudahSpot 4.3.5 - Advanced file-search...
HoudahSpot is a versatile desktop search tool. Use HoudahSpot to locate hard-to-find files and keep frequently used files within reach. HoudahSpot will immediately feel familiar. It works just the... Read more
EtreCheck 4.0.4 - For troubleshooting yo...
EtreCheck is an app that displays the important details of your system configuration and allow you to copy that information to the Clipboard. It is meant to be used with Apple Support Communities to... Read more
WhatsApp 0.2.8361 - Desktop client for W...
WhatsApp is the desktop client for WhatsApp Messenger, a cross-platform mobile messaging app which allows you to exchange messages without having to pay for SMS. WhatsApp Messenger is available for... Read more
iClock 4.2 - Customize your menubar cloc...
iClock is a menu-bar replacement for Apple's default clock but with 100x features. Have your Apple or Google calendar in the menubar. Have the day, date, and time in different fonts and colors in the... Read more

Latest Forum Discussions

See All

The best games like Florence
Florence is a great little game about relationships that we absolutely adored. The only problem with it is it's over a little too soon. If you want some other games with some emotional range like Florence, check out these suggestions: [Read more] | Read more »
Angry Birds Champions adds cash prizes t...
Collaborating with developer Rovio Entertainment, GSN Games has released a twist on the Angry Birds formula. Angry Birds Champions features the same bird-flinging gameplay, but now you can catapult Red and co for cash. | Read more »
Around the Empire: What have you missed...
148Apps is part of a family. A big family of sites that make sure you're always up to date with all the portable gaming news. Just like a real family, I guess. I don't know, my mum never told me anything about Candy Crush to be fair. [Read more] | Read more »
The Battle of Polytopia Guide - Tips for...
The addition of multiplayer to The Battle of Polytopia has catapulted the game from a fun enough time waster to a fully-fledged 4X experience on your phone. We've been playing quite a few matches over the past week or so, and we've put together a... | Read more »
All the best games on sale for iPhone an...
Hi there, and welcome to our round up of all the best games that are on sale for iOS at the moment. It's not a vintage week in terms of numbers, but I'm pretty sure that every single one of these is worth picking up if you haven't already played... | Read more »
Disc Drivin' 2 Guide - Tips for the...
We're all still playing quite a bit of Disc Drivin' 2 over here at 148Apps, and we've gotten pretty good at it. Now that we've spent some more time with the game and unlocked more powerups, check out some of these more advanced tips: | Read more »
Alto's Odyssey Guide - How to Tackl...
Alto’s Odyssey is a completely stunning and serene runner, but it can also be a bit tricky. Check out these to try and keep your cool while playing this endless runner: Don’t focus too much on tasks [Read more] | Read more »
Here's everything you need to know...
Alto's Odyssey is a really, really good game. If you don't believe me, you should definitely check out our review by clicking this link right here. It takes the ideas from the original Alto's Adventure, then subtly builds on them, creating... | Read more »
Alto's Odyssey (Games)
Alto's Odyssey 1.0.1 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.1 (iTunes) Description: Just beyond the horizon sits a majestic desert, vast and unexplored. Join Alto and his friends and set off on an endless... | Read more »
Vainglory 5v5: Everything you need to kn...
Vainglory just got bigger. [Read more] | Read more »

Price Scanner via MacPrices.net

Apple AirPods in stock today for $159, free s...
Adorama reports stock of Apple AirPods today for $159 including free shipping, plus pay no sales tax outside of NY & NJ. See our Apple AirPod Price Tracker for the latest prices and stock status... Read more
Saturday Sale: Amazon offers 12″ 1.3GHz MacBo...
Amazon has Silver and Gold 2017 12″ 1.3GHz Retina MacBooks on sale for $250 off MSRP. Shipping is free: – 12″ 1.3GHz Silver MacBook: $1349.99 $250 off MSRP – 12″ 1.3GHz Gold MacBook: $1349.99 $250... Read more
Use your Apple Education discount and save up...
Purchase a new Mac using Apple’s Education discount, and take up to $400 off MSRP. All teachers, students, and staff of any educational institution with a .edu email address qualify for the discount... Read more
Apple Canada offers 2017 21″ and 27″ iMacs fo...
 Canadian shoppers can save up to $470 on the purchase of a 2017 current-generation 21″ or 27″ iMac with Certified Refurbished models at Apple Canada. Apple’s refurbished prices are the lowest... Read more
9″ iPads available online at Walmart for $50...
Walmart has 9.7″ Apple iPads on sale for $50 off MSRP for a limited time. Sale prices are for online orders only, in-store prices may vary: – 9″ 32GB iPad: $279.99 $50 off – 9″ 128GB iPad: $379.99 $... Read more
15″ Apple MacBook Pros, Certified Refurbished...
Save $360-$420 on the purchase of a 2017 15″ MacBook Pro with Certified Refurbished models at Apple. Apple’s refurbished prices are the lowest available for each model from any reseller. An standard... Read more
Amazon restocks MacBook Pros with models avai...
Amazon has restocked 15″ and 13″ Apple MacBook Pros with models on sale for up to $251 off MSRP. Shipping is free. Note that stock of some Macs may come and go (and some sell out quickly), so check... Read more
Lowest price of the year: 15″ 2.8GHz Apple Ma...
Amazon has the 2017 Space Gray 15″ 2.8GHz MacBook Pro on sale today for $251 off MSRP. Shipping is free: – 15″ 2.8GHz Touch Bar MacBook Pro Space Gray (MPTR2LL/A): $2148, $251 off MSRP Their price is... Read more
Apple restocks full line of Certified Refurbi...
Apple has restocked a full line of Apple Certified Refurbished 2017 13″ MacBook Pros for $200-$300 off MSRP. A standard Apple one-year warranty is included with each MacBook, and shipping is free.... Read more
Lowest sale price available for 13″ 1.8GHz Ma...
Focus Camera has the 2017 13″ 1.8GHz/128GB Apple MacBook Air on sale today for $829 including free shipping. Their price is $170 off MSRP, and it’s the lowest price available for a current 13″... Read more

Jobs Board

*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Solutions Consultant - Apple (United...
# Apple Solutions Consultant Job Number: 113523441 Orange, CA, California, United States Posted: 21-Feb-2018 Weekly Hours: 40.00 **Job Summary** Are you passionate Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.