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

Camping With Grandpa (Education)
Camping With Grandpa 1.0 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »
Black Hole Joyrider (Games)
Black Hole Joyrider 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Guide your spacecraft through the gravity well of a powerful black hole using only your retro-thrusters and dwindling fuel... | Read more »
My Koi (Games)
My Koi 1.0 Device: iOS iPhone Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: My Koi is a beautiful and relaxing fish pond app. Customise and name each fish. Feed them daily. Watch them grow. Collect new fish.... | Read more »
Never Gone (Games)
Never Gone 1.0.2 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.2 (iTunes) Description: ###IMPPORTANT### Never Gone's HD art resources require devices with more than 1GB RAM, so please note that iPhone 4/4s, iPad 2/... | Read more »
INKS. (Games)
INKS. 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: From the makers of BAFTA-winning Lumino City comes INKS. INKS updates pinball for a new generation. It combines the joy of pinball with... | Read more »
How to maximise your profits in Bakery B...
Running a bakery can be an expensive venture. You’ll need to continuously upgrade your oven, your kitchen supplies, and even your ingredients to keep customers happy. Most of these renovations in Bakery Blitz cost a pretty penny, but we have a few... | Read more »
How to manage your time in Bakery Blitz
It can be tricky, especially when you risk burning your kitchen to the ground if you forget a cake in the oven, so make sure to use these time management tricks to keep your bakery running smoothly. Don’t collect the money right away [Read more] | Read more »
Model 15 (Music)
Model 15 1.0 Device: iOS iPhone Category: Music Price: $29.99, Version: 1.0 (iTunes) Description: The Moog Model 15 App is the first Moog modular synthesizer and synthesis educational tool created exclusively for iPad, iPhone and... | Read more »
How to deal with wind in Angry Birds Act...
Angry Birds Action! is a physics-based puzzler in which you're tasked with dragging and launching birds around an obstacle-littered field to achieve a set objective. It's simple enough at first, but when wind gets introduced things can get pretty... | Read more »
How to get three stars in every level of...
Angry Birds Action! is, essentially, a pinball-style take on the pull-and-fling action of the original games. When you first boot it up, you'll likely be wondering exactly what it is you have to do to get a good score. Well, never fear as 148Apps... | Read more »

Price Scanner via MacPrices.net

12-inch 128GB iPad Pros on sale for up to $10...
B&H Photo has 12″ 128GB WiFi iPad Pros on sale for up to $100 off MSRP, each including free shipping. B&H charges sales tax in NY only: - 12″ Space Gray 128GB WiFi iPad Pro: $899 $50 off MSRP... Read more
Global Tablet Sales Slump Continues, iPad’s F...
Another miserable showing for the global slate tablet category in calendar Q1/16, with global tablet shipments falling another 1ten percent to 46.5 million units during the according to Strategy... Read more
Revel Systems to Showcase iPad POS Platform w...
Revel Systems, specialists in iPad Point of Sale management solution for brick-and-mortar retail, food businesses and more, today announced that it will showcase its innovative iPad Point of Sale... Read more
13-inch 2.5GHz MacBook Pro on sale for $999,...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $999 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Read more
Apple refurbished 2015 iMacs available for up...
Apple now has a full line of Certified Refurbished 2015 21″ & 27″ iMacs available for up to $350 off MSRP. Apple’s one-year warranty is standard, and shipping is free. The following models are... Read more
Indian Smartphone Market Grows Annually by 12...
India’s smartphone market grew by 12 percent year-over-year, with 24.4 million units shipping in Q1 2016. The top five vendors stayed the same, with Samsung in the lead, followed by Micromax, Intex... Read more
Get Notifications When Your Friend’s Phone Ba...
Calgary, Canada based Stonelight Pictures has announced the release of Battery Share 1.0.1, its new utility for iOS 9 supported devices. The company notes that people are spending more time on their... Read more
11-inch 1.6GHz/128GB MacBook Air on sale for...
Amazon has the current-generation 11″ 1.6GHz/128GB MacBook Air (sku MJVM2LL/A) on sale for $749.99 for a limited time. Their price is $150 off MSRP, and it’s the lowest price available for this model... Read more
Price drops on clearance 2015 13-inch MacBook...
B&H Photo has dropped prices on clearance 2015 13″ MacBook Airs by up to $250. Shipping is free, and B&H charges NY sales tax only: - 13″ 1.6GHz/4GB/128GB MacBook Air (MJVE2LL/A): $799, $200... Read more
Mac minis on sale for up to $100 off MSRP
B&H Photo has Mac minis on sale for up to $100 off MSRP including free shipping plus NY sales tax only: - 1.4GHz Mac mini: $449 $50 off MSRP - 2.6GHz Mac mini: $649 $50 off MSRP - 2.8GHz Mac mini... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
Automotive Sales Consultant - Apple Ford Linc...
…you. The best candidates are smart, technologically savvy and are customer focused. Apple Ford Lincoln Apple Valley is different, because: $30,000 annual salary Read more
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
Simply Mac *Apple* Specialist- Service Repa...
Simply Mac is the largest premier retailer of Apple products in the nation. In order to support our growing customer base, we are currently looking for a driven Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.