apple.uikit.protocol

Interface UIViewControllerTransitionCoordinator

All Superinterfaces:

UIViewControllerTransitionCoordinatorContext

public interface UIViewControllerTransitionCoordinator
extends UIViewControllerTransitionCoordinatorContext

An object conforming to this protocol is returned by -[UIViewController transitionCoordinator] when an active transition or presentation/dismissal is in flight. A container controller may not vend such an object. This is an ephemeral object that is released after the transition completes and the last callback has been made.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UIViewControllerTransitionCoordinator.Block_animateAlongsideTransitionCompletion_0
static interface	UIViewControllerTransitionCoordinator.Block_animateAlongsideTransitionCompletion_1
static interface	UIViewControllerTransitionCoordinator.Block_animateAlongsideTransitionInViewAnimationCompletion_1
static interface	UIViewControllerTransitionCoordinator.Block_animateAlongsideTransitionInViewAnimationCompletion_2
static interface	UIViewControllerTransitionCoordinator.Block_notifyWhenInteractionChangesUsingBlock
static interface	UIViewControllerTransitionCoordinator.Block_notifyWhenInteractionEndsUsingBlock

Method Summary

Modifier and Type	Method and Description
boolean	animateAlongsideTransitionCompletion(UIViewControllerTransitionCoordinator.Block_animateAlongsideTransitionCompletion_0 animation, UIViewControllerTransitionCoordinator.Block_animateAlongsideTransitionCompletion_1 completion) Any animations specified will be run in the same animation context as the transition.
boolean	animateAlongsideTransitionInViewAnimationCompletion(UIView view, UIViewControllerTransitionCoordinator.Block_animateAlongsideTransitionInViewAnimationCompletion_1 animation, UIViewControllerTransitionCoordinator.Block_animateAlongsideTransitionInViewAnimationCompletion_2 completion) This alternative API is needed if the view is not a descendent of the container view AND you require this animation to be driven by a UIPercentDrivenInteractiveTransition interaction controller.
void	notifyWhenInteractionChangesUsingBlock(UIViewControllerTransitionCoordinator.Block_notifyWhenInteractionChangesUsingBlock handler) This method behavior is identical to the method above.
void	notifyWhenInteractionEndsUsingBlock(UIViewControllerTransitionCoordinator.Block_notifyWhenInteractionEndsUsingBlock handler) When a transition changes from interactive to non-interactive then handler is invoked.

Methods inherited from interface apple.uikit.protocol.UIViewControllerTransitionCoordinatorContext

completionCurve, completionVelocity, containerView, initiallyInteractive, isAnimated, isCancelled, isInteractive, isInterruptible, percentComplete, presentationStyle, targetTransform, transitionDuration, viewControllerForKey, viewForKey

Method Detail

animateAlongsideTransitionCompletion

boolean animateAlongsideTransitionCompletion(UIViewControllerTransitionCoordinator.Block_animateAlongsideTransitionCompletion_0 animation,
                                             UIViewControllerTransitionCoordinator.Block_animateAlongsideTransitionCompletion_1 completion)

Any animations specified will be run in the same animation context as the transition. If the animations are occurring in a view that is a not descendent of the containerView, then an ancestor view in which all of the animations are occurring should be specified. The completionBlock is invoked after the transition completes. (Note that this may not be after all the animations specified by to call complete if the duration is not inherited.) It is perfectly legitimate to only specify a completion block. This method returns YES if the animations are successfully queued to run. The completions may be run even if the animations are not. Note that for transitioning animators that are not implemented with UIView animations, the alongside animations will be run just after their animateTransition: method returns.

animateAlongsideTransitionInViewAnimationCompletion

boolean animateAlongsideTransitionInViewAnimationCompletion(UIView view,
                                                            UIViewControllerTransitionCoordinator.Block_animateAlongsideTransitionInViewAnimationCompletion_1 animation,
                                                            UIViewControllerTransitionCoordinator.Block_animateAlongsideTransitionInViewAnimationCompletion_2 completion)

This alternative API is needed if the view is not a descendent of the container view AND you require this animation to be driven by a UIPercentDrivenInteractiveTransition interaction controller.

notifyWhenInteractionChangesUsingBlock

void notifyWhenInteractionChangesUsingBlock(UIViewControllerTransitionCoordinator.Block_notifyWhenInteractionChangesUsingBlock handler)

This method behavior is identical to the method above. On 10.0, however, the behavior has changed slightly to account for the fact that transitions can be interruptible. For interruptible transitions The block may be called multiple times. It is called each time the transition moves from an interactive to a non-interactive state and vice-versa. The block is now also retained until the transition has completed.

notifyWhenInteractionEndsUsingBlock

void notifyWhenInteractionEndsUsingBlock(UIViewControllerTransitionCoordinator.Block_notifyWhenInteractionEndsUsingBlock handler)

When a transition changes from interactive to non-interactive then handler is invoked. The handler will typically then do something depending on whether or not the transition isCancelled. Note that only interactive transitions can be cancelled and all interactive transitions complete as non-interactive ones. In general, when a transition is cancelled the view controller that was appearing will receive a viewWillDisappear: call, and the view controller that was disappearing will receive a viewWillAppear: call. This handler is invoked BEFORE the "will" method calls are made.