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

Dashlane 6.2027.0 - Password manager and...
Dashlane is an award-winning service that revolutionizes the online experience by replacing the drudgery of everyday transactional processes with convenient, automated simplicity - in other words,... Read more
ffWorks 2.1.5 - Convert multimedia files...
ffWorks, focused on simplicity, brings a fresh approach to the use of FFmpeg, allowing you to create ultra-high-quality movies without the need to write a single line of code on the command-line.... Read more
Dropbox 101.4.434 - Cloud backup and syn...
Dropbox for Mac is a file hosting service that provides cloud storage, file synchronization, personal cloud, and client software. It is a modern workspace that allows you to get to all of your files... Read more
1Password 7.6 - Powerful password manage...
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
EyeTV 4.0.0 - Watch and record TV on you...
EyeTV brings a rich TV experience to your Mac. Watch live TV on your Mac. Pause, rewind, and record whenever you want. EyeTV gives you powerful control over what you watch and how you watch it. Put... Read more
Tidy Up 5.3.7 - Find duplicate files and...
Tidy Up is a full-featured duplicate finder and disk-tidiness utility. Features: Supports Lightroom: it is now possible to search and collect duplicates directly in the Lightroom library. Multiple... Read more
Pinegrow 5.97 - Mockup and design web pa...
Pinegrow (was Pinegrow Web Designer) is desktop app that lets you mockup and design webpages faster with multi-page editing, CSS and LESS styling, and smart components for Bootstrap, Foundation,... Read more
BlueStacks 4.210.0 - Run Android applica...
BlueStacks App Player lets you run your Android apps fast and fullscreen on your Mac. Feature comparison chart How to install Bluestacks on your Mac Go to MacUpdate and click the green "Download"... Read more
WhatsApp 2.2027.10 - Desktop client for...
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
Art Text 4.0.1 - $29.99
Art Text is graphic design software specifically tuned for lettering, typography, text mockups and various artistic text effects. Supplied with a great variety of ready to use styles and materials,... Read more

Latest Forum Discussions

See All

