ListBoxConceptMetadata Interface Reference

Metadata definitions for ListBoxConcept. More...

Inheritance diagram for ListBoxConceptMetadata:

Classes
class	ItemHiddenMessageArguments
	Metadata definitions for ItemHiddenMessageArguments. More...
class	ItemMessageArguments
	Metadata definitions for ItemMessageArguments. More...
class	ItemSelectedMessageArguments
	Metadata definitions for ItemSelectedMessageArguments. More...
class	ItemVisibleMessageArguments
	Metadata definitions for ItemVisibleMessageArguments. 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. More...
DynamicPropertyType< Resource >	ItemContainerTemplateProperty
	Sets the List Box Item Container prefab that sets the appearance and behavior of the List Box items. More...
DynamicPropertyType< Integer >	ItemCountProperty
	Reports the number of items in the List Box, including virtual items. More...
DynamicPropertyType< String >	ItemGeneratorTypeNameProperty
	Sets the name of the item generator type to use to provide items dynamically to the List Box. More...
DynamicMessageType< ListBoxConceptMetadata.ItemHiddenMessageArguments >	ItemHiddenMessage
	Occurs when an item is unloaded from the working memory. More...
DynamicMessageType< ListBoxConceptMetadata.ItemSelectedMessageArguments >	ItemSelectedMessage
	Occurs when an item is selected. More...
DynamicPropertyType< Resource >	ItemTemplateProperty
	Sets the prefab to use for the List Box items. More...
DynamicMessageType< ListBoxConceptMetadata.ItemVisibleMessageArguments >	ItemVisibleMessage
	Occurs when an item is loaded to the working memory. More...
DynamicPropertyType< Integer >	KeepAliveItemCountProperty
	Sets the size of the buffer for invisible List Box items. More...
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.ListBoxConcept")
	Metaclass for ListBoxConcept.
DynamicPropertyType< Integer >	SelectedItemIndexProperty
	Sets the index of the item that is currently selected in the List Box node. More...
DynamicPropertyType< Integer >	SelectionBehaviorProperty
	Sets how the List Box behaves when the user selects an item. More...

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.

ItemHiddenMessage

DynamicMessageType<ListBoxConceptMetadata.ItemHiddenMessageArguments> ItemHiddenMessage

Initial value:

=
        new DynamicMessageType<>(
            "Message.ListBox.ItemHidden", ListBoxConceptMetadata.ItemHiddenMessageArguments.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.

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.

ItemVisibleMessage

DynamicMessageType<ListBoxConceptMetadata.ItemVisibleMessageArguments> ItemVisibleMessage

Initial value:

=
        new DynamicMessageType<>("Message.ListBox.ItemVisible",
            ListBoxConceptMetadata.ItemVisibleMessageArguments.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.

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.

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. By setting the value of this property to the index of the item that you want to select in a List Box, you can select that item.

SelectionBehaviorProperty

DynamicPropertyType<Integer> SelectionBehaviorProperty

Initial value:

=
        new DynamicPropertyType<>("ListBoxConcept.SelectionBehavior", Integer.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.