ListBoxConcept Interface Reference

Inheritance diagram for ListBoxConcept:

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.
default PrefabTemplate	getItemContainerTemplate ()
	Gets the value of the ItemContainerTemplateProperty.
default int	getItemCount ()
	Returns the value of the ItemCountProperty.
default String	getItemGeneratorTypeName ()
	Gets the value of the ItemGeneratorTypeNameProperty.
default PrefabTemplate	getItemTemplate ()
	Gets the value of the ItemTemplateProperty.
default int	getKeepAliveItemCount ()
	Gets the value of the KeepAliveItemCountProperty.
default int	getSelectedItemIndex ()
	Gets the value of the SelectedItemIndexProperty.
default SelectionBehavior	getSelectionBehavior ()
	Gets the value of the SelectionBehavior property.
default boolean	isEmpty ()
	Returns whether a list box is empty.
default void	notifyItemAdded (int index)
	Notifies a list box that an item was added.
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.
default void	notifyItemReplaced (int index)
	Notifies a list box that an item was replaced.
default void	removeAllContentItems ()
default boolean	removeContentItem (Node abstractItem)
default void	setItemContainerGeneratorTypeName (String value)
	Sets the value of the ItemContainerGeneratorTypeNameProperty.
default void	setItemContainerTemplate (PrefabTemplate value)
	Sets the value of the ItemContainerTemplateProperty.
default void	setItemGeneratorTypeName (String value)
	Sets the value of the ItemGeneratorTypeNameProperty.
default void	setItemTemplate (PrefabTemplate value)
	Sets the value of the ItemTemplateProperty.
default void	setKeepAliveItemCount (int value)
	Sets the value of the KeepAliveItemCountProperty.
default void	setSelectedItemIndex (int value)
	Sets the value of the SelectedItemIndexProperty.
default void	setSelectionBehavior (SelectionBehavior value)
	Sets the value of the SelectionBehavior property.

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.
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.ItemHiddenMessageArguments >	ItemHiddenMessage
	Occurs when an item is unloaded from 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.ItemVisibleMessageArguments >	ItemVisibleMessage
	Occurs when an item is loaded to 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.
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.

Member Function Documentation

getItemContainerGeneratorTypeName()

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.

getItemContainerTemplate()

default PrefabTemplate getItemContainerTemplate

(

)

Gets the value of the ItemContainerTemplateProperty.

Returns

The container template that the item container generator uses to instantiate item containers.

getItemCount()

default int getItemCount

(

)

Returns the value of the ItemCountProperty.

Returns

The number of items in the list box, including the virtual items.

getItemGeneratorTypeName()

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.

getItemTemplate()

default PrefabTemplate getItemTemplate

(

)

Gets the value of the ItemTemplateProperty.

Returns

The template that the list item generator uses to instantiate items.

getKeepAliveItemCount()

default int getKeepAliveItemCount

(

)

Gets the value of the KeepAliveItemCountProperty.

Returns

The number of invisible list box items to keep in buffer.

getSelectedItemIndex()

default int getSelectedItemIndex

(

)

Gets the value of the SelectedItemIndexProperty.

Returns

The index of the selected item.

getSelectionBehavior()

default SelectionBehavior getSelectionBehavior

(

)

Gets the value of the SelectionBehavior property.

Returns

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

isEmpty()

default boolean isEmpty

(

)

Returns whether a list box is empty.

Returns

If the list box is empty, true, otherwise false.

notifyItemAdded()

default void notifyItemAdded

(

int

index

)

Notifies a list box that an item was added.

Parameters

index

The index of the added item.

notifyItemRemoved()

default void notifyItemRemoved

(

int

index

)

Notifies a list box that an item was removed.

Parameters

index

The index of the removed item.

notifyItemReplaced()

default void notifyItemReplaced

(

int

index

)

Notifies a list box that an item was replaced.

Parameters

index

The index of the replaced item.

setItemContainerGeneratorTypeName()

default void setItemContainerGeneratorTypeName

(

String

value

)

Sets the value of the ItemContainerGeneratorTypeNameProperty.

Parameters

value

The name of the item container generator type that the list box uses to provide item containers dynamically.

setItemContainerTemplate()

default void setItemContainerTemplate

(

PrefabTemplate

value

)

Sets the value of the ItemContainerTemplateProperty.

Parameters

value

The container template that the item container generator uses to instantiate item containers.

setItemGeneratorTypeName()

default void setItemGeneratorTypeName

(

String

value

)

Sets the value of the ItemGeneratorTypeNameProperty.

Parameters

value

The name of the item generator type that provides items dynamically to the list box.

setItemTemplate()

default void setItemTemplate

(

PrefabTemplate

value

)

Sets the value of the ItemTemplateProperty.

Parameters

value

The template that the list item generator uses to instantiate items.

setKeepAliveItemCount()

default void setKeepAliveItemCount

(

int

value

)

Sets the value of the KeepAliveItemCountProperty.

Parameters

value

The number of invisible list box items to keep in buffer.

setSelectedItemIndex()

default void setSelectedItemIndex

(

int

value

)

Sets the value of the SelectedItemIndexProperty.

Parameters

value

The index of the selected item.

setSelectionBehavior()

default void setSelectionBehavior

(

SelectionBehavior

value

)

Sets the value of the SelectionBehavior property.

Parameters

value

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