TweetFollow Us on Twitter

The LayerGroup

Volume Number: 15 (1999)
Issue Number: 4
Column Tag: Programming Techniques

The LayerGroup

by Spec Bowers

A very simple, flexible and useful widget

Introduction

This article describes a very useful widget which I call a "LayerGroup." The name is derived from the Layers that many drawing programs provide, and from a RadioGroup. A LayerGroup contains and controls multiple Layers, only one of which is visible at a time. Each layer in turn can contain other controls. When a layer is made visible all of its embedded controls become visible, When a layer is hidden all of its embedded controls are hidden. The effect of hiding one layer and showing another layer is to swap in and out a set of controls.

What makes a LayerGroup so useful is that it encapsulates behavior that appears in a great many applications. The appearance varies from one application to another but the behavior is the same: the set of available controls is swapped in and out. Using a LayerGroup makes it very easy to implement this kind of behavior without reinventing the wheel.

What makes a LayerGroup so flexible is that it implements only the behavior, not the visible appearance. The appearance is determined by a control external to the LayerGroup. That control can be anything that produces an integer, such as a TabControl, a Popup, or a Listbox. Figure 1 and the example application show several kinds of LayerGroup.


Figure 1. Three kinds of LayerGroups.

These LayerGroups all look different but the implementations are essentially the same. The Tab Panel is a TabControl with a nested LayerGroup. The group in turn contains three layers, each with its own set of controls. The Tab Control produces a 1, 2, or 3. That integer is passed to the LayerGroup which shows that one layer. Similarly, the Popup Group Box has a nested LayerGroup. The value of the Popup is passed to the LayerGroup. For the Listbox example, the LayerGroup is not nested but the implementation is otherwise the same: selecting a row causes the row number to be passed to the LayerGroup.

The example application has a fourth LayerGroup which is controlled by a set of edit fields. The item number of whichever edit field is active is used to control the LayerGroup. The effect is that tabbing to or clicking an edit field causes the LayerGroup to display picture and text describing what to enter into that edit field.

In these examples the content of each layer is just one or two items but there could be any number of items. Real applications might have a dozen or more items in each layer. The LayerGroup controls the layers; each layer controls the items in that layer.

The LayerGroup behavior can be seen in many real-life applications. Most likely, the various programmers had to write special-purpose code for each application. The only reusable code I have seen along these lines is in Apple's sample code for the AppsToGo framework, <http://developer.apple.com/dev/techsupport/source/AppsToGo.html>. That code, written prior to the Appearance Manager, is quite complex. With Appearance, the code is simple.

The Code

We implemented LayerGroups going straight to Apple's Appearance toolbox and separately for PowerPlant. It would be very easy to implement it for any other class library that supports nested views and hiding and showing. (I am told that the Windows MFC library has such primitive support for nesting that implementing this LayerGroup is complicated.)

//-----
void   SetLayerGroupValue (
   ControlHandle   inControl,
   SInt16      inValue)   // 1-based
{
   SInt16      numLayers = 0;
   SInt16      i;
   ControlHandle   layer;

   CountSubControls (inControl, &numLayers);
   for (i = 1; i <= numLayers; i++) {
      GetIndexedSubControl (inControl, i, &layer);
      if (i == inValue) {
         ActivateControl (layer);
         ShowControl (layer);
      } else {
         HideControl (layer);
         DeactivateControl (layer);
      }
   } // for
   Draw1Control (inControl);
}

That's all it takes to implement a LayerGroup. The code is this simple because the Appearance Manager supports embedded controls. Layers are embedded within the LayerGroup; items are embedded within layers.

The LayerGroup and the layers are vanilla User Pane controls with no visible appearance of their own. We did not write any code for a layer. The Appearance Manager does all the work. When a layer is hidden or shown the Appearance Manager hides or shows whatever controls are embedded in that layer.

The ActivateControl and DeactivateControl calls we added to work around what is probably a minor bug in the Appearance Manager. When an active edit text control was in a hidden layer we saw a blinking insertion point even though the edit text was hidden. The cure is to deactivate a layer. That deactivates the embedded controls.

