apple.carplay

Class CPListTemplate

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.carplay.CPTemplate

apple.carplay.CPListTemplate

All Implemented Interfaces:

CPBarButtonProviding, NSCoding, NSSecureCoding, NSObject

public class CPListTemplate
extends CPTemplate
implements CPBarButtonProviding

Nested Class Summary

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CPListTemplate(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method and Description
boolean	_supportsSecureCoding() This property must return YES on all classes that allow secure coding.
static boolean	accessInstanceVariablesDirectly()
static CPListTemplate	alloc()
static CPListTemplate	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
CPAssistantCellConfiguration	assistantCellConfiguration() The configuration of the Assistant Cell.
static boolean	automaticallyNotifiesObserversForKey(java.lang.String key)
CPBarButton	backButton()
static void	cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
static void	cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)
static NSArray<java.lang.String>	classFallbacksForKeyedArchiver()
static org.moe.natj.objc.Class	classForKeyedUnarchiver()
static java.lang.String	debugDescription_static()
CPListTemplateDelegate	delegate() The list template's delegate is informed of list selection events.
static java.lang.String	description_static()
NSArray<java.lang.String>	emptyViewSubtitleVariants() An optional array of strings, ordered from most to least preferred.
NSArray<java.lang.String>	emptyViewTitleVariants() An optional array of strings, ordered from most to least preferred.
static long	hash_static()
NSIndexPath	indexPathForItem(CPListTemplateItem item) Return an @c NSIndexPath for the specified item, if it exists in any section in this list template, or nil if not found.
CPListTemplate	init()
CPListTemplate	initWithCoder(NSCoder coder) NS_DESIGNATED_INITIALIZER
CPListTemplate	initWithTitleSections(java.lang.String title, NSArray<? extends CPListSection> sections) Initialize a list template with one or more sections of items and an optional title.
CPListTemplate	initWithTitleSectionsAssistantCellConfiguration(java.lang.String title, NSArray<? extends CPListSection> sections, CPAssistantCellConfiguration assistantCellConfiguration) Initialize a list template with one or more sections of items, an optional title, and configuration for the assistant cell via a @c CPAssistantCellConfiguration object.
static NSObject.Function_instanceMethodForSelector_ret	instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
static NSMethodSignature	instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)
static boolean	instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)
static boolean	isSubclassOfClass(org.moe.natj.objc.Class aClass)
long	itemCount() The number of items currently displayed in this list template, across all sections.
static NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(java.lang.String key)
NSArray<? extends CPBarButton>	leadingNavigationBarButtons() An array of bar buttons to be displayed on the leading side of the navigation bar.
static long	maximumItemCount() The maximum number of items, across all sections, that may appear in a @c CPListTemplate.
static long	maximumSectionCount() The maximum number of sections that may appear in a @c CPListTemplate.
static CPListTemplate	new_objc()
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
long	sectionCount() The number of sections currently displayed in this list template.
NSArray<? extends CPListSection>	sections() The sections displayed in this list.
void	setAssistantCellConfiguration(CPAssistantCellConfiguration value) The configuration of the Assistant Cell.
void	setBackButton(CPBarButton value)
void	setDelegate_unsafe(CPListTemplateDelegate value) The list template's delegate is informed of list selection events.
void	setDelegate(CPListTemplateDelegate value) The list template's delegate is informed of list selection events.
void	setEmptyViewSubtitleVariants(NSArray<java.lang.String> value) An optional array of strings, ordered from most to least preferred.
void	setEmptyViewTitleVariants(NSArray<java.lang.String> value) An optional array of strings, ordered from most to least preferred.
void	setLeadingNavigationBarButtons(NSArray<? extends CPBarButton> value) An array of bar buttons to be displayed on the leading side of the navigation bar.
void	setTrailingNavigationBarButtons(NSArray<? extends CPBarButton> value) An array of bar buttons to be displayed on the trailing side of the navigation bar.
static void	setVersion_static(long aVersion)
static org.moe.natj.objc.Class	superclass_static()
static boolean	supportsSecureCoding()
java.lang.String	title() Title shown in the navigation bar while this template is visible.
NSArray<? extends CPBarButton>	trailingNavigationBarButtons() An array of bar buttons to be displayed on the trailing side of the navigation bar.
void	updateSections(NSArray<? extends CPListSection> sections) Update the list of sections displayed in this list template, reloading the table view displaying this list.
static long	version_static()

Methods inherited from class apple.carplay.CPTemplate

