Package apple.uikit

Class UINavigationItem

    • Constructor Detail

      • UINavigationItem

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

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

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

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

      • backBarButtonItem

        @Nullable
public @Nullable UIBarButtonItem backBarButtonItem()
        Bar button item to use for the back button when this item is the navigation bar's backItem.

      • hidesBackButton

        public boolean hidesBackButton()
        If YES, this navigation item will hide the back button when it's on top of the stack.

      • initWithTitle

        public UINavigationItem initWithTitle​(@NotNull
                                      @NotNull java.lang.String title)

      • leftBarButtonItem

        @Nullable
public @Nullable UIBarButtonItem leftBarButtonItem()
        Some navigation items want to display a custom left or right item when they're on top of the stack. A custom left item replaces the regular back button unless you set leftItemsSupplementBackButton to YES

      • leftBarButtonItems

        @Nullable
public @Nullable NSArray<? extends UIBarButtonItem> leftBarButtonItems()
        Use these properties to set multiple items in a navigation bar. The older single properties (leftBarButtonItem and rightBarButtonItem) now refer to the first item in the respective array of items. NOTE: You'll achieve the best results if you use either the singular properties or the plural properties consistently and don't try to mix them. leftBarButtonItems are placed in the navigation bar left to right with the first item in the list at the left outside edge and left aligned. rightBarButtonItems are placed right to left with the first item in the list at the right outside edge and right aligned. API-Since: 5.0

      • leftItemsSupplementBackButton

        public boolean leftItemsSupplementBackButton()
        By default, the leftItemsSupplementBackButton property is NO. In this case, the back button is not drawn and the left item or items replace it. If you would like the left items to appear in addition to the back button (as opposed to instead of it) set leftItemsSupplementBackButton to YES. API-Since: 5.0

      • prompt

        @Nullable
public @Nullable java.lang.String prompt()
        Explanatory text to display above the navigation bar buttons.

      • rightBarButtonItem

        @Nullable
public @Nullable UIBarButtonItem rightBarButtonItem()

      • rightBarButtonItems

        @Nullable
public @Nullable NSArray<? extends UIBarButtonItem> rightBarButtonItems()
        API-Since: 5.0

      • setBackBarButtonItem

        public void setBackBarButtonItem​(@Nullable
                                 @Nullable UIBarButtonItem value)
        Bar button item to use for the back button when this item is the navigation bar's backItem.

      • setHidesBackButton

        public void setHidesBackButton​(boolean value)
        If YES, this navigation item will hide the back button when it's on top of the stack.

      • setHidesBackButtonAnimated

        public void setHidesBackButtonAnimated​(boolean hidesBackButton,
                                       boolean animated)

      • setLeftBarButtonItem

        public void setLeftBarButtonItem​(@Nullable
                                 @Nullable UIBarButtonItem value)
        Some navigation items want to display a custom left or right item when they're on top of the stack. A custom left item replaces the regular back button unless you set leftItemsSupplementBackButton to YES

      • setLeftBarButtonItemAnimated

        public void setLeftBarButtonItemAnimated​(@Nullable
                                         @Nullable UIBarButtonItem item,
                                         boolean animated)

      • setLeftBarButtonItems

        public void setLeftBarButtonItems​(@Nullable
                                  @Nullable NSArray<? extends UIBarButtonItem> value)
        Use these properties to set multiple items in a navigation bar. The older single properties (leftBarButtonItem and rightBarButtonItem) now refer to the first item in the respective array of items. NOTE: You'll achieve the best results if you use either the singular properties or the plural properties consistently and don't try to mix them. leftBarButtonItems are placed in the navigation bar left to right with the first item in the list at the left outside edge and left aligned. rightBarButtonItems are placed right to left with the first item in the list at the right outside edge and right aligned. API-Since: 5.0

      • setLeftBarButtonItemsAnimated

        public void setLeftBarButtonItemsAnimated​(@Nullable
                                          @Nullable NSArray<? extends UIBarButtonItem> items,
                                          boolean animated)
        API-Since: 5.0

      • setLeftItemsSupplementBackButton

        public void setLeftItemsSupplementBackButton​(boolean value)
        By default, the leftItemsSupplementBackButton property is NO. In this case, the back button is not drawn and the left item or items replace it. If you would like the left items to appear in addition to the back button (as opposed to instead of it) set leftItemsSupplementBackButton to YES. API-Since: 5.0

      • setPrompt

        public void setPrompt​(@Nullable
                      @Nullable java.lang.String value)
        Explanatory text to display above the navigation bar buttons.

      • setRightBarButtonItem

        public void setRightBarButtonItem​(@Nullable
                                  @Nullable UIBarButtonItem value)

      • setRightBarButtonItemAnimated

        public void setRightBarButtonItemAnimated​(@Nullable
                                          @Nullable UIBarButtonItem item,
                                          boolean animated)

      • setRightBarButtonItems

        public void setRightBarButtonItems​(@Nullable
                                   @Nullable NSArray<? extends UIBarButtonItem> value)
        API-Since: 5.0

      • setRightBarButtonItemsAnimated

        public void setRightBarButtonItemsAnimated​(@Nullable
                                           @Nullable NSArray<? extends UIBarButtonItem> items,
                                           boolean animated)
        API-Since: 5.0

      • setTitle

        public void setTitle​(@Nullable
                     @Nullable java.lang.String value)
        Title when topmost on the stack. default is nil

      • setTitleView

        public void setTitleView​(@Nullable
                         @Nullable UIView value)
        Custom view to use in lieu of a title. May be sized horizontally. Only used when item is topmost on the stack.

      • title

        @Nullable