For PowerPlant, the code is very similar. The layer group is a very simple subclass of LView. The layers are ordinary LViews. Like Appearance (for quite some time prior to Appearance) PowerPlant supports nested items. Hiding (or showing) an LView hides (or shows) all the items nested within the LView. All that CLayerGroup needs is a SetValue member function that is much like the SetLayerGroupValue when using Appearance.

Making a LayerGroup

It is very easy to create a LayerGroup:

  • Make a LayerGroup control.
  • Make Layers nested within the LayerGroup.
  • For each Layer, make whatever nested items you want.

You could create these controls programatically but obviously the preferred way is to create the controls from resources. For Appearance, dialogs use DITL and CNTL resources. The location and size of controls implies the nesting order. (To nest a control, specify coordinates that are completely within a preceding item.) CNTL resources are also used for windows but you have to write code to create each control and to specify how the controls are embedded. For PowerPlant, both windows and dialogs are created from PPob resources.

For a Dialog Using Appearance

Create DITL and CNTL resources. The LayerGroup and Layers are User Pane controls (procID 256) with Initial Value 2 to specify that the control supports embedding.

In your code, create the dialog via GetNewDialog:

      mDialog = GetNewDialog (inResID, nil, (WindowPtr) -1L);

For convenience later, get a ControlHandle for the LayerGroup:

      GetDialogItemAsControl (mDialog, kLayerGroup,
                                          &mLayerGroupHandle);

Respond to a hit in the controlling item (e.g. the TabControl, Popup, or Listbox) by changing the LayerGroup's value:

      choice = GetControlValue (mControllerHandle);
      SetLayerGroupValue (mLayerGroupHandle, choice);

For a Window Using Appearance

Create CNTL resources. The LayerGroup and Layers are User Pane controls (procID 256) with Initial Value 2 to specify that the control supports embedding. In your code, create each control by GetNewControl, then EmbedControl:

      mLayer1Handle = GetNewControl (CNTL_Layer1, window);
      EmbedControl (mLayer1Handle, mLayerGroupHandle);

Respond to a click in the controlling item (e.g. the TabControl, Popup, or Listbox) by changing the LayerGroup's value:

      LGetSelect (true, &selectedCell, list);
      layer = selectedCell.v + 1;      // layers are 1-based
      SetLayerGroupValue (mLayerGroupHandle, layer);

The Appearance SDK provides an FKEY for creating a dump of the control hierarchy. This is what the Listbox example looks like:

Root pane
   Control pane (Scroll Bars)
   Control pane (List Box)
   Control pane (User Pane) - LayerGroup
      Control pane (User Pane) - Layer one
         Control pane (Push Buttons)
         Control pane (Static Text)
      Control pane (User Pane) - Layer two
         Control pane (Group Box)
            Control pane (Radio Group)
               Control pane (Push Buttons)
               Control pane (Push Buttons)
      Control pane (User Pane) - Layer three
         Control pane (Static Text)
         Control pane (Edit Text)
      Control pane (User Pane) - Layer four
         Control pane (Popup Button)

For PowerPlant

Create PPob resources. The LayerGroup's classID is 'LGrp'. (A custom CTYP resource for Constructor is with the source code.) Each layer is an LView (classID 'view').

In your code, register the LayerGroup and LView classes:

      RegisterClass_(CLayerGroup);
      RegisterClass_(LView);

For convenience later, get a pointer to the LayerGroup:

      mLayerGroup = (CLayerGroup*) FindPaneByID ('XXXX');

In the ListenToMessage method respond to a hit in the controlling item (e.g. the TabControl, Popup, or Listbox) by changing the LayerGroup's value:

      case msgTabs:
         mLayerGroup->SetValue (mTabControl->GetValue ());

Variations

A simple variation is to create only two layers with the first one empty. When controlled by a checkbox the effect would be to hide or show a set of controls.