encodeWithCoder, setShowsTabBadge, setTabImage, setTabSystemItem, setTabTitle, setUserInfo, showsTabBadge, tabImage, tabSystemItem, tabTitle, userInfo

Methods inherited from class apple.NSObject

accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject

equals, toString

Methods inherited from class org.moe.natj.general.NativeObject

finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CPListTemplate

protected CPListTemplate(org.moe.natj.general.Pointer peer)

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static CPListTemplate alloc()

allocWithZone

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

automaticallyNotifiesObserversForKey

public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)

backButton

public CPBarButton backButton()

Specified by:

backButton in interface CPBarButtonProviding

cancelPreviousPerformRequestsWithTarget

public static void cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)

cancelPreviousPerformRequestsWithTargetSelectorObject

public static void cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

classFallbacksForKeyedArchiver

public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

classForKeyedUnarchiver

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

debugDescription_static

public static java.lang.String debugDescription_static()

delegate

public CPListTemplateDelegate delegate()

The list template's delegate is informed of list selection events.

description_static

public static java.lang.String description_static()

hash_static

public static long hash_static()

init

public CPListTemplate init()

Overrides:

init in class CPTemplate

initWithCoder

public CPListTemplate initWithCoder(NSCoder coder)

Description copied from interface: NSCoding

NS_DESIGNATED_INITIALIZER

Specified by:

initWithCoder in interface NSCoding

Overrides:

initWithCoder in class CPTemplate

initWithTitleSections

public CPListTemplate initWithTitleSections(java.lang.String title,
                                            NSArray<? extends CPListSection> sections)

Initialize a list template with one or more sections of items and an optional title.

instanceMethodForSelector

public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)

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

public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)

leadingNavigationBarButtons

public NSArray<? extends CPBarButton> leadingNavigationBarButtons()

Description copied from interface: CPBarButtonProviding

An array of bar buttons to be displayed on the leading side of the navigation bar.

[@note] The navigation bar may display a maximum of 2 buttons in the leading space. Setting more than 2 buttons to this property will only display the first 2 buttons.

Specified by:

leadingNavigationBarButtons in interface CPBarButtonProviding

new_objc

public static CPListTemplate new_objc()

resolveClassMethod

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

resolveInstanceMethod

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

sections

public NSArray<? extends CPListSection> sections()

The sections displayed in this list.

setBackButton

public void setBackButton(CPBarButton value)

Specified by:

setBackButton in interface CPBarButtonProviding

setDelegate_unsafe

public void setDelegate_unsafe(CPListTemplateDelegate value)

The list template's delegate is informed of list selection events.

setDelegate

public void setDelegate(CPListTemplateDelegate value)

The list template's delegate is informed of list selection events.

setLeadingNavigationBarButtons

public void setLeadingNavigationBarButtons(NSArray<? extends CPBarButton> value)

Description copied from interface: CPBarButtonProviding

An array of bar buttons to be displayed on the leading side of the navigation bar.

[@note] The navigation bar may display a maximum of 2 buttons in the leading space. Setting more than 2 buttons to this property will only display the first 2 buttons.

Specified by:

setLeadingNavigationBarButtons in interface CPBarButtonProviding

setTrailingNavigationBarButtons

public void setTrailingNavigationBarButtons(NSArray<? extends CPBarButton> value)

Description copied from interface: CPBarButtonProviding

An array of bar buttons to be displayed on the trailing side of the navigation bar.

[@note] The navigation bar may display a maximum of 2 buttons in the trailing space. Setting more than 2 buttons to this property will only display the first 2 buttons.

Specified by:

setTrailingNavigationBarButtons in interface CPBarButtonProviding

setVersion_static

public static void setVersion_static(long aVersion)

superclass_static

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

supportsSecureCoding

public static boolean supportsSecureCoding()

_supportsSecureCoding

public boolean _supportsSecureCoding()

Description copied from interface: NSSecureCoding

This property must return YES on all classes that allow secure coding. Subclasses of classes that adopt NSSecureCoding and override initWithCoder: must also override this method and return YES. The Secure Coding Guide should be consulted when writing methods that decode data.

Specified by:

_supportsSecureCoding in interface NSSecureCoding

Overrides:

_supportsSecureCoding in class CPTemplate

title

public java.lang.String title()

Title shown in the navigation bar while this template is visible.

trailingNavigationBarButtons

public NSArray<? extends CPBarButton> trailingNavigationBarButtons()

Description copied from interface: CPBarButtonProviding

An array of bar buttons to be displayed on the trailing side of the navigation bar.

[@note] The navigation bar may display a maximum of 2 buttons in the trailing space. Setting more than 2 buttons to this property will only display the first 2 buttons.

