Package apple.uikit

Class UIBarButtonItem

    • Constructor Detail

      • UIBarButtonItem

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

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

      • appearance

        @NotNull
public static @NotNull UIBarButtonItem appearance()

      • appearanceForTraitCollectionWhenContainedIn

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

      • appearanceForTraitCollectionWhenContainedInInstancesOfClasses

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

      • appearanceWhenContainedIn

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

      • appearanceWhenContainedInInstancesOfClasses

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

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

      • action

        @Nullable
public @Nullable org.moe.natj.objc.SEL action()
        default is NULL

      • _appearance

        @NotNull
public @NotNull UIBarButtonItem _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 UIBarItem

      • _appearanceWhenContainedIn

        @NotNull
@Deprecated
public @NotNull UIBarButtonItem _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 UIBarItem

      • backButtonBackgroundImageForStateBarMetrics

        @Nullable
public @Nullable UIImage backButtonBackgroundImageForStateBarMetrics​(long state,
                                                                     long barMetrics)
        API-Since: 5.0

      • backButtonBackgroundVerticalPositionAdjustmentForBarMetrics

        public double backButtonBackgroundVerticalPositionAdjustmentForBarMetrics​(long barMetrics)
        API-Since: 5.0

      • backButtonTitlePositionAdjustmentForBarMetrics

        public UIOffset backButtonTitlePositionAdjustmentForBarMetrics​(long barMetrics)
        API-Since: 5.0

      • backgroundImageForStateBarMetrics

        @Nullable
public @Nullable UIImage backgroundImageForStateBarMetrics​(long state,
                                                           long barMetrics)
        API-Since: 5.0

      • backgroundImageForStateStyleBarMetrics

        @Nullable
public @Nullable UIImage backgroundImageForStateStyleBarMetrics​(long state,
                                                                long style,
                                                                long barMetrics)
        API-Since: 6.0

      • backgroundVerticalPositionAdjustmentForBarMetrics

        public double backgroundVerticalPositionAdjustmentForBarMetrics​(long barMetrics)
        API-Since: 5.0

      • buttonGroup

        @Nullable
public @Nullable UIBarButtonItemGroup buttonGroup()
        The group that the UIBarButtonItem is currently associated with, either as a member of the barButtonItems array or as that group's representativeItem. API-Since: 9.0

      • customView

        @Nullable
public @Nullable UIView customView()
        default is nil

      • initWithBarButtonSystemItemTargetAction

        public UIBarButtonItem initWithBarButtonSystemItemTargetAction​(long systemItem,
                                                               @Nullable
                                                               @Nullable java.lang.Object target,
                                                               @Nullable
                                                               @Nullable org.moe.natj.objc.SEL action)

      • initWithCustomView

        public UIBarButtonItem initWithCustomView​(@NotNull
                                          @NotNull UIView customView)

      • initWithImageLandscapeImagePhoneStyleTargetAction

        public UIBarButtonItem initWithImageLandscapeImagePhoneStyleTargetAction​(@Nullable
                                                                         @Nullable UIImage image,
                                                                         @Nullable
                                                                         @Nullable UIImage landscapeImagePhone,
                                                                         long style,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object target,
                                                                         @Nullable
                                                                         @Nullable org.moe.natj.objc.SEL action)
        landscapeImagePhone will be used for the bar button image when the bar has Compact or Condensed bar metrics. API-Since: 5.0

      • initWithImageStyleTargetAction

        public UIBarButtonItem initWithImageStyleTargetAction​(@Nullable
                                                      @Nullable UIImage image,
                                                      long style,
                                                      @Nullable
                                                      @Nullable java.lang.Object target,
                                                      @Nullable
                                                      @Nullable org.moe.natj.objc.SEL action)

      • initWithTitleStyleTargetAction

        public UIBarButtonItem initWithTitleStyleTargetAction​(@Nullable
                                                      @Nullable java.lang.String title,
                                                      long style,
                                                      @Nullable
                                                      @Nullable java.lang.Object target,
                                                      @Nullable
                                                      @Nullable org.moe.natj.objc.SEL action)

      • possibleTitles

        @Nullable