For PowerPlant, we implemented a variation which uses a pane ID instead of an ordinal number. It finds and shows the layer with the matching pane ID. We also specified a particular pane ID as a default, a layer to be shown if no other layers match the requested pane ID.

If there are many layers and/or many items within layers and if running on a slowish machine, the cost to create all of the layers with all of their items might be noticeable. A performance enhancement would be to defer creating the items within a layer until that layer is first made visible. If the user happens not to show some layers then there would be no time spent making the items within those layers.

A Plug

These examples were created using AppMaker, which generated both the resources and the source code. Whether you use AppMaker or you do it by hand, I think you will find that the LayerGroup is a useful widget to have in your toolbox.


Spec Bowers is the founder, cook, and chief bottle washer at Bowers Development. He has been developing programming tools for most of his career. You can contact him at bowersdev@aol.com or see the web page at http://members.aol.com/bowersdev.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Lyn 1.5.11 - Lightweight image browser a...
Lyn is a lightweight and fast image browser and viewer designed for photographers, graphic artists and Web designers. Featuring an extremely versatile and aesthetically pleasing interface, it... Read more
NeoOffice 2014.11 - Mac-tailored, OpenOf...
NeoOffice is a complete office suite for OS X. With NeoOffice, users can view, edit, and save OpenOffice documents, PDF files, and most Microsoft Word, Excel, and PowerPoint documents. NeoOffice 3.x... Read more
LaunchBar 6.4 - Powerful file/URL/email...
LaunchBar is an award-winning productivity utility that offers an amazingly intuitive and efficient way to search and access any kind of information stored on your computer or on the Web. It provides... Read more
Remotix 3.1.4 - Access all your computer...
Remotix is a fast and powerful application to easily access multiple Macs (and PCs) from your own Mac. Features Complete Apple Screen Sharing support - including Mac OS X login, clipboard... Read more
DesktopLyrics 2.6.6 - Displays current i...
DesktopLyrics is an application that displays the lyrics of the song currently playing in "iTunes" right on your desktop. The lyrics for the song have to be set in iTunes; DesktopLyrics does nothing... Read more
VOX 2.5.1 - Music player that supports m...
VOX is a beautiful music player that supports many filetypes. The beauty is in its simplicity, yet behind the minimal exterior lies a powerful music player with a ton of features and support for all... Read more
NetNewsWire 4.0.0 - RSS and Atom news re...
NetNewsWire is the best way to keep up with the sites and authors you read most regularly. Let NetNewsWire pull down the latest articles, and read them in a distraction-free and Mac-like way. Native... Read more
MacUpdate Desktop 6.0.6 - Search and ins...
MacUpdate Desktop 6 brings seamless 1-click 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 macupdate.... Read more
ForkLift 2.6.5 - Powerful file manager:...
ForkLift is a powerful file manager and ferociously fast FTP client clothed in a clean and versatile UI that offers the combination of absolute simplicity and raw power expected from a well-executed... Read more
Drive Genius 4.1.0 - 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

Auroch Digital is Bringing Back Games Wo...
| Read more »
Carbo - Handwriting in the Digital Age...
Carbo - Handwriting in the Digital Age 1.0 Device: iOS Universal Category: Productivity Price: $3.99, Version: 1.0 (iTunes) Description: | Read more »
Draggy Dead (Games)
Draggy Dead 1.1 Device: iOS Universal Category: Games Price: $.99, Version: 1.1 (iTunes) Description: Ditch your dead end job and take up a rewarding career in Grave Robbing today!Guide the recently deceased to a fun filled life of... | Read more »
Bad Dinos (Games)
Bad Dinos 1.0.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.0 (iTunes) Description: | Read more »
The Apple Watch isn't Great as a Fi...
| Read more »
Show the World What You See With Stre.am...
Live broadcasting is getting popular on mobile devices, which is why you can now get Stre.am, by Infinite Takes. [Read more] | Read more »
PhotoTime's 2.1 Update Adds Apple W...
The latest PhotoTime update is adding even more functionality to the handy photo organizing app. Yep, including Apple Watch support. [Read more] | Read more »
Oh My Glob! Adventure Time Puzzle Quest...
Finn and Jake are taking over D3 Go!'s popular puzzle game series in the upcoming Adventure Time Puzzle Quest. [Read more] | Read more »
Earthcore: Shattered Elements - Tips, Tr...
At first glance, Earthcore: Shattered Elements seems like a rather simple card-battling game. Once you’re introduced to skills that will change quite a bit. Even more so once you start to acquire hero cards. But it’s not so complicated that we... | Read more »
Dungeon999F (Games)
Dungeon999F 1.33 Device: iOS Universal Category: Games Price: $.99, Version: 1.33 (iTunes) Description: "The game you must play at least once in your life!" "The game with potential of million downloads globally!" ...is what the... | Read more »