public @Nullable java.lang.String title()
        Title when topmost on the stack. default is nil

      • titleView

        @Nullable
public @Nullable UIView titleView()
        Custom view to use in lieu of a title. May be sized horizontally. Only used when item is topmost on the stack.

      • hidesSearchBarWhenScrolling

        public boolean hidesSearchBarWhenScrolling()
        If this property is true (the default), the searchController’s search bar will hide as the user scrolls in the top view controller’s scroll view. If false, the search bar will remain visible and pinned underneath the navigation bar. Not appicable and ignored for UINavigationItemSearchBarPlacementInline API-Since: 11.0

      • largeTitleDisplayMode

        public long largeTitleDisplayMode()
        When UINavigationBar.prefersLargeTitles=YES, this property controls when the larger out-of-line title is displayed. If prefersLargeTitles=NO, this property has no effect. The default value is Automatic. API-Since: 11.0

      • searchController

        @Nullable
public @Nullable UISearchController searchController()
        A view controller that will be shown inside of a navigation controller can assign a UISearchController to this property to display the search controller’s search bar in its containing navigation controller’s navigation bar. API-Since: 11.0

      • setHidesSearchBarWhenScrolling

        public void setHidesSearchBarWhenScrolling​(boolean value)
        If this property is true (the default), the searchController’s search bar will hide as the user scrolls in the top view controller’s scroll view. If false, the search bar will remain visible and pinned underneath the navigation bar. Not appicable and ignored for UINavigationItemSearchBarPlacementInline API-Since: 11.0

      • setLargeTitleDisplayMode

        public void setLargeTitleDisplayMode​(long value)
        When UINavigationBar.prefersLargeTitles=YES, this property controls when the larger out-of-line title is displayed. If prefersLargeTitles=NO, this property has no effect. The default value is Automatic. API-Since: 11.0

      • setSearchController

        public void setSearchController​(@Nullable
                                @Nullable UISearchController value)
        A view controller that will be shown inside of a navigation controller can assign a UISearchController to this property to display the search controller’s search bar in its containing navigation controller’s navigation bar. API-Since: 11.0

      • compactAppearance

        @Nullable
public @Nullable UINavigationBarAppearance compactAppearance()
        When set and this item is topmost, overrides the hosting navigation bar's compactAppearance. See UINavigationBar.compactAppearance for further details. API-Since: 13.0

      • scrollEdgeAppearance

        @Nullable
public @Nullable UINavigationBarAppearance scrollEdgeAppearance()
        When set and this item is topmost, overrides the hosting navigation bar's scrollEdgeAppearance. See UINavigationBar.scrollEdgeAppearance for further details. API-Since: 13.0

      • setCompactAppearance

        public void setCompactAppearance​(@Nullable
                                 @Nullable UINavigationBarAppearance value)
        When set and this item is topmost, overrides the hosting navigation bar's compactAppearance. See UINavigationBar.compactAppearance for further details. API-Since: 13.0

      • setScrollEdgeAppearance

        public void setScrollEdgeAppearance​(@Nullable
                                    @Nullable UINavigationBarAppearance value)
        When set and this item is topmost, overrides the hosting navigation bar's scrollEdgeAppearance. See UINavigationBar.scrollEdgeAppearance for further details. API-Since: 13.0

      • setStandardAppearance

        public void setStandardAppearance​(@Nullable
                                  @Nullable UINavigationBarAppearance value)
        When set and this item is topmost, overrides the hosting navigation bar's standardAppearance. See UINavigationBar.standardAppearance for further details. API-Since: 13.0

      • standardAppearance

        @Nullable
