Added support for state preservation and restoration

Author: ipodishima

CHANGELOG

@@ -0,0 +1,8 @@
+#1.2.1
+* Dropped support for OS <= 6
+* Removed warning about project configuration
+* Moved to modern O-C syntax
+* Added support for childViewControllerForStatusBarStyle
+* Added f suffix on float values
+* Fixed an issue with fake status bar and rotation
+* Added support for state preservation and restoration

PPRevealSideViewController/PPRevealSideviewController/PPRevealSideViewController.m

@@ -26,43 +26,7 @@
 @interface PPRevealSideViewController ()
 
 @property (nonatomic, strong) UIView *underStatusBarView;
-@property (nonatomic, assign) BOOL hideStatusBar;
-
-- (void)setRootViewController:(UIViewController *)controller replaceToOrigin:(BOOL)replace;
-- (void)setRootViewController:(UIViewController *)controller;
-- (void)addShadow;
-- (void)removeShadow;
-- (void)handleShadows;
-- (void)informDelegateWithOptionalSelector:(SEL)selector withParam:(id)param;
-- (void)popViewControllerWithNewCenterController:(UIViewController *)centerController animated:(BOOL)animated andPresentNewController:(UIViewController *)controllerToPush withDirection:(PPRevealSideDirection)direction andOffset:(CGFloat)offset;
-- (void)addGesturesToCenterController;
-- (void)addPanGestureToController:(UIViewController *)controller;
-- (void)addTapGestureToController:(UIViewController *)controller;
-- (void)addGesturesToController:(UIViewController *)controller;
-- (void)removeAllPanGestures;
-- (void)removeAllTapGestures;
-- (void)removeAllGestures;
-- (void)setOffset:(CGFloat)offset forDirection:(PPRevealSideDirection)direction;
-- (void)removeControllerFromView:(UIViewController *)controller animated:(BOOL)animated;
-- (void)preloadViewController:(UIViewController *)controller forSide:(PPRevealSideDirection)direction withOffset:(CGFloat)offset forceRemoval:(BOOL)force;
-
-- (BOOL)isLeftControllerClosed;
-- (BOOL)isRightControllerClosed;
-- (BOOL)isTopControllerClosed;
-- (BOOL)isBottomControllerClosed;
-- (BOOL)isOptionEnabled:(PPRevealSideOptions)option;
-- (BOOL)canCrossOffsets;
-
-- (PPRevealSideDirection)getSideToClose;
-
-- (CGRect)getSlidingRectForOffset:(CGFloat)offset forDirection:(PPRevealSideDirection)direction;
-- (CGRect)getSideViewFrameFromRootFrame:(CGRect)rootFrame andDirection:(PPRevealSideDirection)direction;
-
-- (UIEdgeInsets)getEdgetInsetForDirection:(PPRevealSideDirection)direction;
-
-- (CGFloat)getOffsetForDirection:(PPRevealSideDirection)direction andInterfaceOrientation:(UIInterfaceOrientation)interfaceOrientation;
-- (CGFloat)getOffsetForDirection:(PPRevealSideDirection)direction;
-- (void)tryToRemoveObserverOnFrame;
+@property (nonatomic, assign) BOOL   hideStatusBar;
 
 @end
 
@@ -73,14 +37,6 @@ - (void)setRevealSideViewController:(PPRevealSideViewController *)revealSideView
 
 #pragma mark -
 @implementation PPRevealSideViewController
