Package apple.uikit

Class UISearchController

    • Constructor Detail

      • UISearchController

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

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

      • attemptRotationToDeviceOrientation

        @Deprecated
public static void attemptRotationToDeviceOrientation()
        Deprecated.

      • automaticallyNotifiesObserversForKey

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

      • 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)

      • 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()

      • 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)

      • resolveClassMethod

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

      • resolveInstanceMethod

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

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

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

      • version_static

        public static long version_static()

      • dimsBackgroundDuringPresentation

        @Deprecated
public boolean dimsBackgroundDuringPresentation()
        Deprecated.
        default is YES, and has the same behavior as obscuresBackgroundDuringPresentation. API-Since: 8.0 Deprecated-Since: 12.0

      • hidesNavigationBarDuringPresentation

        public boolean hidesNavigationBarDuringPresentation()
        default is YES

      • initWithSearchResultsController

        public UISearchController initWithSearchResultsController​(@Nullable
                                                          @Nullable UIViewController searchResultsController)
        Pass nil if you wish to display search results in the same view that you are searching. This is not supported on tvOS; please provide a results controller on tvOS.

      • isActive

        public boolean isActive()
        Setting this property to YES is a convenience method that performs a default presentation of the search controller appropriate for how the controller is configured. Implement -presentSearchController: if the default presentation is not adequate.

      • setActive

        public void setActive​(boolean value)
        Setting this property to YES is a convenience method that performs a default presentation of the search controller appropriate for how the controller is configured. Implement -presentSearchController: if the default presentation is not adequate.

      • obscuresBackgroundDuringPresentation

        public boolean obscuresBackgroundDuringPresentation()
        On iOS, default is NO for apps linked on iOS 15.0 and later, YES otherwise. On tvOS, default is NO when contained in UISearchContainerViewController, YES otherwise. API-Since: 9.1

      • searchBar

        @NotNull
public @NotNull UISearchBar searchBar()
        You are free to become the search bar's delegate to monitor for text changes and button presses.

      • searchResultsController

        @Nullable
public @Nullable UIViewController searchResultsController()

      • searchResultsUpdater

        @Nullable
public @Nullable UISearchResultsUpdating searchResultsUpdater()
        The object responsible for updating the content of the searchResultsController.

      • setDimsBackgroundDuringPresentation

        @Deprecated
public void setDimsBackgroundDuringPresentation​(boolean value)
        Deprecated.
        default is YES, and has the same behavior as obscuresBackgroundDuringPresentation. API-Since: 8.0 Deprecated-Since: 12.0

      • setHidesNavigationBarDuringPresentation

        public void setHidesNavigationBarDuringPresentation​(boolean value)
        default is YES

      • setObscuresBackgroundDuringPresentation

        public void setObscuresBackgroundDuringPresentation​(boolean value)
        On iOS, default is NO for apps linked on iOS 15.0 and later, YES otherwise. On tvOS, default is NO when contained in UISearchContainerViewController, YES otherwise. API-Since: 9.1

      • setSearchResultsUpdater_unsafe

        public void setSearchResultsUpdater_unsafe​(@Nullable
                                           @Nullable UISearchResultsUpdating value)
        The object responsible for updating the content of the searchResultsController.

      • setSearchResultsUpdater

        public void setSearchResultsUpdater​(@Nullable
                                    @Nullable UISearchResultsUpdating value)
        The object responsible for updating the content of the searchResultsController.

      • automaticallyShowsCancelButton

        public boolean automaticallyShowsCancelButton()
        Default YES API-Since: 13.0

      • automaticallyShowsScopeBar

        @Deprecated
public boolean automaticallyShowsScopeBar()
        Deprecated.
        By default, UISearchController will show the search bar's scope bar (when there are at least two scope button titles for the search bar) when search becomes active and hide it when search is dismissed. Clients can take over showing and hiding the scope bar by setting automaticallyShowsScopeBar to NO and using UISearchBar's showsScopeBar property to manage scope bar visibility. Additionally, setting the showsScopeBar property on the searchController's searchBar will change the UISearchController's automaticallyShowsScopeBar property to NO. On iOS, this will be fully deprecated in a future release in favor of `scopeBarActivation` API-Since: 13.0 Deprecated-Since: 100000.0 Deprecated-Message: Use scopeBarActivation instead

      • automaticallyShowsSearchResultsController

        public boolean automaticallyShowsSearchResultsController()
        When true, UISearchController will automatically show its results controller based on the contents of its text property. Defaults to true. Setting the showsSearchResultsController property will change this property to false. API-Since: 13.0

      • setAutomaticallyShowsCancelButton

        public void setAutomaticallyShowsCancelButton​(boolean value)
        Default YES API-Since: 13.0

      • setAutomaticallyShowsScopeBar

        @Deprecated
