Package apple.uikit.protocol

Interface UISplitViewControllerDelegate

  • public interface UISplitViewControllerDelegate

    • Method Detail

      • primaryViewControllerForCollapsingSplitViewController

        @Nullable
default @Nullable UIViewController primaryViewControllerForCollapsingSplitViewController​(@NotNull
                                                                                         @NotNull UISplitViewController splitViewController)
        Return the view controller which is to become the primary view controller after `splitViewController` is collapsed due to a transition to the horizontally-compact size class. If you return `nil`, then the argument will perform its default behavior (i.e. to use its current primary view controller). API-Since: 8.0

      • primaryViewControllerForExpandingSplitViewController

        @Nullable
default @Nullable UIViewController primaryViewControllerForExpandingSplitViewController​(@NotNull
                                                                                        @NotNull UISplitViewController splitViewController)
        Return the view controller which is to become the primary view controller after the `splitViewController` is expanded due to a transition to the horizontally-regular size class. If you return `nil`, then the argument will perform its default behavior (i.e. to use its current primary view controller.) API-Since: 8.0

      • splitViewControllerCollapseSecondaryViewControllerOntoPrimaryViewController

        default boolean splitViewControllerCollapseSecondaryViewControllerOntoPrimaryViewController​(@NotNull
                                                                                            @NotNull UISplitViewController splitViewController,
                                                                                            @NotNull
                                                                                            @NotNull UIViewController secondaryViewController,
                                                                                            @NotNull
                                                                                            @NotNull UIViewController primaryViewController)
        This method is called when a split view controller is collapsing its children for a transition to a compact-width size class. Override this method to perform custom adjustments to the view controller hierarchy of the target controller. When you return from this method, you're expected to have modified the `primaryViewController` so as to be suitable for display in a compact-width split view controller, potentially using `secondaryViewController` to do so. Return YES to prevent UIKit from applying its default behavior; return NO to request that UIKit perform its default collapsing behavior. API-Since: 8.0

      • splitViewControllerPopoverControllerWillPresentViewController

        @Deprecated
default void splitViewControllerPopoverControllerWillPresentViewController​(@NotNull
                                                                           @NotNull UISplitViewController svc,
                                                                           @NotNull
                                                                           @NotNull UIPopoverController pc,
                                                                           @NotNull
                                                                           @NotNull UIViewController aViewController)
        Deprecated.
        Called when the view controller is shown in a popover so the delegate can take action like hiding other popovers. API-Since: 2.0 Deprecated-Since: 8.0

      • splitViewControllerSeparateSecondaryViewControllerFromPrimaryViewController

        @Nullable
default @Nullable UIViewController splitViewControllerSeparateSecondaryViewControllerFromPrimaryViewController​(@NotNull
                                                                                                               @NotNull UISplitViewController splitViewController,
                                                                                                               @NotNull
                                                                                                               @NotNull UIViewController primaryViewController)
        This method is called when a split view controller is separating its child into two children for a transition from a compact-width size class to a regular-width size class. Override this method to perform custom separation behavior. The controller returned from this method will be set as the secondary view controller of the split view controller. When you return from this method, `primaryViewController` should have been configured for display in a regular-width split view controller. If you return `nil`, then `UISplitViewController` will perform its default behavior. API-Since: 8.0

      • splitViewControllerShouldHideViewControllerInOrientation

        @Deprecated
default boolean splitViewControllerShouldHideViewControllerInOrientation​(@NotNull
                                                                         @NotNull UISplitViewController svc,
                                                                         @NotNull
                                                                         @NotNull UIViewController vc,
                                                                         long orientation)
        Deprecated.
        Returns YES if a view controller should be hidden by the split view controller in a given orientation. (This method is only called on the leftmost view controller and only discriminates portrait from landscape.) API-Since: 5.0 Deprecated-Since: 8.0

      • splitViewControllerShowDetailViewControllerSender

        default boolean splitViewControllerShowDetailViewControllerSender​(@NotNull
                                                                  @NotNull UISplitViewController splitViewController,
                                                                  @NotNull
                                                                  @NotNull UIViewController vc,
                                                                  @Nullable
                                                                  @Nullable java.lang.Object sender)
        Override this method to customize the behavior of `showDetailViewController:` on a split view controller. Return YES to indicate that you've handled the action yourself; return NO to cause the default behavior to be executed. API-Since: 8.0

      • splitViewControllerShowViewControllerSender

        default boolean splitViewControllerShowViewControllerSender​(@NotNull
                                                            @NotNull UISplitViewController splitViewController,
                                                            @NotNull
                                                            @NotNull UIViewController vc,
                                                            @Nullable
                                                            @Nullable java.lang.Object sender)
        Override this method to customize the behavior of `showViewController:` on a split view controller. Return YES to indicate that you've handled the action yourself; return NO to cause the default behavior to be executed. API-Since: 8.0

      • splitViewControllerWillChangeToDisplayMode

        default void splitViewControllerWillChangeToDisplayMode​(@NotNull
                                                        @NotNull UISplitViewController svc,
                                                        long displayMode)
        This method allows a client to update any bar button items etc. API-Since: 8.0

      • splitViewControllerWillHideViewControllerWithBarButtonItemForPopoverController

        @Deprecated