public @Nullable UINavigationBarAppearance standardAppearance()
        When set and this item is topmost, overrides the hosting navigation bar's standardAppearance. See UINavigationBar.standardAppearance for further details. API-Since: 13.0

      • backButtonDisplayMode

        public long backButtonDisplayMode()
        Controls how the back button sources its title. API-Since: 14.0

      • backButtonTitle

        @Nullable
public @Nullable java.lang.String backButtonTitle()
        Title to use when this item is the navigation bar's backItem. Default is nil. backBarButtonItem takes precedence if both are specified. API-Since: 11.0

      • setBackButtonDisplayMode

        public void setBackButtonDisplayMode​(long value)
        Controls how the back button sources its title. API-Since: 14.0

      • setBackButtonTitle

        public void setBackButtonTitle​(@Nullable
                               @Nullable java.lang.String value)
        Title to use when this item is the navigation bar's backItem. Default is nil. backBarButtonItem takes precedence if both are specified. API-Since: 11.0

      • compactScrollEdgeAppearance

        @Nullable
public @Nullable UINavigationBarAppearance compactScrollEdgeAppearance()
        When set and this item is topmost, overrides the hosting navigation bar's compactScrollEdgeAppearance. See UINavigationBar.h for further details. API-Since: 15.0

      • setCompactScrollEdgeAppearance

        public void setCompactScrollEdgeAppearance​(@Nullable
                                           @Nullable UINavigationBarAppearance value)
        When set and this item is topmost, overrides the hosting navigation bar's compactScrollEdgeAppearance. See UINavigationBar.h for further details. API-Since: 15.0

      • additionalOverflowItems

        @Nullable
public @Nullable UIDeferredMenuElement additionalOverflowItems()
        Additional items to add to the overflow menu. Setting this property to a non-nil value will force the overflow button to appear, regardless of if you provide any content in the element's callback. Items returned are displayed directly in the presented menu. API-Since: 16.0

      • backAction

        @Nullable
public @Nullable UIAction backAction()
        Replaces the back action for the navigation bar. if a back button is naturally present, this replaces only its action, otherwise a back button will be synthesized with the image or title from the action. API-Since: 16.0

      • centerItemGroups

        @NotNull
public @NotNull NSArray<? extends UIBarButtonItemGroup> centerItemGroups()
        Customizable UIBarButtonItemGroups that will be placed in the center region when the navigation bar is the browser or editor modes. In navigation mode, these items will be placed in the overflow. API-Since: 16.0

      • customizationIdentifier

        @Nullable
public @Nullable java.lang.String customizationIdentifier()
        Setting a non-nil customizationIdentifier enables customization and UIKit will automatically save & restore customizations based on this identifier. The identifier must be unique within the scope of the application. API-Since: 16.0

      • documentProperties

        @Nullable
public @Nullable UIDocumentProperties documentProperties()
        When non-nil, UIKit will use the metadata provided to generate additional controls displayed from the title. API-Since: 16.0

      • leadingItemGroups

        @NotNull
public @NotNull NSArray<? extends UIBarButtonItemGroup> leadingItemGroups()
        UIBarButtonItemGroups to be displayed in the leading section of the navigation bar. Items set via this method will replace items set via .leftBarButtonItem or .leftBarButtonItems. API-Since: 16.0

      • overflowPresentationSource

        @Nullable
public @Nullable UIPopoverPresentationControllerSourceItem overflowPresentationSource()
        If the overflow button for this item is currently present, then this will return a non-nil item that can be used as a presentation source (e.g. for popovers). Otherwise it will return nil. API-Since: 16.0

      • pinnedTrailingGroup

        @Nullable
public @Nullable UIBarButtonItemGroup pinnedTrailingGroup()
        Set a group of items to be placed on the trailing edge of the bar, past the overflow & search items (if present). If you wish to have more than 1 item, it is HIGHLY recommended to assign a representative item to the group to avoid overflowing the bar as this group cannot move to the overflow. API-Since: 16.0

      • preferredSearchBarPlacement

        public long preferredSearchBarPlacement()
        The preferred search bar placement, when a search controller is assigned to this item. API-Since: 16.0

      • renameDelegate

        @Nullable
