Package apple.uikit

Class UIScrollView

    • Constructor Detail

      • UIScrollView

        protected UIScrollView​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static UIScrollView allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • appearance

        @NotNull
public static @NotNull UIScrollView appearance()

      • appearanceForTraitCollection

        @NotNull
public static @NotNull UIScrollView appearanceForTraitCollection​(@NotNull
                                                                 @NotNull UITraitCollection trait)

      • appearanceForTraitCollectionWhenContainedIn

        @NotNull
@Deprecated
public static @NotNull UIScrollView appearanceForTraitCollectionWhenContainedIn​(@NotNull
                                                                                @NotNull UITraitCollection trait,
                                                                                @Nullable
                                                                                @Nullable UIAppearanceContainer ContainerClass,
                                                                                java.lang.Object... varargs)
        Deprecated.

      • appearanceForTraitCollectionWhenContainedInInstancesOfClasses

        @NotNull
public static @NotNull UIScrollView appearanceForTraitCollectionWhenContainedInInstancesOfClasses​(@NotNull
                                                                                                  @NotNull UITraitCollection trait,
                                                                                                  @NotNull
                                                                                                  @NotNull NSArray<?> containerTypes)

      • appearanceWhenContainedIn

        @NotNull
@Deprecated
public static @NotNull UIScrollView appearanceWhenContainedIn​(@Nullable
                                                              @Nullable UIAppearanceContainer ContainerClass,
                                                              java.lang.Object... varargs)
        Deprecated.

      • appearanceWhenContainedInInstancesOfClasses

        @NotNull
public static @NotNull UIScrollView appearanceWhenContainedInInstancesOfClasses​(@NotNull
                                                                                @NotNull NSArray<?> containerTypes)

      • areAnimationsEnabled

        public static boolean areAnimationsEnabled()

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • beginAnimationsContext

        @Deprecated
public static void beginAnimationsContext​(@Nullable
                                          @Nullable java.lang.String animationID,
                                          @Nullable
                                          @Nullable org.moe.natj.general.ptr.VoidPtr context)
        Deprecated.

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • clearTextInputContextIdentifier

        public static void clearTextInputContextIdentifier​(@NotNull
                                                   @NotNull java.lang.String identifier)

      • commitAnimations

        @Deprecated
public static void commitAnimations()
        Deprecated.

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • inheritedAnimationDuration

        public static double inheritedAnimationDuration()

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • layerClass

        @NotNull
public static @NotNull org.moe.natj.objc.Class layerClass()

      • requiresConstraintBasedLayout

        public static boolean requiresConstraintBasedLayout()

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setAnimationBeginsFromCurrentState

        @Deprecated
public static void setAnimationBeginsFromCurrentState​(boolean fromCurrentState)
        Deprecated.

      • setAnimationCurve

        @Deprecated
public static void setAnimationCurve​(long curve)
        Deprecated.

      • setAnimationDelay

        @Deprecated
public static void setAnimationDelay​(double delay)
        Deprecated.

      • setAnimationDelegate

        @Deprecated
public static void setAnimationDelegate​(@Nullable
                                        @Nullable java.lang.Object delegate)
        Deprecated.

      • setAnimationDidStopSelector

        @Deprecated
public static void setAnimationDidStopSelector​(@Nullable
                                               @Nullable org.moe.natj.objc.SEL selector)
        Deprecated.

      • setAnimationDuration_static

        @Deprecated
public static void setAnimationDuration_static​(double duration)
        Deprecated.

      • setAnimationRepeatAutoreverses

        @Deprecated
public static void setAnimationRepeatAutoreverses​(boolean repeatAutoreverses)
        Deprecated.

      • setAnimationRepeatCount_static

        @Deprecated
public static void setAnimationRepeatCount_static​(float repeatCount)
        Deprecated.

      • setAnimationStartDate

        @Deprecated
public static void setAnimationStartDate​(@NotNull
                                         @NotNull NSDate startDate)
        Deprecated.

      • setAnimationTransitionForViewCache

        @Deprecated
public static void setAnimationTransitionForViewCache​(long transition,
                                                      @NotNull
                                                      @NotNull UIView view,
                                                      boolean cache)
        Deprecated.

      • setAnimationWillStartSelector

        @Deprecated
