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

Adobe Premiere Pro 2022 23.1 - Digital v...
Adobe Premiere Pro is available as part of Adobe Creative Cloud for as little as $54.99/month. The price on display is a price for annual by-monthly plan for Adobe Premiere Pro only. Adobe Premiere... Read more
1Password 8.9.10 - Powerful password man...
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
FotoMagico 6.3 - Powerful slideshow crea...
FotoMagico lets you create professional slideshows from your photos and music with just a few, simple mouse clicks. It sports a very clean and intuitive yet powerful user interface. High image... Read more
Affinity Photo 1.10.6 - Digital editing...
Affinity Photo - redefines the boundaries for professional photo editing software for the Mac. With a meticulous focus on workflow it offers sophisticated tools for enhancing, editing and retouching... Read more
Vivaldi 5.5.2805.50 - An advanced browse...
Vivaldi is a browser for our friends. We live in our browsers. Choose one that has the features you need, a style that fits and values you can stand by. From the look and feel, to how you interact... Read more
Fantastical 3.7.4 - Create calendar even...
Fantastical 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 details... Read more
Adobe Illustrator 2022 27.1 - Profession...
You can download Adobe Illustrator as a part of Creative Cloud for only $20.99/month. Adobe Illustrator is the vector graphics classics in the design industry. It is a digital environment that allows... Read more
Acorn 7.3.1 - Bitmap image editor.
Acorn is a new image editor built with one goal in mind - simplicity. Fast, easy, and fluid, Acorn provides the options you'll need without any overhead. Acorn feels right, and won't drain your bank... Read more
Apple Configurator 2.16 - Configure and...
Apple Configurator makes it easy to deploy iPad, iPhone, iPod touch, and Apple TV devices in your school or business. Use Apple Configurator to quickly configure large numbers of devices connected to... Read more
Bookends 14.1.5 - Reference management a...
Bookends is a full-featured bibliography/reference and information-management system for students and professionals. Bookends uses the cloud to sync reference libraries on all the Macs you use.... Read more

Latest Forum Discussions

See All

Alchemy Stars celebrates 1 and a half ye...
It has been one and a half years since Alchemy Stars launched, and Level Infinite is celebrating in style with a host of new content. There will be a new story mission and even a store to explore, and a whole new mode for those budding idol... | Read more »
Fighting Game ‘Art of Fighting 2’ ACA Ne...
Last week, side-scrolling shooter Pulstar hit mobile platforms as the newest ACA NeoGeo series release from Hamster and SNK. Read Shaun’s review of it here. Today, fighting game Art of Fighting 2 has launched on iOS and Android. Art of Fighting 2... | Read more »
‘Genshin Impact’ Version 3.3 Update Now...
HoYoverse recently revealed the next major update for Genshin Impact (Free) in the form of version 3.3 ‘All Senses Clear, All Existence Void’. | Read more »
SwitchArcade Round-Up: Reviews Featuring...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for December 6th, 2022. In today’s article, we’ve got three more reviews. Siralim Ultimate, Astronite, and Swordship get evaluated and scored today. All interesting in their own ways,... | Read more »
‘Pulstar ACA NEOGEO’ Review – Kiss Your...
As I’ve said more than a few times in the past, the NEOGEO was generally known for a couple of genres more than anything else. Fighting games, of course. And thanks to Metal Slug and to a lesser extent Shock Troopers, it’s also known for run-and-gun... | Read more »
‘The Witcher: Monster Slayer’ Shutting D...
Location-based AR game The Witcher: Monster Slayer (Free) from CD Projekt Red’s in-house studio Spokko Games has been getting updated quite often following its launch on iOS and Android. These updates include new challenges, monster types, stamps,... | Read more »
Get Your Hands on the Power Cosmic in th...
To me, my board! As discussed in our story about the last update to the excellent card battler Marvel Snap (Free), the latest season of the game is called The Power Cosmic. | Read more »
HoYoverses announces inaugral art exhibi...
If you are lucky enough to be in the Paris area in early January, then you should pop to the Galerie Joseph and enjoy a look at the world of HoYoverses’ global smash hit, Genshin Impact. There will be unreleased concept art and a deep dive into... | Read more »
SwitchArcade Round-Up: Reviews Featuring...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for December 5th, 2022. In today’s article, we’ve got a few reviews for you. Square Enix’s Romancing SaGa -Minstrel Song- Remastered, Forever Entertainment’s Front Mission 1st: Remake,... | Read more »
Best iPhone Game Updates: ‘Fire Emblem H...
Hello everyone, and welcome to the week! It’s time once again for our look back at the noteworthy updates of the last seven days. Oh yes, here come the Christmas updates. Quite a lot of the games featured today are doing the holiday thing, with only... | Read more »