public @Nullable UINavigationItemRenameDelegate renameDelegate()
        When non-nil, enables the UINavigationBar to respond to the rename: action by providing an inline UI. Setting this property to nil while a rename operation is in progress will cancel the operation immediately. API-Since: 16.0

      • searchBarPlacement

        public long searchBarPlacement()
        The realized placement. Only valid if a search controller has been assigned to this item. API-Since: 16.0

      • setAdditionalOverflowItems

        public void setAdditionalOverflowItems​(@Nullable
                                       @Nullable UIDeferredMenuElement value)
        Additional items to add to the overflow menu. Setting this property to a non-nil value will force the overflow button to appear, regardless of if you provide any content in the element's callback. Items returned are displayed directly in the presented menu. API-Since: 16.0

      • setBackAction

        public void setBackAction​(@Nullable
                          @Nullable UIAction value)
        Replaces the back action for the navigation bar. if a back button is naturally present, this replaces only its action, otherwise a back button will be synthesized with the image or title from the action. API-Since: 16.0

      • setCenterItemGroups

        public void setCenterItemGroups​(@NotNull
                                @NotNull NSArray<? extends UIBarButtonItemGroup> value)
        Customizable UIBarButtonItemGroups that will be placed in the center region when the navigation bar is the browser or editor modes. In navigation mode, these items will be placed in the overflow. API-Since: 16.0

      • setCustomizationIdentifier

        public void setCustomizationIdentifier​(@Nullable
                                       @Nullable java.lang.String value)
        Setting a non-nil customizationIdentifier enables customization and UIKit will automatically save & restore customizations based on this identifier. The identifier must be unique within the scope of the application. API-Since: 16.0

      • setDocumentProperties

        public void setDocumentProperties​(@Nullable
                                  @Nullable UIDocumentProperties value)
        When non-nil, UIKit will use the metadata provided to generate additional controls displayed from the title. API-Since: 16.0

      • setLeadingItemGroups

        public void setLeadingItemGroups​(@NotNull
                                 @NotNull NSArray<? extends UIBarButtonItemGroup> value)
        UIBarButtonItemGroups to be displayed in the leading section of the navigation bar. Items set via this method will replace items set via .leftBarButtonItem or .leftBarButtonItems. API-Since: 16.0

      • setPinnedTrailingGroup

        public void setPinnedTrailingGroup​(@Nullable
                                   @Nullable UIBarButtonItemGroup value)
        Set a group of items to be placed on the trailing edge of the bar, past the overflow & search items (if present). If you wish to have more than 1 item, it is HIGHLY recommended to assign a representative item to the group to avoid overflowing the bar as this group cannot move to the overflow. API-Since: 16.0

      • setPreferredSearchBarPlacement

        public void setPreferredSearchBarPlacement​(long value)
        The preferred search bar placement, when a search controller is assigned to this item. API-Since: 16.0

      • setRenameDelegate_unsafe

        public void setRenameDelegate_unsafe​(@Nullable
                                     @Nullable UINavigationItemRenameDelegate value)
        When non-nil, enables the UINavigationBar to respond to the rename: action by providing an inline UI. Setting this property to nil while a rename operation is in progress will cancel the operation immediately. API-Since: 16.0

      • setRenameDelegate

        public void setRenameDelegate​(@Nullable
                              @Nullable UINavigationItemRenameDelegate value)
        When non-nil, enables the UINavigationBar to respond to the rename: action by providing an inline UI. Setting this property to nil while a rename operation is in progress will cancel the operation immediately. API-Since: 16.0

      • setStyle

        public void setStyle​(long value)
        Controls how content defined by this item is laid out in the navigation bar. API-Since: 16.0

      • setTitleMenuProvider

        public void setTitleMenuProvider​(@Nullable
                                 @Nullable UINavigationItem.Block_setTitleMenuProvider value)
        When non-nil, UIKit will generate suggestedActions and call this block to generate a menu that is displayed from the title. API-Since: 16.0

      • setTrailingItemGroups

        public void setTrailingItemGroups​(@NotNull
                                  @NotNull NSArray<? extends UIBarButtonItemGroup> value)
        UIBarButtonItemGroups to be displayed in the trailing section of the navigation bar. Items set via this method will replace items set via .rightBarButtonItem or .rightBarButtonItems. API-Since: 16.0

      • style

        public long style()
        Controls how content defined by this item is laid out in the navigation bar. API-Since: 16.0

      • titleMenuProvider

        @Nullable
public @Nullable UINavigationItem.Block_titleMenuProvider_ret titleMenuProvider()
        When non-nil, UIKit will generate suggestedActions and call this block to generate a menu that is displayed from the title. API-Since: 16.0

      • trailingItemGroups

        @NotNull
public @NotNull NSArray<? extends UIBarButtonItemGroup> trailingItemGroups()
        UIBarButtonItemGroups to be displayed in the trailing section of the navigation bar. Items set via this method will replace items set via .rightBarButtonItem or .rightBarButtonItems. API-Since: 16.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.