public static void setAnimationWillStartSelector​(@Nullable
                                                 @Nullable org.moe.natj.objc.SEL selector)
        Deprecated.

      • setAnimationsEnabled

        public static void setAnimationsEnabled​(boolean enabled)

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • userInterfaceLayoutDirectionForSemanticContentAttribute

        public static long userInterfaceLayoutDirectionForSemanticContentAttribute​(long attribute)

      • userInterfaceLayoutDirectionForSemanticContentAttributeRelativeToLayoutDirection

        public static long userInterfaceLayoutDirectionForSemanticContentAttributeRelativeToLayoutDirection​(long semanticContentAttribute,
                                                                                                    long layoutDirection)

      • version_static

        public static long version_static()

      • alwaysBounceHorizontal

        public boolean alwaysBounceHorizontal()
        default NO. if YES and bounces is YES, even if content is smaller than bounds, allow drag horizontally

      • alwaysBounceVertical

        public boolean alwaysBounceVertical()
        default NO. if YES and bounces is YES, even if content is smaller than bounds, allow drag vertically

      • _appearance

        @NotNull
public @NotNull UIScrollView _appearance()
        Description copied from interface: UIAppearance
        To customize the appearance of all instances of a class, send the relevant appearance modification messages to the appearance proxy for the class. For example, to modify the bar tint color for all UINavigationBar instances: [[UINavigationBar appearance] setBarTintColor:myColor]; Note for iOS7: On iOS7 the tintColor property has moved to UIView, and now has special inherited behavior described in UIView.h. This inherited behavior can conflict with the appearance proxy, and therefore tintColor is now disallowed with the appearance proxy.
        Specified by:
        _appearance in interface UIAppearance
        Overrides:
        _appearance in class UIView

      • _appearanceWhenContainedIn

        @NotNull
@Deprecated
public @NotNull UIScrollView _appearanceWhenContainedIn​(@Nullable
                                                        @Nullable UIAppearanceContainer ContainerClass,
                                                        java.lang.Object... varargs)
        Deprecated.
        Description copied from interface: UIAppearance
        To customize the appearances for instances of a class contained within an instance of a container class, or instances in a hierarchy, use +appearanceWhenContainedInInstancesOfClasses: for the appropriate appearance proxy. For example: [[UINavigationBar appearanceWhenContainedInInstancesOfClasses:@[[UISplitViewController class]]] setBarTintColor:myColor]; [[UINavigationBar appearanceWhenContainedInInstancesOfClasses:@[[UITabBarController class], [UISplitViewController class]]] setBarTintColor:myTabbedNavBarColor]; In any given view hierarchy the outermost appearance proxy wins. Specificity (depth of the chain) is the tie-breaker. In other words, the containment statement is treated as a partial ordering. Given a concrete ordering (actual subview hierarchy), we select the partial ordering that is the first unique match when reading the actual hierarchy from the window down. API-Since: 5.0 Deprecated-Since: 9.0
        Specified by:
        _appearanceWhenContainedIn in interface UIAppearance
        Overrides:
        _appearanceWhenContainedIn in class UIView

      • bounces

        public boolean bounces()
        default YES. if YES, bounces past edge of content and back again

      • bouncesZoom

        public boolean bouncesZoom()
        default is YES. if set, user can go past min/max zoom while gesturing and the zoom will animate to the min/max value at gesture end

      • canCancelContentTouches

        public boolean canCancelContentTouches()
        default is YES. if NO, then once we start tracking, we don't try to drag if the touch moves. this has no effect on presses

      • contentInset

        public UIEdgeInsets contentInset()
        default UIEdgeInsetsZero. add additional scroll area around content

      • decelerationRate

        public double decelerationRate()
        API-Since: 3.0

      • delaysContentTouches

        public boolean delaysContentTouches()
        default is YES. if NO, we immediately call -touchesShouldBegin:withEvent:inContentView:. this has no effect on presses

      • delegate

        @Nullable
