Kanzi  3.9.7
Java API
ListBoxConcept Interface Reference
Inheritance diagram for ListBoxConcept:
[legend]

Public Member Functions

default boolean addContentItem (Node abstractItem)
 
default Node getContentItem (int index)
 
default long getContentItemCount ()
 
default String getItemContainerGeneratorTypeName ()
 Gets the value of the ItemContainerGeneratorTypeNameProperty. More...
 
default PrefabTemplate getItemContainerTemplate ()
 Gets the value of the ItemContainerTemplateProperty. More...
 
default int getItemCount ()
 Returns the value of the ItemCountProperty. More...
 
default String getItemGeneratorTypeName ()
 Gets the value of the ItemGeneratorTypeNameProperty. More...
 
default PrefabTemplate getItemTemplate ()
 Gets the value of the ItemTemplateProperty. More...
 
default int getKeepAliveItemCount ()
 Gets the value of the KeepAliveItemCountProperty. More...
 
default int getSelectedItemIndex ()
 Gets the value of the SelectedItemIndexProperty. More...
 
default SelectionBehavior getSelectionBehavior ()
 Gets the value of the SelectionBehavior property. More...
 
default boolean isEmpty ()
 Returns whether a list box is empty. More...
 
default void notifyItemAdded (int index)
 Notifies a list box that an item was added. More...
 
default void notifyItemCountChanged ()
 Notifies a list box that the item count changed.
 
default void notifyItemRemoved (int index)
 Notifies a list box that an item was removed. More...
 
default void notifyItemReplaced (int index)
 Notifies a list box that an item was replaced. More...
 
default void removeAllContentItems ()
 
default boolean removeContentItem (Node abstractItem)
 
default void setItemContainerGeneratorTypeName (String value)
 Sets the value of the ItemContainerGeneratorTypeNameProperty. More...
 
default void setItemContainerTemplate (PrefabTemplate value)
 Sets the value of the ItemContainerTemplateProperty. More...
 
default void setItemGeneratorTypeName (String value)
 Sets the value of the ItemGeneratorTypeNameProperty. More...
 
default void setItemTemplate (PrefabTemplate value)
 Sets the value of the ItemTemplateProperty. More...
 
default void setKeepAliveItemCount (int value)
 Sets the value of the KeepAliveItemCountProperty. More...
 
default void setSelectedItemIndex (int value)
 Sets the value of the SelectedItemIndexProperty. More...
 
default void setSelectionBehavior (SelectionBehavior value)
 Sets the value of the SelectionBehavior property. More...
 

Additional Inherited Members

- Public Attributes inherited from ListBoxConceptMetadata
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< ResourceItemContainerTemplateProperty
 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.ItemHiddenMessageArgumentsItemHiddenMessage
 Occurs when an item is unloaded from the working memory. More...
 
DynamicMessageType< ListBoxConceptMetadata.ItemSelectedMessageArgumentsItemSelectedMessage
 Occurs when an item is selected. More...
 
DynamicPropertyType< ResourceItemTemplateProperty
 Sets the prefab to use for the List Box items. More...
 
DynamicMessageType< ListBoxConceptMetadata.ItemVisibleMessageArgumentsItemVisibleMessage
 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< SelectionBehaviorSelectionBehaviorProperty
 Sets how the List Box behaves when the user selects an item. More...
 

Member Function Documentation

default String getItemContainerGeneratorTypeName ( )

Gets the value of the ItemContainerGeneratorTypeNameProperty.

Returns
The name of the item container generator type that the list box uses to provide item containers dynamically.
default PrefabTemplate getItemContainerTemplate ( )

Gets the value of the ItemContainerTemplateProperty.

Returns
The container template that the item container generator uses to instantiate item containers.
default int getItemCount ( )

Returns the value of the ItemCountProperty.

Returns
The number of items in the list box, including the virtual items.
default String getItemGeneratorTypeName ( )

Gets the value of the ItemGeneratorTypeNameProperty.

Returns
The name of the item generator type that provides items dynamically to the list box.
default PrefabTemplate getItemTemplate ( )

Gets the value of the ItemTemplateProperty.

Returns
The template that the list item generator uses to instantiate items.
default int getKeepAliveItemCount ( )

Gets the value of the KeepAliveItemCountProperty.

Returns
The number of invisible list box items to keep in buffer.
default int getSelectedItemIndex ( )

Gets the value of the SelectedItemIndexProperty.

Returns
The index of the selected item.
default SelectionBehavior getSelectionBehavior ( )

Gets the value of the SelectionBehavior property.

Returns
The behavior for the list box scroll when the user clicks an item.
default boolean isEmpty ( )

Returns whether a list box is empty.

Returns
If the list box is empty, true, otherwise false.
default void notifyItemAdded ( int  index)

Notifies a list box that an item was added.

Parameters
indexThe index of the added item.
default void notifyItemRemoved ( int  index)

Notifies a list box that an item was removed.

Parameters
indexThe index of the removed item.
default void notifyItemReplaced ( int  index)

Notifies a list box that an item was replaced.

Parameters
indexThe index of the replaced item.
default void setItemContainerGeneratorTypeName ( String  value)

Sets the value of the ItemContainerGeneratorTypeNameProperty.

Parameters
valueThe name of the item container generator type that the list box uses to provide item containers dynamically.
default void setItemContainerTemplate ( PrefabTemplate  value)

Sets the value of the ItemContainerTemplateProperty.

Parameters
valueThe container template that the item container generator uses to instantiate item containers.
default void setItemGeneratorTypeName ( String  value)

Sets the value of the ItemGeneratorTypeNameProperty.

Parameters
valueThe name of the item generator type that provides items dynamically to the list box.
default void setItemTemplate ( PrefabTemplate  value)

Sets the value of the ItemTemplateProperty.

Parameters
valueThe template that the list item generator uses to instantiate items.
default void setKeepAliveItemCount ( int  value)

Sets the value of the KeepAliveItemCountProperty.

Parameters
valueThe number of invisible list box items to keep in buffer.
default void setSelectedItemIndex ( int  value)

Sets the value of the SelectedItemIndexProperty.

Parameters
valueThe index of the selected item.
default void setSelectionBehavior ( SelectionBehavior  value)

Sets the value of the SelectionBehavior property.

Parameters
valueThe behavior for the list box scroll when the user clicks an item.