public @Nullable NSSet<java.lang.String> possibleTitles()
        default is nil

      • setAction

        public void setAction​(@Nullable
                      @Nullable org.moe.natj.objc.SEL value)
        default is NULL

      • setBackButtonBackgroundImageForStateBarMetrics

        public void setBackButtonBackgroundImageForStateBarMetrics​(@Nullable
                                                           @Nullable UIImage backgroundImage,
                                                           long state,
                                                           long barMetrics)
        The remaining appearance modifiers apply solely to UINavigationBar back buttons and are ignored by other buttons. backgroundImage must be a resizable image for good results. API-Since: 5.0

      • setBackButtonBackgroundVerticalPositionAdjustmentForBarMetrics

        public void setBackButtonBackgroundVerticalPositionAdjustmentForBarMetrics​(double adjustment,
                                                                           long barMetrics)
        For adjusting the vertical centering of bordered bar buttons within the bar API-Since: 5.0

      • setBackButtonTitlePositionAdjustmentForBarMetrics

        public void setBackButtonTitlePositionAdjustmentForBarMetrics​(UIOffset adjustment,
                                                              long barMetrics)
        API-Since: 5.0

      • setBackgroundImageForStateBarMetrics

        public void setBackgroundImageForStateBarMetrics​(@Nullable
                                                 @Nullable UIImage backgroundImage,
                                                 long state,
                                                 long barMetrics)
        In general, you should specify a value for the normal state to be used by other states which don't have a custom value set. Similarly, when a property is dependent on the bar metrics (on the iPhone in landscape orientation, bars have a different height from standard), be sure to specify a value for UIBarMetricsDefault. This sets the background image for buttons of any style. API-Since: 5.0

      • setBackgroundImageForStateStyleBarMetrics

        public void setBackgroundImageForStateStyleBarMetrics​(@Nullable
                                                      @Nullable UIImage backgroundImage,
                                                      long state,
                                                      long style,
                                                      long barMetrics)
        This sets the background image for buttons with a specific style. When calling this on a UIBarButtonItem instance, the style argument must match the button's style; when calling on the UIAppearance proxy, any style may be passed. API-Since: 6.0

      • setBackgroundVerticalPositionAdjustmentForBarMetrics

        public void setBackgroundVerticalPositionAdjustmentForBarMetrics​(double adjustment,
                                                                 long barMetrics)
        For adjusting the vertical centering of bordered bar buttons within the bar API-Since: 5.0

      • setCustomView

        public void setCustomView​(@Nullable
                          @Nullable UIView value)
        default is nil

      • setPossibleTitles

        public void setPossibleTitles​(@Nullable
                              @Nullable NSSet<java.lang.String> value)
        default is nil

      • setStyle

        public void setStyle​(long value)
        default is UIBarButtonItemStylePlain

      • setTarget_unsafe

        public void setTarget_unsafe​(@Nullable
                             @Nullable java.lang.Object value)
        default is nil

      • setTarget

        public void setTarget​(@Nullable
                      @Nullable java.lang.Object value)
        default is nil

      • setTintColor

        public void setTintColor​(@Nullable
                         @Nullable UIColor value)
        API-Since: 5.0

      • setTitlePositionAdjustmentForBarMetrics

        public void setTitlePositionAdjustmentForBarMetrics​(UIOffset adjustment,
                                                    long barMetrics)
        For adjusting the position of a title (if any) within a bordered bar button API-Since: 5.0

      • setWidth

        public void setWidth​(double value)
        default is 0.0

      • style

        public long style()
        default is UIBarButtonItemStylePlain

      • target

        @Nullable
public @Nullable java.lang.Object target()
        default is nil

      • tintColor

        @Nullable
public @Nullable UIColor tintColor()
        API-Since: 5.0

      • titlePositionAdjustmentForBarMetrics

        public UIOffset titlePositionAdjustmentForBarMetrics​(long barMetrics)
        API-Since: 5.0

      • width

        public double width()
        default is 0.0

      • fixedSpaceItemOfWidth

        @NotNull