public @Nullable java.lang.Object delegate()
        default nil. weak reference

      • flashScrollIndicators

        public void flashScrollIndicators()
        displays the scroll indicators for a short time. This should be done whenever you bring the scroll view to front.

      • indicatorStyle

        public long indicatorStyle()
        default is UIScrollViewIndicatorStyleDefault

      • isDecelerating

        public boolean isDecelerating()
        returns YES if user isn't dragging (touch up) but scroll view is still moving

      • isDirectionalLockEnabled

        public boolean isDirectionalLockEnabled()
        default NO. if YES, try to lock vertical or horizontal scrolling while dragging

      • setDirectionalLockEnabled

        public void setDirectionalLockEnabled​(boolean value)
        default NO. if YES, try to lock vertical or horizontal scrolling while dragging

      • isDragging

        public boolean isDragging()
        returns YES if user has started scrolling. this may require some time and or distance to move to initiate dragging

      • isPagingEnabled

        public boolean isPagingEnabled()
        default NO. if YES, stop on multiples of view bounds

      • setPagingEnabled

        public void setPagingEnabled​(boolean value)
        default NO. if YES, stop on multiples of view bounds

      • isScrollEnabled

        public boolean isScrollEnabled()
        default YES. turn off any dragging temporarily

      • setScrollEnabled

        public void setScrollEnabled​(boolean value)
        default YES. turn off any dragging temporarily

      • isTracking

        public boolean isTracking()
        returns YES if user has touched. may not yet have started dragging

      • isZoomBouncing

        public boolean isZoomBouncing()
        returns YES if we are in the middle of zooming back to the min/max value

      • isZooming

        public boolean isZooming()
        returns YES if user in zoom gesture

      • keyboardDismissMode

        public long keyboardDismissMode()
        default is UIScrollViewKeyboardDismissModeNone API-Since: 7.0

      • maximumZoomScale

        public double maximumZoomScale()
        default is 1.0. must be > minimum zoom scale to enable zooming

      • minimumZoomScale

        public double minimumZoomScale()
        default is 1.0

      • panGestureRecognizer

        @NotNull
public @NotNull UIPanGestureRecognizer panGestureRecognizer()
        Change `panGestureRecognizer.allowedTouchTypes` to limit scrolling to a particular set of touch types. API-Since: 5.0

      • pinchGestureRecognizer

        @Nullable
public @Nullable UIPinchGestureRecognizer pinchGestureRecognizer()
        `pinchGestureRecognizer` will return nil when zooming is disabled. API-Since: 5.0

      • refreshControl

        @Nullable
public @Nullable UIRefreshControl refreshControl()
        API-Since: 10.0

      • scrollIndicatorInsets

        @Deprecated