-@synthesize rootViewController = _rootViewController;
-@synthesize panInteractionsWhenClosed = _panInteractionsWhenClosed;
-@synthesize panInteractionsWhenOpened = _panInteractionsWhenOpened;
-@synthesize tapInteractionsWhenOpened = _tapInteractionsWhenOpened;
-@synthesize directionsToShowBounce = _directionsToShowBounce;
-@synthesize options = _options;
-@synthesize bouncingOffset = _bouncingOffset;
-@synthesize delegate = _delegate;
 @synthesize underStatusBarView = _underStatusBarView;
 
 - (instancetype)initWithRootViewController:(UIViewController *)rootViewController {
@@ -1549,13 +1505,65 @@ - (BOOL)prefersStatusBarHidden {
 }
 
 - (UIViewController *)childViewControllerForStatusBarStyle {
+    if (self.sideDirectionOpened != PPRevealSideDirectionNone) {
+        return [self controllerForSide:self.sideDirectionOpened];
+    }
     return self.rootViewController;
 }
 
 - (UIViewController *)childViewControllerForStatusBarHidden {
+    if (self.sideDirectionOpened != PPRevealSideDirectionNone) {
+        return [self controllerForSide:self.sideDirectionOpened];
+    }
     return self.rootViewController;
 }
 
+#pragma mark - State Restoration
+
+static NSString *kPPRevealStatePreservationCenterController = @"PPRevealStatePreservationCenterController";
+static NSString *kPPRevealStatePreservationSideController = @"PPRevealStatePreservationSideController";
+static NSString *kPPRevealStatePreservationOpenSide = @"PPRevealStatePreservationOpenSide";
+
+- (void)encodeRestorableStateWithCoder:(NSCoder *)coder {
+    [super encodeRestorableStateWithCoder:coder];
+    
+    // Encode center controller
+    [coder encodeObject:self.rootViewController forKey:kPPRevealStatePreservationCenterController];
+
+    // Encode side controllers
+    for (id key in _viewControllers) {
+        UIViewController *c = _viewControllers[key];
+        if (c) {
+            [coder encodeObject:c forKey:[NSString stringWithFormat:@"%@_%@", kPPRevealStatePreservationSideController, key]];
+        }
+    }
+    
+    // Encode opened side
+    [coder encodeInteger:self.sideDirectionOpened forKey:kPPRevealStatePreservationOpenSide];
+}
+
+- (void)decodeRestorableStateWithCoder:(NSCoder *)coder{
+    [super decodeRestorableStateWithCoder:coder];
+    
+    UIViewController *rootController = [coder decodeObjectForKey:kPPRevealStatePreservationCenterController];
+    if (rootController) {
+        // This resizing address an issue where the center controller does not have the correct height
+        [rootController.view setHeight:PPScreenHeight()];
+        [self setRootViewController:rootController];
+    }
+    
+    for (id side in @[@(PPRevealSideDirectionTop), @(PPRevealSideDirectionLeft), @(PPRevealSideDirectionRight), @(PPRevealSideDirectionBottom)]) {
+        UIViewController *controller = [coder decodeObjectForKey:[NSString stringWithFormat:@"%@_%@", kPPRevealStatePreservationSideController, side]];
+
+        if (controller) {
+            _viewControllers[side] = controller;
+        }
+    }
+    
+    PPRevealSideDirection openedDirection = [coder decodeIntegerForKey:kPPRevealStatePreservationOpenSide];
+    [self pushOldViewControllerOnDirection:openedDirection animated:NO];
+}
+
 #pragma mark - Memory management things
 
 - (void)viewWillUnload {

PPRevealSideViewController/Sample/AppDelegate.m

@@ -19,13 +19,16 @@ @implementation AppDelegate
 @synthesize window = _window;
 @synthesize revealSideViewController = _revealSideViewController;
 
-- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
+
+-(BOOL)application:(UIApplication *)application willFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     self.window = PP_AUTORELEASE([[UIWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds]]);
 
     MainViewController *main = [[MainViewController alloc] initWithNibName:@"MainViewController" bundle:nil];
 
     UINavigationController *nav = [[UINavigationController alloc] initWithRootViewController:main];
+    nav.restorationIdentifier = @"MainNav";
     _revealSideViewController = [[PPRevealSideViewController alloc] initWithRootViewController:nav];
+    _revealSideViewController.restorationIdentifier = @"PPReveal";
 
     _revealSideViewController.delegate = self;
 
@@ -37,17 +40,22 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
     PP_RELEASE(main);
     PP_RELEASE(nav);
 
+    self.revealSideViewController.fakeiOS7StatusBarColor = UIColorFromRGB(0x340085);
+
     self.window.backgroundColor = [UIColor whiteColor];
-    [self.window makeKeyAndVisible];
+    
+    return YES;
+}
+
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
+       [self.window makeKeyAndVisible];
 
     if (PPSystemVersionGreaterOrEqualThan(7.0)) {
         [[UIApplication sharedApplication] setStatusBarStyle:UIStatusBarStyleLightContent];
         [[UINavigationBar appearance] setBarTintColor:UIColorFromRGB(0x34B085)];
         [[UINavigationBar appearance] setTintColor:[UIColor whiteColor]];
     }
 
-    self.revealSideViewController.fakeiOS7StatusBarColor = UIColorFromRGB(0x340085);
-    
     return YES;
 }
 
@@ -138,4 +146,12 @@ - (void)applicationWillTerminate:(UIApplication *)application {
      */
 }
 