Specified by:

trailingNavigationBarButtons in interface CPBarButtonProviding

updateSections

public void updateSections(NSArray<? extends CPListSection> sections)

Update the list of sections displayed in this list template, reloading the table view displaying this list.

version_static

public static long version_static()

emptyViewSubtitleVariants

public NSArray<java.lang.String> emptyViewSubtitleVariants()

An optional array of strings, ordered from most to least preferred. The variant strings should be provided as localized, displayable content. The system will select the first variant that fits the available space.

If the list template does not contain any items (itemCount == 0), then the template will display an empty view with a title and subtitle to indicate that the template has no list items.

If the list template is updated to contain items, the empty view will be automatically removed.

emptyViewTitleVariants

public NSArray<java.lang.String> emptyViewTitleVariants()

An optional array of strings, ordered from most to least preferred. The variant strings should be provided as localized, displayable content. The system will select the first variant that fits the available space.

If the list template does not contain any items (itemCount == 0), then the template will display an empty view with a title and subtitle to indicate that the template has no list items.

If the list template is updated to contain items, the empty view will be automatically removed.

indexPathForItem

public NSIndexPath indexPathForItem(CPListTemplateItem item)

Return an @c NSIndexPath for the specified item, if it exists in any section in this list template, or nil if not found.

itemCount

public long itemCount()

The number of items currently displayed in this list template, across all sections.

maximumItemCount

public static long maximumItemCount()

The maximum number of items, across all sections, that may appear in a @c CPListTemplate.

[@note] Your list template will display the first @c maximumItemCount items, across all sections. Any items or sections beyond that limit will be trimmed.

maximumSectionCount

public static long maximumSectionCount()

The maximum number of sections that may appear in a @c CPListTemplate.

[@note] Your list template will display the first @c maximumSectionCount sections. Any sections beyond that limit will be trimmed.

sectionCount

public long sectionCount()

The number of sections currently displayed in this list template.

setEmptyViewSubtitleVariants

public void setEmptyViewSubtitleVariants(NSArray<java.lang.String> value)

An optional array of strings, ordered from most to least preferred. The variant strings should be provided as localized, displayable content. The system will select the first variant that fits the available space.

If the list template does not contain any items (itemCount == 0), then the template will display an empty view with a title and subtitle to indicate that the template has no list items.

If the list template is updated to contain items, the empty view will be automatically removed.

setEmptyViewTitleVariants

public void setEmptyViewTitleVariants(NSArray<java.lang.String> value)

An optional array of strings, ordered from most to least preferred. The variant strings should be provided as localized, displayable content. The system will select the first variant that fits the available space.

If the list template does not contain any items (itemCount == 0), then the template will display an empty view with a title and subtitle to indicate that the template has no list items.

If the list template is updated to contain items, the empty view will be automatically removed.

assistantCellConfiguration

public CPAssistantCellConfiguration assistantCellConfiguration()

The configuration of the Assistant Cell.

Assigning to this property will dynamically update the List Template to reflect the visibility, position, and intent identifier of the Assistant Cell.

[@note] The Assistant Cell is only supported by CarPlay Audio and Communication Apps.

Unlike @c CPListItem, your application will not receive a callback when the user selects the cell. Instead, configure an Intents app extention to receive user requests from SiriKit, in order to turn the requests into an app-specific actions.

initWithTitleSectionsAssistantCellConfiguration

public CPListTemplate initWithTitleSectionsAssistantCellConfiguration(java.lang.String title,
                                                                      NSArray<? extends CPListSection> sections,
                                                                      CPAssistantCellConfiguration assistantCellConfiguration)

Initialize a list template with one or more sections of items, an optional title, and configuration for the assistant cell via a @c CPAssistantCellConfiguration object.

[@note] The Assistant Cell is only supported by CarPlay Audio and Communication Apps.

Unlike @c CPListItem, your application will not receive a callback when the user selects the cell. Instead, configure an Intents app extention to receive user requests from SiriKit, in order to turn the requests into an app-specific actions.

setAssistantCellConfiguration

public void setAssistantCellConfiguration(CPAssistantCellConfiguration value)

The configuration of the Assistant Cell.

Assigning to this property will dynamically update the List Template to reflect the visibility, position, and intent identifier of the Assistant Cell.

[@note] The Assistant Cell is only supported by CarPlay Audio and Communication Apps.

Unlike @c CPListItem, your application will not receive a callback when the user selects the cell. Instead, configure an Intents app extention to receive user requests from SiriKit, in order to turn the requests into an app-specific actions.