public UIEdgeInsets scrollIndicatorInsets()
        Deprecated.
        API-Since: 2.0 Deprecated-Since: 13.0 Deprecated-Message: The scrollIndicatorInsets getter is deprecated, use the verticalScrollIndicatorInsets and horizontalScrollIndicatorInsets getters instead.

      • scrollRectToVisibleAnimated

        public void scrollRectToVisibleAnimated​(CGRect rect,
                                        boolean animated)
        scroll so rect is just visible (nearest edges). nothing if rect completely visible

      • scrollsToTop

        public boolean scrollsToTop()
        default is YES.

      • setAlwaysBounceHorizontal

        public void setAlwaysBounceHorizontal​(boolean value)
        default NO. if YES and bounces is YES, even if content is smaller than bounds, allow drag horizontally

      • setAlwaysBounceVertical

        public void setAlwaysBounceVertical​(boolean value)
        default NO. if YES and bounces is YES, even if content is smaller than bounds, allow drag vertically

      • setBounces

        public void setBounces​(boolean value)
        default YES. if YES, bounces past edge of content and back again

      • setBouncesZoom

        public void setBouncesZoom​(boolean value)
        default is YES. if set, user can go past min/max zoom while gesturing and the zoom will animate to the min/max value at gesture end

      • setCanCancelContentTouches

        public void setCanCancelContentTouches​(boolean value)
        default is YES. if NO, then once we start tracking, we don't try to drag if the touch moves. this has no effect on presses

      • setContentInset

        public void setContentInset​(UIEdgeInsets value)
        default UIEdgeInsetsZero. add additional scroll area around content

      • setContentOffsetAnimated

        public void setContentOffsetAnimated​(CGPoint contentOffset,
                                     boolean animated)
        animate at constant velocity to new offset

      • setContentSize

        public void setContentSize​(CGSize value)
        default CGSizeZero

      • setDecelerationRate

        public void setDecelerationRate​(double value)
        API-Since: 3.0

      • setDelaysContentTouches

        public void setDelaysContentTouches​(boolean value)
        default is YES. if NO, we immediately call -touchesShouldBegin:withEvent:inContentView:. this has no effect on presses

      • setDelegate_unsafe

        public void setDelegate_unsafe​(@Nullable
                               @Nullable java.lang.Object value)
        default nil. weak reference

      • setDelegate

        public void setDelegate​(@Nullable
                        @Nullable java.lang.Object value)
        default nil. weak reference

      • setIndicatorStyle

        public void setIndicatorStyle​(long value)
        default is UIScrollViewIndicatorStyleDefault

      • setKeyboardDismissMode

        public void setKeyboardDismissMode​(long value)
        default is UIScrollViewKeyboardDismissModeNone API-Since: 7.0

      • setMaximumZoomScale

        public void setMaximumZoomScale​(double value)
        default is 1.0. must be > minimum zoom scale to enable zooming

      • setMinimumZoomScale

        public void setMinimumZoomScale​(double value)
        default is 1.0

      • setRefreshControl

        public void setRefreshControl​(@Nullable
                              @Nullable UIRefreshControl value)
        API-Since: 10.0

      • setScrollIndicatorInsets

        public void setScrollIndicatorInsets​(UIEdgeInsets value)
        use the setter only, as a convenience for setting both verticalScrollIndicatorInsets and horizontalScrollIndicatorInsets to the same value. if those properties have been set to different values, the return value of this getter (deprecated) is undefined.

      • setScrollsToTop

        public void setScrollsToTop​(boolean value)
        default is YES.

      • setShowsHorizontalScrollIndicator

        public void setShowsHorizontalScrollIndicator​(boolean value)
        default YES. show indicator while we are tracking. fades out after tracking

      • setShowsVerticalScrollIndicator

        public void setShowsVerticalScrollIndicator​(boolean value)
        default YES. show indicator while we are tracking. fades out after tracking

      • setZoomScale

        public void setZoomScale​(double value)
        default is 1.0 API-Since: 3.0

      • setZoomScaleAnimated

        public void setZoomScaleAnimated​(double scale,
                                 boolean animated)
        API-Since: 3.0

      • showsHorizontalScrollIndicator

        public boolean showsHorizontalScrollIndicator()
        default YES. show indicator while we are tracking. fades out after tracking

      • showsVerticalScrollIndicator

        public boolean showsVerticalScrollIndicator()
        default YES. show indicator while we are tracking. fades out after tracking

      • touchesShouldBeginWithEventInContentView

        public boolean touchesShouldBeginWithEventInContentView​(@NotNull
                                                        @NotNull NSSet<? extends UITouch> touches,
                                                        @Nullable
                                                        @Nullable UIEvent event,
                                                        @NotNull
                                                        @NotNull UIView view)
        override points for subclasses to control delivery of touch events to subviews of the scroll view called before touches are delivered to a subview of the scroll view. if it returns NO the touches will not be delivered to the subview this has no effect on presses default returns YES

      • touchesShouldCancelInContentView

        public boolean touchesShouldCancelInContentView​(@NotNull
                                                @NotNull UIView view)
        called before scrolling begins if touches have already been delivered to a subview of the scroll view. if it returns NO the touches will continue to be delivered to the subview and scrolling will not occur not called if canCancelContentTouches is NO. default returns YES if view isn't a UIControl this has no effect on presses

      • zoomScale

        public double zoomScale()
        default is 1.0 API-Since: 3.0

      • zoomToRectAnimated

        public void zoomToRectAnimated​(CGRect rect,
                               boolean animated)
        API-Since: 3.0

      • adjustedContentInset

        public UIEdgeInsets adjustedContentInset()
        When contentInsetAdjustmentBehavior allows, UIScrollView may incorporate its safeAreaInsets into the adjustedContentInset. API-Since: 11.0

      • adjustedContentInsetDidChange

        public void adjustedContentInsetDidChange()
        Also see -scrollViewDidChangeAdjustedContentInset: in the UIScrollViewDelegate protocol. API-Since: 11.0

      • contentInsetAdjustmentBehavior

        public long contentInsetAdjustmentBehavior()
        Configure the behavior of adjustedContentInset. Default is UIScrollViewContentInsetAdjustmentAutomatic. API-Since: 11.0

      • contentLayoutGuide

        @NotNull
public @NotNull UILayoutGuide contentLayoutGuide()
        contentLayoutGuide anchors (e.g., contentLayoutGuide.centerXAnchor, etc.) refer to the untranslated content area of the scroll view. API-Since: 11.0

      • directionalPressGestureRecognizer

        @NotNull