public static @NotNull UIBarButtonItem fixedSpaceItemOfWidth​(double width)
        Construct a new fixed space item with the given width. API-Since: 14.0

      • flexibleSpaceItem

        @NotNull
public static @NotNull UIBarButtonItem flexibleSpaceItem()
        Construct a new flexible space item. API-Since: 14.0

      • initWithBarButtonSystemItemMenu

        public UIBarButtonItem initWithBarButtonSystemItemMenu​(long systemItem,
                                                       @Nullable
                                                       @Nullable UIMenu menu)
        Creates a bar button item for the given systemItem. The constructed item will present the menu immediately when touched. API-Since: 14.0

      • initWithBarButtonSystemItemPrimaryAction

        public UIBarButtonItem initWithBarButtonSystemItemPrimaryAction​(long systemItem,
                                                                @Nullable
                                                                @Nullable UIAction primaryAction)
        Creates a bar button item for the given systemItem. The primaryAction is copied, and its title & image are ignored. API-Since: 14.0

      • initWithImageMenu

        public UIBarButtonItem initWithImageMenu​(@Nullable
                                         @Nullable UIImage image,
                                         @Nullable
                                         @Nullable UIMenu menu)
        Creates a plain-style bar button item with the given image. The constructed item will present the menu immediately when touched. API-Since: 14.0

      • initWithPrimaryAction

        public UIBarButtonItem initWithPrimaryAction​(@Nullable
                                             @Nullable UIAction primaryAction)
        Creates a plain-style bar button item from the properties of primaryAction. primaryAction is copied. API-Since: 14.0

      • initWithTitleMenu

        public UIBarButtonItem initWithTitleMenu​(@Nullable
                                         @Nullable java.lang.String title,
                                         @Nullable
                                         @Nullable UIMenu menu)
        Creates a plain-style bar button item with the given title. The constructed item will present the menu immediately when touched. API-Since: 14.0

      • menu

        @Nullable
public @Nullable UIMenu menu()
        When non-nil the menu is presented, the gesture used to trigger the menu is based on if the bar button item would normally trigger an action when tapped. API-Since: 14.0

      • primaryAction

        @Nullable
public @Nullable UIAction primaryAction()
        Set the primaryAction on this item, updating the title & image of the item if appropriate (primaryAction is non-nil, and this is not a system item). When primaryAction is non-nil, the target & action properties are ignored. If primaryAction is set to nil, the title & image properties are left unchanged. API-Since: 14.0

      • setMenu

        public void setMenu​(@Nullable
                    @Nullable UIMenu value)
        When non-nil the menu is presented, the gesture used to trigger the menu is based on if the bar button item would normally trigger an action when tapped. API-Since: 14.0

      • setPrimaryAction

        public void setPrimaryAction​(@Nullable
                             @Nullable UIAction value)
        Set the primaryAction on this item, updating the title & image of the item if appropriate (primaryAction is non-nil, and this is not a system item). When primaryAction is non-nil, the target & action properties are ignored. If primaryAction is set to nil, the title & image properties are left unchanged. API-Since: 14.0

      • changesSelectionAsPrimaryAction

        public boolean changesSelectionAsPrimaryAction()
        Indicates if the button changes selection as its primary action. This shows the menu as options for selection if a menu is populated and no action when tapped is enabled. If no menu is provided and no action is enabled when tapped, the item is toggled on and off for the primary action. API-Since: 15.0

      • isSelected

        public boolean isSelected()
        API-Since: 15.0

      • setChangesSelectionAsPrimaryAction

        public void setChangesSelectionAsPrimaryAction​(boolean value)
        Indicates if the button changes selection as its primary action. This shows the menu as options for selection if a menu is populated and no action when tapped is enabled. If no menu is provided and no action is enabled when tapped, the item is toggled on and off for the primary action. API-Since: 15.0

      • setSelected

        public void setSelected​(boolean value)
        API-Since: 15.0

      • creatingFixedGroup

        @NotNull
