Programování pro iOS - 33. Řídicí objekt pro strom - MujMAC.cz - Apple, Mac OS X, Apple iPod

16. března 2011, 06.00 | V představování specifických řídicích objektů rámců se dnes podíváme na další – na třídu UINavigationController.

Každou chvíli potřebujeme zobrazení údajů, jež mají hierarchickou stromovou strukturu. Asi nejtypičtějším případem – byť právě v iOSu za běžných okolností nevyužívaným – je struktura souborů a adresářů; setkáme se s nimi ale i v mnoha dalších situacích: účty/schránky/vlákna/zprávy v elektronické poště, volby nastavení rozdělené do skupin apod.

Na zařízeních s malou obrazovkou – naprosto důsledně tedy u iPhone, občas i na iPadu – není prakticky možné použít víceúrovňový browser; namísto toho se využívá řada vzájemně volně spojených tabulek. Každá tabulka zobrazuje informace o jedné úrovni hierarchie, a obsahuje mj. také odkazy pro přechod na úroveň vyšší i na úrovně nižší (pokud existují).

Vzhledem k tomu, jak je tento typ grafického uživatelského rozhraní rozšířený, není divu, že pro něj iOS nabízí speciální API – řídicí objekt UINavigationController.

Princip funkce

Základní princip, na němž je funkce "navigátoru" založena, je jednoduchý a logický:

• instance třídy UINavigationController je standardním řídicím objektem rámce – můžeme jej tedy např. kdykoli zobrazit nad stávajícím rámcem pomocí služby presentModalViewController:animated: apod. Velmi často bývá hlavním řídicím objektem celé aplikace; pak je jeho kořenový rámec prostě v metodě application:didFinishLaunchingWithOptions: umístěn do hlavního okna;

• jeho rámec zobrazuje standardní záhlaví a pod ním libovolný vnořený řídicí objekt – kupříkladu řídicí objekt tabulky z minulého dílu našeho seriálu;

• takovýchto vnořených řídicích objektů může "navigátor" obsahovat více; zobrazuje vždy ten poslední z nich, a jeho záhlaví automaticky zajišťuje možnost vrátit se k tomu předchozímu.

Řídicí objekt třídy UINavigationController tedy neobsahuje celý strom dat; obsahuje ale vždy "aktivní větev", tedy řídicí objekt pro kořen stromu – vždy –, a případné řídicí objekty pro všechny prvky stromu od kořene po cestě až k tomu, který je právě zobrazen.

Chceme-li tedy v aplikaci zobrazovat hierarchická data, musíme

a) pro každou úroveň údajů připravit vhodný řídicí objekt a jeho rámce, jež budou tyto údaje zobrazovat. Téměř vždy slouží jedna společná podtřída UIViewController pro více úrovní (a velmi často pro všechny); v naprosté většině případů bývají údaje zobrazovány pomocí tabulky (jde tedy o podtřídu UITableViewController, jímž jsme se zabývali minule);

b) vytvořit řídicí objekt pro kořen stromu ...

c) ... a uložit jej do nově vytvořeného UINavigationControlleru. Ten pak zobrazíme;

d) kdykoli chceme přejít o úroveň níže, vytvoříme nový řídicí objekt pro odpovídající prvek stromu a vložíme jej do UINavigationControlleru.

To je v podstatě vše; korektní zobrazení a možnost přechodu zpět do vyšších úrovní stromu už zajistí UINavigationController automaticky, aniž bychom se o to museli starat. Kroky (a)-(c) můžeme podle potřeby zajistit buď programově nebo pomocí služeb Interface Builderu; krok (d) je typicky zajištěn programově na základě odpovídající akce – často výběru řádku tabulky.

Základní API

Sestavujeme-li navigační systém pomocí Interface Builderu, vystačili bychom si v zásadě s jedinou zprávou; pokud jej připravujeme programově, potřebujeme minimálně zprávy dvě; prvou z nich je

-initWithRootViewController:(UIViewController*)rvc;

Třída UINavigationController nabízí vlastní inicializátor, který vytvoří řídicí objekt pro navigaci a zároveň do něj uloží druhý (předem sestavený) řídicí objekt, který representuje kořen našeho stromu. Vytváříme-li UINavigationController programově, použijeme vždy tohoto incializátoru; v praxi by to pak mohlo vypadat kupříkladu takto (vyjdeme-li z již dávno důvěrně známé struktury běžné aplikace a ponecháme-li prozatím stranou pohodlnější možnost sestavit vše v Interface Builderu):

#import "RootViewController.h" // kořen uvnitř "navigátoru"
@implementation AppDelegate
@synthesize window;
@synthesize rootController; // připraven v XIBu
-(BOOL)application:(UIApplication*)app
  didFinishLaunchingWithOptions:(NSDictionary*)options {
  UINavigationController *nc=[[UINavigationController alloc]
                  initWithRootViewController:rootController];
  [self.window addSubview:nc.view];
  [self.window makeKeyAndVisible];
  return YES;
}

Zpráva, bez níž se neobejdeme, je

-(void)pushViewController:(UIViewController*)vc animated:(BOOL)a;

jejíž pomocí uložíme "na vrchol navigátoru" nový řídicí objekt, kdykoli přejdeme na další úroveň v zobrazovaném stromu. S nalezením navigátoru si nemusíme dělat starosti: každý UIViewController pro naše pohodlí nabízí atribut navigationController, jehož obsahem je vždy nadřízený UINavigationController (pokud ovšem existuje).

Ačkoli návrat na vyšší úroveň stromu zajišťuje UINavigationController automaticky (tím, že do standardního záhlaví obrazovky umístí tlačítko "Zpět", jež bez dalšího programování funguje tak, jak má), můžeme potřebovat i programový návrat; k tomu slouží primárně zpráva