public void setAutomaticallyShowsScopeBar​(boolean value)
        Deprecated.
        By default, UISearchController will show the search bar's scope bar (when there are at least two scope button titles for the search bar) when search becomes active and hide it when search is dismissed. Clients can take over showing and hiding the scope bar by setting automaticallyShowsScopeBar to NO and using UISearchBar's showsScopeBar property to manage scope bar visibility. Additionally, setting the showsScopeBar property on the searchController's searchBar will change the UISearchController's automaticallyShowsScopeBar property to NO. On iOS, this will be fully deprecated in a future release in favor of `scopeBarActivation` API-Since: 13.0 Deprecated-Since: 100000.0 Deprecated-Message: Use scopeBarActivation instead

      • setAutomaticallyShowsSearchResultsController

        public void setAutomaticallyShowsSearchResultsController​(boolean value)
        When true, UISearchController will automatically show its results controller based on the contents of its text property. Defaults to true. Setting the showsSearchResultsController property will change this property to false. API-Since: 13.0

      • setShowsSearchResultsController

        public void setShowsSearchResultsController​(boolean value)
        Set this property to directly control the visibility of the search results controller. Setting this property changes the automaticallyShowsSearchResultsController property to false. API-Since: 13.0

      • showsSearchResultsController

        public boolean showsSearchResultsController()
        Set this property to directly control the visibility of the search results controller. Setting this property changes the automaticallyShowsSearchResultsController property to false. API-Since: 13.0

      • ignoresSearchSuggestionsForSearchBarPlacementStacked

        public boolean ignoresSearchSuggestionsForSearchBarPlacementStacked()
        Default NO. When YES, the UISearchController will not create its internal child view controller for presenting the list of search suggestions when the searchBarPlacement is stacked. This property is intended to be set at the time that the search controller is initialized. If set after that point, the internal view controller will not be destroyed, but its view will be hidden and remain so. API-Since: 16.0

      • scopeBarActivation

        public long scopeBarActivation()
        Controls if and when the UISearchController shows and hides the scope bar However, UISearchBar will not show the scope bar if `scopeButtonTitles` contains fewer than two titles Defaults to `UISearchControllerScopeBarActivationAutomatic` `UISearchControllerScopeBarActivationAutomatic` is equivalent to earlier `automaticallyShowsScopeBar == YES` `UISearchControllerScopeBarActivationManual` is equivalent to earlier `automaticallyShowsScopeBar == NO` Similar to the behavior of `automaticallyShowsScopeBar`, setting the `showsScopeBar` property on the `searchController`'s `searchBar` will change `scopeBarActivation` to `UISearchControllerScopeBarActivationManual` API-Since: 16.0

      • searchBarPlacement

        public long searchBarPlacement()
        For inspecting the current placement of the search bar when the search controller has been assigned to a UINavigationItem API-Since: 16.0

      • searchSuggestions

        @Nullable
public @Nullable NSArray<?> searchSuggestions()
        List of search hint objects to be displayed under keyboard on tvOS, as a menu under the search field when the search bar is placed inline on iOS 16, or as a list in front of the searchResultsController when the search bar is stacked. Assigning with new array immediately updates the list on screen. searchSuggestions is set to nil when user interaction selects a suggestion, or when the user otherwise interacts with search (e.g., typing in the search field, choosing a different search scope, canceling search) after dismissing the menu by tapping outside API-Since: 16.0

      • setIgnoresSearchSuggestionsForSearchBarPlacementStacked

        public void setIgnoresSearchSuggestionsForSearchBarPlacementStacked​(boolean value)
        Default NO. When YES, the UISearchController will not create its internal child view controller for presenting the list of search suggestions when the searchBarPlacement is stacked. This property is intended to be set at the time that the search controller is initialized. If set after that point, the internal view controller will not be destroyed, but its view will be hidden and remain so. API-Since: 16.0

      • setScopeBarActivation

        public void setScopeBarActivation​(long value)
        Controls if and when the UISearchController shows and hides the scope bar However, UISearchBar will not show the scope bar if `scopeButtonTitles` contains fewer than two titles Defaults to `UISearchControllerScopeBarActivationAutomatic` `UISearchControllerScopeBarActivationAutomatic` is equivalent to earlier `automaticallyShowsScopeBar == YES` `UISearchControllerScopeBarActivationManual` is equivalent to earlier `automaticallyShowsScopeBar == NO` Similar to the behavior of `automaticallyShowsScopeBar`, setting the `showsScopeBar` property on the `searchController`'s `searchBar` will change `scopeBarActivation` to `UISearchControllerScopeBarActivationManual` API-Since: 16.0

      • setSearchSuggestions

        public void setSearchSuggestions​(@Nullable
                                 @Nullable NSArray<?> value)
        List of search hint objects to be displayed under keyboard on tvOS, as a menu under the search field when the search bar is placed inline on iOS 16, or as a list in front of the searchResultsController when the search bar is stacked. Assigning with new array immediately updates the list on screen. searchSuggestions is set to nil when user interaction selects a suggestion, or when the user otherwise interacts with search (e.g., typing in the search field, choosing a different search scope, canceling search) after dismissing the menu by tapping outside API-Since: 16.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.