Price Scanner via MacPrices.net

Christmas sale at Verizon: Apple AirPods Pro...
Verizon has first-generation Apple AirPods Pro on sale for $159.99 on their online store as part of their continuing Christmas/Holiday sale. Their price is $90 off Apple’s original MSRP, and it’s the... Read more
New Christmas/New Years promo at Xfinity Mobi...
Switch to Xfinity Mobile and open a new line of service, and take $400 off the price of a new iPhone, no trade-in required, through January 10, 2023. The $400 is applied to your account as credits... Read more
Apple iPad Smart Keyboard Folio prices drop u...
Apple iPad Smart Keyboard Folio prices have dropped up to $60 off MSRP at Amazon and Walmart as part of their Christmas/Holiday sales. These are the cheapest prices currently available for these iPad... Read more
Today is the final day for Xfinity Mobile’s $...
If you switch to Xfinity Mobile and open a new line of service, they will take $500 off the price of a new iPhone, no trade-in required. This is the best no trade-in Cyber Monday Apple iPhone 14 deal... Read more
Amazon restocks 10.2″ 64GB 9th-generation iPa...
Amazon has Apple’s 9th generation 10.2″ 64GB WiFi iPads (Silver) in stock and on sale for $269.99 shipped as part of their Christmas/Holiday Sale. Their price is $60 off Apple’s MSRP. Free delivery... Read more
Week’s Best Apple MacBook Air Christmas Sales...
Apple retailers have posted their most-recent Christmas Holiday sale prices on 13″ MacBook Airs. Take up to $150 off MSRP on M2-powered Airs with these sales with prices starting at only $1049. Free... Read more
Open-box 13″ M2 MacBook Pros available for $3...
QuickShip Electronics has open-box return 13″ M2 MacBook Pros in stock and on sale for $300-$350 off MSRP on their eBay store right now, each with free express delivery. According to QuickShip, “The... Read more
Apple is offering $100 iPad discounts to Educ...
Apple will take $100 off 12″ M2 iPad Pros, $50-$100 off 11″ M2 iPad Pros, $50 off iPad Airs, $50 off 8.3″ iPad minis, & $20-$40 off 10″ iPads for all teachers, students, and staff of any... Read more
Midnight Apple Watch Series 8 (41mm GPS + Cel...
Amazon has the Midnight Apple Watch Series 8 (41mm GPS + Cellular) on sale for $50 off MSRP as part of their Holiday sale including free shipping, reducing the price for this Watch to $449.99. Their... Read more
Holiday Sale: Apple Watch Ultra for $50 off M...
Amazon has Apple Watch Ultra models (Alpine Loop, Trail Loop, and Opean Bans) on sale for $50 off MSRP as part of their Holiday sale, each including free shipping, reducing the price for an Ultra to... Read more

Jobs Board

*Apple* Systems Administrator - JAMF - Activ...
…Administration **Duties and Responsibilities** + Configure and maintain the client's Apple Device Management (ADM) solution. The current solution is JAMF supporting Read more
Cashier - *Apple* Blossom Mall - JCPenney (...
Cashier - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Blossom Mall Read more
Omnichannel Associate - *Apple* Blossom Mal...
Omnichannel Associate - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Read more
Sephora Beauty Advisor - *Apple* Blossom Ma...
Sephora Beauty Advisor - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Read more
Operations Associate - *Apple* Blossom Mall...
Operations Associate - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.