public @NotNull UIBarButtonItemGroup creatingFixedGroup()
        Create a fixed group containing this bar button item. UIBarButtonItems may only be in a single UIBarButtonItemGroup at a time, adding a bar button item to a group removes it from any previous group. API-Since: 16.0

      • creatingMovableGroupWithCustomizationIdentifier

        @NotNull
public @NotNull UIBarButtonItemGroup creatingMovableGroupWithCustomizationIdentifier​(@NotNull
                                                                                     @NotNull java.lang.String customizationIdentifier)
        Create a movable group containing this bar button item. UIBarButtonItems may only be in a single UIBarButtonItemGroup at a time, adding a bar button item to a group removes it from any previous group. API-Since: 16.0

      • creatingOptionalGroupWithCustomizationIdentifierInDefaultCustomization

        @NotNull
public @NotNull UIBarButtonItemGroup creatingOptionalGroupWithCustomizationIdentifierInDefaultCustomization​(@NotNull
                                                                                                            @NotNull java.lang.String customizationIdentifier,
                                                                                                            boolean inDefaultCustomization)
        Create an optional group containing this bar button item. UIBarButtonItems may only be in a single UIBarButtonItemGroup at a time, adding a bar button item to a group removes it from any previous group. API-Since: 16.0

      • initWithBarButtonSystemItemPrimaryActionMenu

        public UIBarButtonItem initWithBarButtonSystemItemPrimaryActionMenu​(long systemItem,
                                                                    @Nullable
                                                                    @Nullable UIAction primaryAction,
                                                                    @Nullable
                                                                    @Nullable UIMenu menu)
        Creates a bar button item for the given systemItem. The primaryAction is copied, and its title & image are ignored. API-Since: 16.0

      • initWithPrimaryActionMenu

        public UIBarButtonItem initWithPrimaryActionMenu​(@Nullable
                                                 @Nullable UIAction primaryAction,
                                                 @Nullable
                                                 @Nullable UIMenu menu)
        Creates a plain-style bar button item from the properties of primaryAction. primaryAction is copied. API-Since: 16.0

      • initWithTitleImageTargetActionMenu

        public UIBarButtonItem initWithTitleImageTargetActionMenu​(@Nullable
                                                          @Nullable java.lang.String title,
                                                          @Nullable
                                                          @Nullable UIImage image,
                                                          @Nullable
                                                          @Nullable java.lang.Object target,
                                                          @Nullable
                                                          @Nullable org.moe.natj.objc.SEL action,
                                                          @Nullable
                                                          @Nullable UIMenu menu)
        Creates a plain-style bar button item with the given title and image. API-Since: 16.0

      • isHidden

        public boolean isHidden()
        If the item should be hidden from display. API-Since: 16.0

      • menuRepresentation

        @Nullable
