Package apple.uikit.protocol

Interface UIFocusItem

All Superinterfaces:

UIFocusEnvironment

All Known Implementing Classes:

ADBannerView, ARCoachingOverlayView, ARSCNView, ARSKView, ASAuthorizationAppleIDButton, AVRoutePickerView, BCChatButton, CAInterAppAudioSwitcherView, CAInterAppAudioTransportView, CPWindow, GLKView, HKActivityRingView, HMCameraView, INUIAddVoiceShortcutButton, LPLinkView, MKAnnotationView, MKCircleView, MKCompassButton, MKMapView, MKMarkerAnnotationView, MKOverlayPathView, MKOverlayView, MKPinAnnotationView, MKPolygonView, MKPolylineView, MKScaleView, MKUserLocationView, MKUserTrackingButton, MPVolumeView, MSStickerBrowserView, MSStickerView, MTKView, PDFThumbnailView, PDFView, PHLivePhotoView, PKAddPassButton, PKCanvasView, PKPaymentButton, RPSystemBroadcastPickerView, SCNNode, SCNReferenceNode, SCNView, SK3DNode, SKAudioNode, SKCameraNode, SKCropNode, SKEffectNode, SKEmitterNode, SKFieldNode, SKLabelNode, SKLightNode, SKNode, SKReferenceNode, SKScene, SKShapeNode, SKSpriteNode, SKTileMapNode, SKTransformNode, SKVideoNode, SKView, UIActionSheet, UIActivityIndicatorView, UIAlertView, UIButton, UICollectionReusableView, UICollectionView, UICollectionViewCell, UICollectionViewListCell, UIColorWell, UIControl, UIDatePicker, UIImageView, UIInputView, UILabel, UIListContentView, UINavigationBar, UIPageControl, UIPickerView, UIPopoverBackgroundView, UIProgressView, UIRefreshControl, UIScrollView, UISearchBar, UISearchTextField, UISegmentedControl, UISlider, UIStackView, UIStepper, UISwitch, UITabBar, UITableView, UITableViewCell, UITableViewHeaderFooterView, UITextField, UITextView, UIToolbar, UIView, UIVisualEffectView, UIWebView, UIWindow, WKWebView

public interface UIFocusItem
extends UIFocusEnvironment

Objects conforming to UIFocusItem are considered capable of participating in focus. Only UIFocusItems can ever be focused.

Method Summary

Modifier and Type	Method	Description
boolean	canBecomeFocused()	Indicates whether or not this item is currently allowed to become focused.
default void	didHintFocusMovement(UIFocusMovementHint hint)	Called whenever this focus item is hinting to the user a focus movement might occur.
CGRect	frame()	The geometric frame of this item, represented in the `coordinateSpace` of the UIFocusItemContainer in which it is contained.

Methods inherited from interface apple.uikit.protocol.UIFocusEnvironment

didUpdateFocusInContextWithAnimationCoordinator, focusGroupIdentifier, focusItemContainer, parentFocusEnvironment, preferredFocusedView, preferredFocusEnvironments, setNeedsFocusUpdate, shouldUpdateFocusInContext, updateFocusIfNeeded

Method Detail

canBecomeFocused

boolean canBecomeFocused()

Indicates whether or not this item is currently allowed to become focused. Returning NO restricts the item from being focusable, even if it is visible in the user interface. For example, UIControls return NO if they are disabled.

didHintFocusMovement

default void didHintFocusMovement(UIFocusMovementHint hint)

Called whenever this focus item is hinting to the user a focus movement might occur. The provided object is mutated by the focus engine whenever the user's finger moves.

frame

CGRect frame()

The geometric frame of this item, represented in the `coordinateSpace` of the UIFocusItemContainer in which it is contained.