ListBoxConceptMetadata Interface Reference

Metadata definitions for ListBoxConcept. More...

Inheritance diagram for ListBoxConceptMetadata:

Classes
class	ItemLoadedMessageArguments
	Metadata definitions for ItemLoadedMessageArguments. More...
class	ItemMessageArguments
	Metadata definitions for ItemMessageArguments. More...
class	ItemSelectedMessageArguments
	Metadata definitions for ItemSelectedMessageArguments. More...
class	ItemUnloadedMessageArguments
	Metadata definitions for ItemUnloadedMessageArguments. More...
class	MoveFocusMessageArguments
	Metadata definitions for MoveFocusMessageArguments. More...
class	TrySetFocusToItemMessageArguments
	Metadata definitions for TrySetFocusToItemMessageArguments. More...

Public Attributes
DynamicPropertyType< String >	ItemContainerGeneratorTypeNameProperty
	Sets the name of the item container generator type to use to provide item containers dynamically for the List Box.
DynamicPropertyType< Resource >	ItemContainerTemplateProperty
	Sets the List Box Item Container prefab that sets the appearance and behavior of the List Box items.
DynamicPropertyType< Integer >	ItemCountProperty
	Reports the number of items in the List Box, including virtual items.
DynamicPropertyType< String >	ItemGeneratorTypeNameProperty
	Sets the name of the item generator type to use to provide items dynamically to the List Box.
DynamicMessageType< ListBoxConceptMetadata.ItemLoadedMessageArguments >	ItemLoadedMessage
	Occurs when an item is loaded to the working memory.
DynamicMessageType< ListBoxConceptMetadata.ItemSelectedMessageArguments >	ItemSelectedMessage
	Occurs when an item is selected.
DynamicPropertyType< Resource >	ItemTemplateProperty
	Sets the prefab to use for the List Box items.
DynamicMessageType< ListBoxConceptMetadata.ItemUnloadedMessageArguments >	ItemUnloadedMessage
	Occurs when an item is unloaded from the working memory.
DynamicPropertyType< Integer >	KeepAliveItemCountProperty
	Sets the size of the buffer for invisible List Box items.
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.ListBoxConcept")
	Metaclass for ListBoxConcept.
DynamicMessageType< ListBoxConceptMetadata.MoveFocusMessageArguments >	MoveFocusMessage
	In a List Box node, moves the focus to the target that you set in the Focus Move Target property.
DynamicPropertyType< Integer >	SelectedItemIndexProperty
	Sets the index of the item that is currently selected in the List Box node.
DynamicPropertyType< SelectionBehavior >	SelectionBehaviorProperty
	Sets how the List Box behaves when the user selects an item.
DynamicMessageType< ListBoxConceptMetadata.TrySetFocusToItemMessageArguments >	TrySetFocusToListItemMessage
	In a List Box node, tries to set the focus to the item at the index that you set in the Item Index property.

Detailed Description

Metadata definitions for ListBoxConcept.

Member Data Documentation

ItemContainerGeneratorTypeNameProperty

DynamicPropertyType<String> ItemContainerGeneratorTypeNameProperty

Initial value:

=
        new DynamicPropertyType<>("ListBoxConcept.ItemContainerGeneratorTypeName", String.class)

Sets the name of the item container generator type to use to provide item containers dynamically for the List Box.

ItemContainerTemplateProperty

DynamicPropertyType<Resource> ItemContainerTemplateProperty

Initial value:

=
        new DynamicPropertyType<>("ListBoxConcept.ItemContainerTemplate", Resource.class)

Sets the List Box Item Container prefab that sets the appearance and behavior of the List Box items.

ItemCountProperty

DynamicPropertyType<Integer> ItemCountProperty

Initial value:

=
        new DynamicPropertyType<>("ListBoxConcept.ItemCount", Integer.class)

Reports the number of items in the List Box, including virtual items.

ItemGeneratorTypeNameProperty

DynamicPropertyType<String> ItemGeneratorTypeNameProperty

Initial value:

=
        new DynamicPropertyType<>("ListBoxConcept.ItemGeneratorTypeName", String.class)

Sets the name of the item generator type to use to provide items dynamically to the List Box.

ItemLoadedMessage

DynamicMessageType<ListBoxConceptMetadata.ItemLoadedMessageArguments> ItemLoadedMessage

Initial value:

=
        new DynamicMessageType<>(
            "Message.ListBox.ItemLoaded", ListBoxConceptMetadata.ItemLoadedMessageArguments.class)

Occurs when an item is loaded to the working memory.

To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property.

ItemSelectedMessage

DynamicMessageType<ListBoxConceptMetadata.ItemSelectedMessageArguments> ItemSelectedMessage

Initial value:

=
        new DynamicMessageType<>("Message.ListBox.ItemSelected",
            ListBoxConceptMetadata.ItemSelectedMessageArguments.class)

Occurs when an item is selected.

ItemTemplateProperty

DynamicPropertyType<Resource> ItemTemplateProperty

Initial value:

=
        new DynamicPropertyType<>("ListBoxConcept.ItemTemplate", Resource.class)

Sets the prefab to use for the List Box items.

ItemUnloadedMessage

DynamicMessageType<ListBoxConceptMetadata.ItemUnloadedMessageArguments> ItemUnloadedMessage

Initial value:

=
        new DynamicMessageType<>("Message.ListBox.ItemUnloaded",
            ListBoxConceptMetadata.ItemUnloadedMessageArguments.class)

Occurs when an item is unloaded from the working memory.

To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property.

KeepAliveItemCountProperty

DynamicPropertyType<Integer> KeepAliveItemCountProperty

Initial value:

=
        new DynamicPropertyType<>("ListBoxConcept.KeepAliveItemCount", Integer.class)

Sets the size of the buffer for invisible List Box items.

Kanzi returns to the Item Generator those invisible items that do not fit in the buffer.

MoveFocusMessage

DynamicMessageType<ListBoxConceptMetadata.MoveFocusMessageArguments> MoveFocusMessage

Initial value:

=
        new DynamicMessageType<>("Message.ListBoxConcept.MoveFocus",
            ListBoxConceptMetadata.MoveFocusMessageArguments.class)

In a List Box node, moves the focus to the target that you set in the Focus Move Target property.

SelectedItemIndexProperty

DynamicPropertyType<Integer> SelectedItemIndexProperty

Initial value:

=
        new DynamicPropertyType<>("ListBoxConcept.SelectedItemIndex", Integer.class)

Sets the index of the item that is currently selected in the List Box node.

A List Box node updates this property when the user scrolls that List Box node. To select an item in the List Box node, set this property to the index of the item that you want to select. The indexing starts from 0. To update this property with a binding, use a to-source or two-way binding.

SelectionBehaviorProperty

DynamicPropertyType<SelectionBehavior> SelectionBehaviorProperty

Initial value:

=
        new DynamicPropertyType<>("ListBoxConcept.SelectionBehavior", SelectionBehavior.class)

Sets how the List Box behaves when the user selects an item.

'Bring to Center' sets the List Box to bring an item to the center of the List Box area when the user selects that item.

TrySetFocusToListItemMessage

DynamicMessageType<ListBoxConceptMetadata.TrySetFocusToItemMessageArguments> TrySetFocusToListItemMessage

Initial value:

=
            new DynamicMessageType<>("Message.ListBoxConcept.TrySetFocusToListItem",
                ListBoxConceptMetadata.TrySetFocusToItemMessageArguments.class)

In a List Box node, tries to set the focus to the item at the index that you set in the Item Index property.

If that item cannot receive focus and you enable the Fallback property, Kanzi tries to set the focus to the List Box node.