Clash Royale: The Road to Legendary Aren...
Supercell recently celebrated its 10th anniversary and their best title, Clash Royale, is as good as it's ever been. Even for lapsed players, returning to the game is as easy as can be. If you want to join us in picking the game back up, we've put... | Read more »
Steam Link Spotlight - Disco Elysium
Steam Link Spotlight is a feature where we look at PC games that play exceptionally well using the Steam Link app. Our last entry was Signs of the Sojourner Read about how it plays using Steam Link over here. | Read more »
Distract Yourself With These Great Mobil...
There’s a lot going on right now, and I don’t really feel like trying to write some kind of pithy intro for it. All I’ll say is lots of people have been coming together and helping each other in small ways, and I’m choosing to focus on that as I... | Read more »
Pokemon Go's July Community Day wil...
Pokemon Go developers have announced the details concerning the upcoming Gastly Community Day. This particular event was selected by the players of the game after the Gas Pokemon came in second place after a poll that decided which Pokemon would... | Read more »
Clash Royale: The Road to Legendary Aren...
Supercell recently celebrated its 10th anniversary and their best title, Clash Royale, is as good as it's ever been. Even for lapsed players, returning to the game is as easy as can be. If you want to join us in picking the game back up, we've put... | Read more »
Detective Di is a point-and-click murder...
Detective Di is a point-and-click murder mystery set in Tang Dynasty-era China. You'll take on the role of China's best-known investigator, Di Renjie, as he solves a series of grisly murders that will ultimately lead him on a collision course with... | Read more »
Dissidia Final Fantasy Opera Omnia is se...
Dissidia Final Fantasy Opera Omnia, one of Square Enix's many popular mobile RPGs, has announced a plethora of in-game events that are set to take place over the summer. This will include several rewards, Free Multi Draws and more. [Read more] | Read more »
Sphaze is a neat-looking puzzler where y...
Sphaze is a neat-looking puzzler where you'll work to guide robots through increasingly elaborate mazes. It's set in a visually distinct world that's equal parts fantasy and sci-fi, and it's finally launched today for iOS and Android devices. [... | Read more »
Apple Arcade is in trouble
Yesterday, Bloomberg reported that Apple is disappointed in the performance of Apple Arcade and will be shifting their approach to the service by focusing on games that can retain subscribers and canceling other upcoming releases that don't fit... | Read more »
Pixel Petz, an inventive platform for de...
Pixel Petz has built up a sizeable player base thanks to its layered, easy-to-understand creative tools and friendly social experience. It revolves around designing, trading, and playing with a unique collection of pixel art pets, and it's out now... | Read more »

Price Scanner via MacPrices.net

B&H Photo offers $200-$300 discounts on A...
B&H Photo has new 16″ MacBook Pros on sale today for $200-$300 off Apple’s MSRP, starting at $2149. Expedited shipping is free to many addresses in the US: – 2019 16″ 2.6GHz 6-Core MacBook Pro... Read more
Clearance 2019 15″ MacBook Pros on sale today...
Amazon-owned Woot is blowing out Apple refurbished, clearance 2019 15″ MacBook Pros starting at only $1579 and up to $950 off Apple’s original MSRP. According to Woot, “These MacBooks are Refurbished... Read more
Apple Refurbished iMac Pros available for $35...
Amazon-owned Woot is selling Apple refurbished 27″ 3.2GHz 8-Core iMac Pros for $3599.99 shipped. That’s $1400 off Apple’s original MSRP for this model. According to Woot, these iMac Pros are “Factory... Read more
Clearance 2019 13″ 2.4GHz/256GB MacBook Pro o...
B&H Photo has dropped their price on the clearance 2019 13″ 2.4GHz/256GB Quad-Core Silver MacBook Pro by $500 off Apple’s original MSRP to a new low of only $1299. Expedited shipping is free to... Read more
$219 Apple AirPods Pro are back at Verizon, s...
Verizon has Apple AirPods Pro on sale again for a limited time for $219.99 on their online store. Their price is $30 off Apple’s MSRP, and it’s the lowest price we’ve seen for AirPods Pro. Available... Read more
Apple’s $779 13″ MacBook Air deal returns to...
Apple has clearance, Certified Refurbished, 2019 13″ MacBook Airs available again starting at $779. Each MacBook features a new outer case, comes with a standard Apple one-year warranty, and is... Read more
$200 13″ MacBook Pro discounts are back at Am...
Amazon has 2020 13″ 2.0GHz MacBook Pros on sale again today for $150-$200 off Apple’s MSRP. Shipping is free. Be sure to purchase the MacBook Pro from Amazon, rather than a third-party seller, and... Read more
Deal Alert! Apple AirPods with Wireless Charg...
Sams Club has Apple AirPods with Wireless Charging Case on sale on their online store for only $149.98 from July 6, 2020 to July 9, 2020. Their price is $50 off Apple’s MSRP, and it’s the lowest... Read more
Xfinity Mobile promo: Apple iPhone XS models...
Take $300 off the purchase of any Apple iPhone XS model at Xfinity Mobile while supplies last. Service plan required: – 64GB iPhone XS: $599.99 save $300 – 256GB iPhone XS: $749.99 save $300 – 512GB... Read more
New July 2020 promo at US Cellular: Switch an...
US Cellular has introduced a new July 2020 deal offering free 64GB Apple iPhone 11 smartphones to customers opening a new line of service. No trade-in required, and discounts are applied via monthly... Read more

Jobs Board

Product Manager, *Apple* Commercial Sales -...
Product Manager, Apple Commercial Sales Austin, TX, US Requisition Number:77652 As an Apple Product Manager for the Commercial Sales team at Insight, you Read more
Physical Therapist Assistant - *Apple* Hill...
Physical Therapist Assistant - Apple Hill Rehab - Full Time Tracking Code 62519 Job Description General Summary: Under the direct supervision of a licensed Physical Read more
Operating Room Assistant, *Apple* Hill Surg...
Operating Room Assistant, Apple Hill Surgical Center - Full Time, Day Shift, Monday - Saturday availability required Tracking Code 62363 Job Description Operating Read more
Perioperative RN - ( *Apple* Hill Surgical C...
Perioperative RN - ( Apple Hill Surgical Center) Tracking Code 60593 Job Description Monday - Friday - Full Time Days Possible Saturdays General Summary: Under the Read more
Product Manager, *Apple* Commercial Sales -...
Product Manager, Apple Commercial Sales Austin, TX, US Requisition Number:77652 As an Apple Product Manager for the Commercial Sales team at Insight, you Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.