+- (BOOL)application:(UIApplication *)application shouldSaveApplicationState:(NSCoder *)coder {
+    return YES;
+}
+
+- (BOOL)application:(UIApplication *)application shouldRestoreApplicationState:(NSCoder *)coder {
+    return YES;
+}
+
 @end

PPRevealSideViewController/Sample/MainViewController.m

@@ -34,6 +34,9 @@ - (void)didReceiveMemoryWarning {
 
 - (void)viewDidLoad {
     [super viewDidLoad];
+    
+    self.restorationIdentifier = @"MainController";
+    
     UIBarButtonItem *left = [[UIBarButtonItem alloc] initWithTitle:@"Left"
                                                              style:UIBarButtonItemStylePlain
                                                             target:self

PPRevealSideViewController/Sample/SecondViewController.m

@@ -8,6 +8,10 @@
 
 #import "SecondViewController.h"
 
+@interface SecondViewController () <UIViewControllerRestoration>
+
+@end
+
 @implementation SecondViewController
 
 - (instancetype)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil {
@@ -29,9 +33,16 @@ - (void)didReceiveMemoryWarning {
 
 - (void)viewDidLoad {
     [super viewDidLoad];
+    
+    self.restorationIdentifier = @"SecondController";
+    self.restorationClass = [self class];
+
     // Do any additional setup after loading the view from its nib.
 }
 
++ (UIViewController *)viewControllerWithRestorationIdentifierPath:(NSArray *)identifierComponents coder:(NSCoder *)coder {
+    return [[self class] new];
+}
 - (void)viewDidUnload {
     [super viewDidUnload];
     // Release any retained subviews of the main view.

PPRevealSideViewController/Sample/TableViewController.m

@@ -15,6 +15,10 @@
 #import "WebViewController.h"
 #import "ModalViewController.h"
 
+@interface TableViewController () <UIViewControllerRestoration>
+
+@end
+
 @implementation TableViewController
 
 - (instancetype)initWithStyle:(UITableViewStyle)style {
@@ -37,10 +41,16 @@ - (void)didReceiveMemoryWarning {
     // Release any cached data, images, etc that aren't in use.
 }
 
++ (UIViewController *)viewControllerWithRestorationIdentifierPath:(NSArray *)identifierComponents coder:(NSCoder *)coder {
+    return [[[self class] alloc] initWithStyle:UITableViewStylePlain];
+}
+
 #pragma mark - View lifecycle
 
 - (void)viewDidLoad {
     [super viewDidLoad];
+    self.restorationIdentifier = @"LeftTableController";
+    self.restorationClass = [self class];
 
     [self.tableView addObserver:self
                      forKeyPath:@"revealSideInset"

README.md

@@ -70,14 +70,13 @@ PPRevealSideViewController fully supports ARC *and* non-ARC modes out of the box
 
 # Compatibility
 
-The class if fully compatible from iOS 4 to iOS 7. Not tested yet on older versions like iOS 3, but there is no reasons it doesn't work.
-Please note that this class use the new container methods of UIViewController since iOS 5. By using this class on iOS 4 for example, you need to be careful with rotation handling, and presentModalViewController stuff.
-Some things you need to be aware on iOS 4 or older :
-
-* the currentOrientation property is not passed to child controllers, so only the window rootViewController knows the currentOrientation. Always use the status bar orientation from UIApplication
-* override willAnimateRotationToInterfaceOrientation method to relayout the subviews
-* ALWAYS present modal view controller from reveal side view controller, not from the controller itself. Otherwise, you will see strange bug with memory warning and/or rotation (bad layout)
-* There is no support on iOS 4 and older of hiding and showing status bar in the app. It's ok if the status bar is initially hidden or not
+The class if fully compatible from iOS 7. I recently dropped support for previous version. So if needed, please grab a previous commit / version than [this one](https://github.com/ipup/PPRevealSideViewController/commit/6ae0c43278ec251c2d22c897d610d017bbd47dec).
+
+## State preservation and restoration
+PPReveal supports state preservation and restoration. All you need is to set a `restorationIdentifier` to all the controllers you want to restore, maybe a `restorationClass` and you're all set
+
+## Status bar style / hidden
+The status bar style and hidden are forwarded to the child controllers. If you want to remove this behavior, simply subclasse PPReveal and override both `childViewControllerForStatusBarStyle` and `childViewControllerForStatusBarHidden` to return `nil`.
 
 # Documentation