-(UIViewController*)popViewControllerAnimated:(BOOL)animated;

jež odstraní právě zobrazovaný řídicí objekt a namísto něj zobrazí ten nad ním (a ten odstraněný vrátí). Pro větší pohodlí také můžeme odstranit všechny řídicí objekty až do předem daného nebo až po kořenový najednou:

-(NSArray*)popToViewController:(UIViewController*)vc
  animated:(BOOL)animated;
-(NSArray*)popToRootViewControllerAnimated:(BOOL)animated;

tyto metody vracejí pole odstraněných řídicích objektů.

Jednoduchá ukázka

Pojďme rozšířit kód, který jsme si ukázali minule pro zobrazení tabulky a pro výběr z ní, tak, aby podporoval hierarchické údaje!

Jeho základní API může být téměř přesně stejné jako minule; jen v rámci kontraktu volajícímu slíbíme namísto "instance SelectionVC" pouze "instanci nějakého řídicího objektu rámce":

@interface SelectionVC:UITableViewController
+(UIViewController*)selectionWithList:(NSArray*)items;
@end
extern NSString * const SelectionVCNotification;

Implementace se oproti minulému případu rozšíří jen zcela minimálně – především, budeme potřebovat pomocný atribut, v jehož rámci si pro "neaktivní" řídicí objekty zapamatujeme, který řádek byl zvolen (alternativně bychom samozřejmě mohli použít adekvátní atribut tabulky, ale takhle je to, jak uvidíme, jednodušší):

@interface SelectionVC ()
@property (retain,nonatomic) NSArray *items;
@property (nonatomic) NSUInteger selectedRow;
@end
@implementation SelectionVC
@synthesize items,selectedRow;
...

(Mimochodem, omlouvám se, že jsem v minulém dílu omylem v direktivě @synthesize nechal i atribut selectedRow, který tam samozřejmě neměl co dělat – jak určitě odhalil snadno kdokoli, kdo si zkusil kód zbuildovat a spustit :))

Dvojice metod initWithItems: a dealloc zůstane zcela beze změny a uvedeme je pouze pro referenci. Naproti tomu obsah metody selectionWithList: se změní – nyní v něm vytvoříme (a vrátíme) řídicí objekt "navigátoru" UINavigationController, zatímco náš SelectionVC bude jen jeho kořenovým řídicím objektem:

...
-initWithItems:(NSArray*)ia {
  if (!(self=[super init])) return nil;
  self.items=ia;
  return self;
}
-(void)dealloc {
  self.items=nil;
  [super dealloc];
}
+(UIViewController*)selectionWithList:(NSArray*)items {
  SelectionVC *svc=[[[self alloc] initWithItems:items]
            autorelease];
  return [[[UINavigationController alloc]
            initWithRootViewController:svc] autorelease];
}
...

Konečně pak ve službách datového zdroje a delegáta budou drobné změny

• pro zobrazení vnořeného pole (kde zároveň opatříme řádek tabulky standardním indikátorem UITableViewCellAccessoryDisclosureIndicator, který znamená v iOSu vždy "zde lze přejít na další úroveň");

• při výběru řádku, který obsahuje vnořené pole, použijeme službu pushViewController:animated: pro zobrazení další úrovně (a zapamatujeme si zároveň vybrané číslo řádku v novém atributu selectedRow);

• konečně pak při výběru normálního řádku namísto jednoduchého čísla "row" uložíme do notifikace celé pole indexů jako "path":

...
-(NSInteger)tableView:(UITableView*)tv // beze změny
  numberOfRowsInSection:(NSInteger)section {
  return self.items.count;
}
-(UITableViewCell*)tableView:(UITableView*)tv
  cellForRowAtIndexPath:(NSIndexPath*)ip {
  UITableViewCell *cell=nil;
  if (!(cell=[tv dequeueReusableCellWithIdentifier:@"0"]))
    cell=[[[UITableViewCell alloc]
      initWithStyle:UITableViewCellStyleDefault
      reuseIdentifier:@"0"]
      autorelease];
  id o=[self.items objectAtIndex:ip.row];
  if ([o isKindOfClass:[NSArray class]]) {
    cell.textLabel.text=[NSString
      stringWithFormat:@"Nested %u items",[o count]];
    cell.accessoryType=
      UITableViewCellAccessoryDisclosureIndicator;
  } else
    cell.textLabel.text=o;
  return cell;
}
-(NSIndexPath*)tableView:(UITableView*)tv
  willSelectRowAtIndexPath:(NSIndexPath*)ip {
  id o=[self.items objectAtIndex:selectedRow=ip.row];
  if ([o isKindOfClass:[NSArray class]]) {
    SelectionVC *svc=[[[SelectionVC alloc]
      initWithItems:o] autorelease];
    [self.navigationController pushViewController:svc
      animated:YES];
  } else
    [[NSNotificationCenter defaultCenter]
      postNotificationName:SelectionVCNotification object:self
      userInfo:[NSDictionary
        dictionaryWithObject:
          [self.navigationController.viewControllers
            valueForKey:@"selectedRow"]
          forKey:@"path"]];
  return nil;
}
@end

Nyní tedy můžeme vytvářet náš "vybírací tabulkový" řídicí objekt třeba takto:

SelectionVC *svc=[SelectionVC selectionWithList:
  [NSArray arrayWithObjects:
    @"a",@"b",[NSArray arrayWithObjects:@"1",@"2",nil],@"c",
  nil]];

a vše bude fungovat jak má.

Příště si ukážeme ještě několik dalších služeb, jež nám UINavigationController nabízí: naučíme se např. měnit titulek v záhlaví obrazovky.