apple.uikit.protocol

Interface NSTextSelectionDataSource

All Known Implementing Classes:

NSTextLayoutManager

public interface NSTextSelectionDataSource

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NSTextSelectionDataSource.Block_enumerateCaretOffsetsInLineFragmentAtLocationUsingBlock
static interface	NSTextSelectionDataSource.Block_enumerateContainerBoundariesFromLocationReverseUsingBlock
static interface	NSTextSelectionDataSource.Block_enumerateSubstringsFromLocationOptionsUsingBlock

Method Summary

Modifier and Type	Method and Description
long	baseWritingDirectionAtLocation(NSTextLocation location) Returns the base writing direction at location.
NSTextRange	documentRange() Declares the starting and ending locations for the document.
void	enumerateCaretOffsetsInLineFragmentAtLocationUsingBlock(NSTextLocation location, NSTextSelectionDataSource.Block_enumerateCaretOffsetsInLineFragmentAtLocationUsingBlock block) Layout Enumerates all the caret offset from left to right in visual order.
default void	enumerateContainerBoundariesFromLocationReverseUsingBlock(NSTextLocation location, boolean reverse, NSTextSelectionDataSource.Block_enumerateContainerBoundariesFromLocationReverseUsingBlock block) This optional method should be implemented enumerating the text container/page boundary when the text selection data provider supports such a layout functionality.
void	enumerateSubstringsFromLocationOptionsUsingBlock(NSTextLocation location, long options, NSTextSelectionDataSource.Block_enumerateSubstringsFromLocationOptionsUsingBlock block) Enumerating the textual segment boundaries starting at location.
NSTextRange	lineFragmentRangeForPointInContainerAtLocation(CGPoint point, NSTextLocation location) Returns the range of the line fragment containing point inside the coordinate system containing location.
NSTextLocation	locationFromLocationWithOffset(NSTextLocation location, long offset) Returns a new location from location with offset.
long	offsetFromLocationToLocation(NSTextLocation from, NSTextLocation to) Returns the offset between from and to.
default long	textLayoutOrientationAtLocation(NSTextLocation location) Returns the text layout orientation at location.
NSTextRange	textRangeForSelectionGranularityEnclosingLocation(long selectionGranularity, NSTextLocation location) Returns a text range corresponding to selectionGranularity enclosing location.

Method Detail

baseWritingDirectionAtLocation

long baseWritingDirectionAtLocation(NSTextLocation location)

Returns the base writing direction at location. It is recommended to return the resolved base direction either NSTextSelectionNavigationWritingDirectionLeftToRight or NSTextSelectionNavigationWritingDirectionRightToLeft.

documentRange

NSTextRange documentRange()

Declares the starting and ending locations for the document.

enumerateCaretOffsetsInLineFragmentAtLocationUsingBlock

void enumerateCaretOffsetsInLineFragmentAtLocationUsingBlock(NSTextLocation location,
                                                             NSTextSelectionDataSource.Block_enumerateCaretOffsetsInLineFragmentAtLocationUsingBlock block)

Layout Enumerates all the caret offset from left to right in visual order. caretOffset should be in the coordinate system for the text container. When leadingEdge=YES, it indicates caretOffset is at the edge logically preceding the character. For LTR characters, it is on the left, and on the right for RTL characters.

enumerateContainerBoundariesFromLocationReverseUsingBlock

default void enumerateContainerBoundariesFromLocationReverseUsingBlock(NSTextLocation location,
                                                                       boolean reverse,
                                                                       NSTextSelectionDataSource.Block_enumerateContainerBoundariesFromLocationReverseUsingBlock block)

This optional method should be implemented enumerating the text container/page boundary when the text selection data provider supports such a layout functionality.

enumerateSubstringsFromLocationOptionsUsingBlock

void enumerateSubstringsFromLocationOptionsUsingBlock(NSTextLocation location,
                                                      long options,
                                                      NSTextSelectionDataSource.Block_enumerateSubstringsFromLocationOptionsUsingBlock block)

Enumerating the textual segment boundaries starting at location. The segmentation logic should be based on the natural language semantics and rules such as Unicode Text Segmentation UAX 29. It is allowed to have custom text segmentation behavior for specialized document contents (i.e. text editors with structured document contents such as a programming language). NSStringEnumerationByLines should be aware of the visual line boundaries based on soft line wrapping.

lineFragmentRangeForPointInContainerAtLocation

NSTextRange lineFragmentRangeForPointInContainerAtLocation(CGPoint point,
                                                           NSTextLocation location)

Returns the range of the line fragment containing point inside the coordinate system containing location.

locationFromLocationWithOffset

NSTextLocation locationFromLocationWithOffset(NSTextLocation location,
                                              long offset)

Returns a new location from location with offset. The offset value could be positive or negative indicating the logical direction. Could return nil when the inputs don't produce any legal location (i.e. out of bounds index).

offsetFromLocationToLocation

long offsetFromLocationToLocation(NSTextLocation from,
                                  NSTextLocation to)

Returns the offset between from and to. The return value could be positive or negative. Could return NSNotFound when the offset cannot be represented in an integer value (i.e. locations are not in the same document).

textLayoutOrientationAtLocation

default long textLayoutOrientationAtLocation(NSTextLocation location)

Returns the text layout orientation at location. If not implemented, NSTextSelectionNavigation assumes it is NSTextSelectionNavigationLayoutOrientationHorizontal.

textRangeForSelectionGranularityEnclosingLocation

NSTextRange textRangeForSelectionGranularityEnclosingLocation(long selectionGranularity,
                                                              NSTextLocation location)

Returns a text range corresponding to selectionGranularity enclosing location. Returns nil when documentRange.isEmpty=YES.