default void splitViewControllerWillHideViewControllerWithBarButtonItemForPopoverController​(@NotNull
                                                                                            @NotNull UISplitViewController svc,
                                                                                            @NotNull
                                                                                            @NotNull UIViewController aViewController,
                                                                                            @NotNull
                                                                                            @NotNull UIBarButtonItem barButtonItem,
                                                                                            @NotNull
                                                                                            @NotNull UIPopoverController pc)
        Deprecated.
        Called when a button should be added to a toolbar for a hidden view controller. Implementing this method allows the hidden view controller to be presented via a swipe gesture if 'presentsWithGesture' is 'YES' (the default). API-Since: 2.0 Deprecated-Since: 8.0 Deprecated-Message: Use splitViewController:willChangeToDisplayMode: and displayModeButtonItem instead

      • splitViewControllerWillShowViewControllerInvalidatingBarButtonItem

        @Deprecated
default void splitViewControllerWillShowViewControllerInvalidatingBarButtonItem​(@NotNull
                                                                                @NotNull UISplitViewController svc,
                                                                                @NotNull
                                                                                @NotNull UIViewController aViewController,
                                                                                @NotNull
                                                                                @NotNull UIBarButtonItem barButtonItem)
        Deprecated.
        Called when the view is shown again in the split view, invalidating the button and popover controller. API-Since: 2.0 Deprecated-Since: 8.0 Deprecated-Message: Use splitViewController:willChangeToDisplayMode: and displayModeButtonItem instead

      • splitViewControllerPreferredInterfaceOrientationForPresentation

        default long splitViewControllerPreferredInterfaceOrientationForPresentation​(@NotNull
                                                                             @NotNull UISplitViewController splitViewController)
        API-Since: 7.0

      • splitViewControllerSupportedInterfaceOrientations

        default long splitViewControllerSupportedInterfaceOrientations​(@NotNull
                                                               @NotNull UISplitViewController splitViewController)
        API-Since: 7.0

      • targetDisplayModeForActionInSplitViewController

        default long targetDisplayModeForActionInSplitViewController​(@NotNull
                                                             @NotNull UISplitViewController svc)
        Called by the gesture AND barButtonItem to determine what they will set the display mode to (and what the displayModeButtonItem's appearance will be.) Return UISplitViewControllerDisplayModeAutomatic to get the default behavior. API-Since: 8.0

      • splitViewControllerDisplayModeForExpandingToProposedDisplayMode

        default long splitViewControllerDisplayModeForExpandingToProposedDisplayMode​(@NotNull
                                                                             @NotNull UISplitViewController svc,
                                                                             long proposedDisplayMode)
        API-Since: 14.0

      • splitViewControllerTopColumnForCollapsingToProposedTopColumn

        default long splitViewControllerTopColumnForCollapsingToProposedTopColumn​(@NotNull
                                                                          @NotNull UISplitViewController svc,
                                                                          long proposedTopColumn)
        API-Since: 14.0

      • splitViewControllerWillHideColumn

        default void splitViewControllerWillHideColumn​(@NotNull
                                               @NotNull UISplitViewController svc,
                                               long column)
        API-Since: 14.0

      • splitViewControllerWillShowColumn

        default void splitViewControllerWillShowColumn​(@NotNull
                                               @NotNull UISplitViewController svc,
                                               long column)
        API-Since: 14.0

      • splitViewControllerDidCollapse

        default void splitViewControllerDidCollapse​(@NotNull
                                            @NotNull UISplitViewController svc)
        API-Since: 14.0

      • splitViewControllerDidExpand

        default void splitViewControllerDidExpand​(@NotNull
                                          @NotNull UISplitViewController svc)
        API-Since: 14.0

      • splitViewControllerInteractivePresentationGestureDidEnd

        default void splitViewControllerInteractivePresentationGestureDidEnd​(@NotNull
                                                                     @NotNull UISplitViewController svc)
        API-Since: 14.0

      • splitViewControllerInteractivePresentationGestureWillBegin

        default void splitViewControllerInteractivePresentationGestureWillBegin​(@NotNull
                                                                        @NotNull UISplitViewController svc)
        API-Since: 14.0