public @Nullable UIMenuElement menuRepresentation()
        A UIMenuElement that should substitute for the UIBarButtonItem when displayed in a menu. API-Since: 16.0

      • preferredMenuElementOrder

        public long preferredMenuElementOrder()
        Preferred menu element ordering strategy for menus displayed by this button. API-Since: 16.0

      • setHidden

        public void setHidden​(boolean value)
        If the item should be hidden from display. API-Since: 16.0

      • setMenuRepresentation

        public void setMenuRepresentation​(@Nullable
                                  @Nullable UIMenuElement value)
        A UIMenuElement that should substitute for the UIBarButtonItem when displayed in a menu. API-Since: 16.0

      • setPreferredMenuElementOrder

        public void setPreferredMenuElementOrder​(long value)
        Preferred menu element ordering strategy for menus displayed by this button. API-Since: 16.0

      • addSymbolEffect

        public void addSymbolEffect​(@NotNull
                            @NotNull NSSymbolEffect symbolEffect)
        Adds a symbol effect to the bar button item with default options and animation. Only a subset of symbol effects are supported; Appear and Disappear effects, for example, are unsupported, and will assert. API-Since: 17.0

      • addSymbolEffectOptions

        public void addSymbolEffectOptions​(@NotNull
                                   @NotNull NSSymbolEffect symbolEffect,
                                   @NotNull
                                   @NotNull NSSymbolEffectOptions options)
        Adds a symbol effect to the bar button item with specified options and default animation. Only a subset of symbol effects are supported; Appear and Disappear effects, for example, are unsupported, and will assert. API-Since: 17.0

      • addSymbolEffectOptionsAnimated

        public void addSymbolEffectOptionsAnimated​(@NotNull
                                           @NotNull NSSymbolEffect symbolEffect,
                                           @NotNull
                                           @NotNull NSSymbolEffectOptions options,
                                           boolean animated)
        Adds a symbol effect to the bar button item with specified options and animation. Only a subset of symbol effects are supported; Appear and Disappear effects, for example, are unsupported, and will assert. API-Since: 17.0

      • isSymbolAnimationEnabled

        public boolean isSymbolAnimationEnabled()
        Whether or not symbol animations are enabled for this bar button item. API-Since: 17.0

      • removeAllSymbolEffects

        public void removeAllSymbolEffects()
        Removes all symbol effects from the bar button item with default options and animation. API-Since: 17.0

      • removeAllSymbolEffectsWithOptions

        public void removeAllSymbolEffectsWithOptions​(@NotNull
                                              @NotNull NSSymbolEffectOptions options)
        Removes all symbol effects from the bar button item with specified options and default animation. API-Since: 17.0

      • removeAllSymbolEffectsWithOptionsAnimated

        public void removeAllSymbolEffectsWithOptionsAnimated​(@NotNull
                                                      @NotNull NSSymbolEffectOptions options,
                                                      boolean animated)
        Removes all symbol effects from the bar button item with specified options and animation. API-Since: 17.0

      • removeSymbolEffectOfType

        public void removeSymbolEffectOfType​(@NotNull
                                     @NotNull NSSymbolEffect symbolEffect)
        Removes from the bar button item the symbol effect matching the type of effect passed in, with default options and animation. API-Since: 17.0

      • removeSymbolEffectOfTypeOptions

        public void removeSymbolEffectOfTypeOptions​(@NotNull
                                            @NotNull NSSymbolEffect symbolEffect,
                                            @NotNull
                                            @NotNull NSSymbolEffectOptions options)
        Removes from the bar button item the symbol effect matching the type of effect passed in, with specified options and default animation. API-Since: 17.0

      • removeSymbolEffectOfTypeOptionsAnimated

        public void removeSymbolEffectOfTypeOptionsAnimated​(@NotNull
                                                    @NotNull NSSymbolEffect symbolEffect,
                                                    @NotNull
                                                    @NotNull NSSymbolEffectOptions options,
                                                    boolean animated)
        Removes from the bar button item the symbol effect matching the type of effect passed in, with specified options and animation. API-Since: 17.0

      • setSymbolAnimationEnabled

        public void setSymbolAnimationEnabled​(boolean value)
        Whether or not symbol animations are enabled for this bar button item. API-Since: 17.0

      • setSymbolImageWithContentTransition

        public void setSymbolImageWithContentTransition​(@NotNull
                                                @NotNull UIImage symbolImage,
                                                @NotNull
                                                @NotNull NSSymbolContentTransition transition)
        Sets the symbol image on the bar button item with a symbol content transition and default options. Passing in a non-symbol image will result in undefined behavior. API-Since: 17.0

      • setSymbolImageWithContentTransitionOptions

        public void setSymbolImageWithContentTransitionOptions​(@NotNull
                                                       @NotNull UIImage symbolImage,
                                                       @NotNull
                                                       @NotNull NSSymbolContentTransition transition,
                                                       @NotNull
                                                       @NotNull NSSymbolEffectOptions options)
        Sets the symbol image on the bar button item with a symbol content transition and specified options. Passing in a non-symbol image will result in undefined behavior. API-Since: 17.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.