public @NotNull UIGestureRecognizer directionalPressGestureRecognizer()
        `directionalPressGestureRecognizer` is disabled by default, but can be enabled to perform scrolling in response to up / down / left / right arrow button presses directly, instead of scrolling indirectly in response to focus updates.

      • frameLayoutGuide

        @NotNull
public @NotNull UILayoutGuide frameLayoutGuide()
        frameLayoutGuide anchors (e.g., frameLayoutGuide.centerXAnchor) refer to the untransformed frame of the scroll view. API-Since: 11.0

      • indexDisplayMode

        public long indexDisplayMode()

      • setContentInsetAdjustmentBehavior

        public void setContentInsetAdjustmentBehavior​(long value)
        Configure the behavior of adjustedContentInset. Default is UIScrollViewContentInsetAdjustmentAutomatic. API-Since: 11.0

      • setIndexDisplayMode

        public void setIndexDisplayMode​(long value)

      • automaticallyAdjustsScrollIndicatorInsets

        public boolean automaticallyAdjustsScrollIndicatorInsets()
        Configures whether the scroll indicator insets are automatically adjusted by the system. Default is YES. API-Since: 13.0

      • coordinateSpace

        @NotNull
public @NotNull UICoordinateSpace coordinateSpace()
        Description copied from interface: UIFocusItemContainer
        The coordinate space of the focus items contained in this container. The focus items returned by focusItemsInRect: should report their frames in this coordinate space. If you are implementing this protocol, you may find it convenient to return the UIScreen as your coordinate space, and ensure that your contained items report their frames in screen space. Similarly, you might find that your focus items' containing UIView or UIWindow is the most convenient coordinate space to use. You may also choose to implement your own object that conforms to UICoordinateSpace, if that is the most natural solution for your architecture.
        Specified by:
        coordinateSpace in interface UIFocusItemContainer
        Overrides:
        coordinateSpace in class UIView

      • focusItemsInRect

        @NotNull
public @NotNull NSArray<?> focusItemsInRect​(CGRect rect)
        Description copied from interface: UIFocusItemContainer
        Returns an array of all focus items within this container that intersect with the provided rect. `rect` is expressed in `coordinateSpace`. Note: starting in iOS & tvOS 16.0, UIView will return its subviews from this method. If you override this method in a UIView subclass, it will be your responsibility to call super and merge your array of custom focus items with UIView's default focus items.
        Specified by:
        focusItemsInRect in interface UIFocusItemContainer
        Overrides:
        focusItemsInRect in class UIView

      • horizontalScrollIndicatorInsets

        public UIEdgeInsets horizontalScrollIndicatorInsets()
        default is UIEdgeInsetsZero. API-Since: 11.1

      • setAutomaticallyAdjustsScrollIndicatorInsets

        public void setAutomaticallyAdjustsScrollIndicatorInsets​(boolean value)
        Configures whether the scroll indicator insets are automatically adjusted by the system. Default is YES. API-Since: 13.0

      • setHorizontalScrollIndicatorInsets

        public void setHorizontalScrollIndicatorInsets​(UIEdgeInsets value)
        default is UIEdgeInsetsZero. API-Since: 11.1

      • setVerticalScrollIndicatorInsets

        public void setVerticalScrollIndicatorInsets​(UIEdgeInsets value)
        default is UIEdgeInsetsZero. API-Since: 11.1

      • verticalScrollIndicatorInsets

        public UIEdgeInsets verticalScrollIndicatorInsets()
        default is UIEdgeInsetsZero. API-Since: 11.1

      • allowsKeyboardScrolling

        public boolean allowsKeyboardScrolling()
        Set this to YES to make the scroll view animate its content offset in response to keys like Page Up/Down, Home/End, and the arrow keys. The scroll view must be focused or first responder in order to receive these key events. Default is YES for apps linked after iOS 17.0. API-Since: 17.0

      • setAllowsKeyboardScrolling

        public void setAllowsKeyboardScrolling​(boolean value)
        Set this to YES to make the scroll view animate its content offset in response to keys like Page Up/Down, Home/End, and the arrow keys. The scroll view must be focused or first responder in order to receive these key events. Default is YES for apps linked after iOS 17.0. API-Since: 17.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.