Price Scanner via MacPrices.net

OtterBox Maximizes Portability, Productivity...
From the kitchen recipe book to the boarsroom presentation, the OtterBox Agility Tablet System turns tablets into one of the most versatile pieces of handheld technology available. Available now, the... Read more
Launch of New Car App Gallery and Open Develo...
Automatic, a company on a mission to bring the power of the Internet into every car, has announced the launch of the Automatic App Gallery, an app store for nearly every car or truck on the road... Read more
Memorial Day Weekend Sale: 13-inch 1.6GHz Mac...
Best Buy has the new 13″ 1.6GHz/128GB MacBook Air on sale for $849 on their online store this weekend. Choose free shipping or free local store pickup (if available). Sale price for online orders... Read more
Memorial Day Weekend Sale: 27-inch 3.5GHz 5K...
Best Buy has the 27″ 3.5GHz 5K iMac on sale for $2099.99 this weekend. Choose free shipping or free local store pickup (if available). Sale price for online orders only, in-store prices may vary.... Read more
Sale! 16GB iPad mini 3 for $349, save $50
B&H Photo has the 16GB iPad mini 3 WiFi on sale for $349 including free shipping plus NY sales tax only. Their price is $50 off MSRP, and it’s the lowest price available for this model. Read more
Price drop on 2014 15-inch Retina MacBook Pro...
B&H Photo has dropped prices on 2014 15″ Retina MacBook Pros by $200. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $1799.99 save $200 - 15″ 2.5GHz... Read more
With a Mission to Make Mobile Free, Scratch W...
Scratch Wireless, claiming to be the world’s first truly free mobile service, has announced the availability of a new Scratch-enabled Android smartphone, the Coolpad Arise. The smartphone is equipped... Read more
First-Ever Titanium Alloy Curved iPhone 6 Scr...
One of the most common problems with mobile phones is damage to the screens. The slightest drop can cause a dreaded spider web of gashes and cracks in the glass panel surface that can cost $hundreds... Read more
Preorder new 12-inch MacBook, $10 off, save o...
Adorama has new 12″ Retina MacBooks available for preorder for $10 off MSRP including free shipping plus NY & NJ sales tax only. For a limited time, Adorama will include a free Apple USB-C to USB... Read more
Will iOS 9 Finally Bring Productivity Friendl...
Ah, the irony. From its original announcement in 2010, Apple has doggedly insisted that the iPad remain “simple,” thus arbitrarily limiting its considerable potential as a content creation and... Read more

Jobs Board

*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
Business Development Manager - *Apple* Pay...
**Job Summary** Apple Pay is seeking an experienced Business Development professional to join the Apple Pay team to develop partnerships and strategic alliances with Read more
Project Manager, *Apple* Retail New Store O...
**Job Summary** An Apple Retail New Store Openings & Remodels Project Manager is responsible for successfully managing the openings, remodels, and small works of Read more
SW QA Engineer - *Apple* TV - Apple (United...
**Job Summary** The Apple TV team is looking for experienced Quality Assurance Engineers with a passion for delivering first in class home entertainment solutions. **Key Read more
Partner Marketing Manager - *Apple* Pay - A...
**Job Summary** The Apple Pay partner marketing team is looking for a marketing manager to develop and drive US marketing programs with our financial institution Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.