Kanzi  3.9.4
Java API
GridListBoxConceptMetadata Interface Reference

Metadata definitions for GridListBoxConcept. More...

Inheritance diagram for GridListBoxConceptMetadata:
[legend]

Public Attributes

DynamicPropertyType< Float > CalculatedOffsetProperty
 Reports the current relative offset of an item in the Grid List Box in proportional range [0, 1]. More...
 
DynamicPropertyType< Float > CellHeightProperty
 Sets the height of each cell in the Grid List Box. More...
 
DynamicPropertyType< Float > CellWidthProperty
 Sets the width of each cell in the Grid List Box. More...
 
DynamicPropertyType< Integer > DirectionProperty
 Sets the direction in which the Grid List Box arranges its items. More...
 
DynamicPropertyType< Float > GridListBoxDraggingAccelerationCoefficientProperty
 Sets the acceleration of the Grid List Box when the user scrolls the Grid List Box by dragging the pointer. More...
 
DynamicPropertyType< Float > GridListBoxDraggingDragCoefficientProperty
 Sets the amount that drag affects the movement of the Grid List Box when the user scrolls the Grid List Box by dragging the pointer. More...
 
DynamicPropertyType< Float > GridListBoxDraggingImpulseFactorProperty
 Sets the amount of impulse to generate from the pointer movement when the user scrolls the Grid List Box by dragging the pointer. More...
 
DynamicPropertyType< Integer > GridListBoxMaximumNumberOfTouchesProperty
 Sets the maximum number of touch points allowed on the Grid List Box area for scrolling. More...
 
DynamicPropertyType< Integer > GridListBoxMinimumNumberOfTouchesProperty
 Sets the minimum number of touch points required on the Grid List Box area for scrolling. More...
 
DynamicPropertyType< Float > GridListBoxRecognitionThresholdProperty
 Sets the distance in pixels that the pointer has to move for the scrolling to start in the Grid List Box. More...
 
DynamicPropertyType< Float > GridListBoxSensitivityProperty
 Sets the amount that the scroll position changes relative to the movement of the pointer. More...
 
DynamicPropertyType< Float > GridListBoxSlidingAccelerationCoefficientProperty
 Sets the acceleration of the Grid List Box after the user releases the pointer with which they scroll the Grid List Box. More...
 
DynamicPropertyType< Float > GridListBoxSlidingDragCoefficientProperty
 Sets how much drag affects the movement of the Grid List Box after the user releases the pointer with which they scroll the Grid List Box. More...
 
DynamicPropertyType< Float > GridListBoxSwipeDistanceProperty
 Sets the distance that a swipe sends the scroll value in the Grid List Box, relative to the speed of the pointer. More...
 
DynamicPropertyType< Float > ItemAreaBeginProperty
 Sets the proportional offset where the area meant for the fully visible items in the Grid List Box starts. More...
 
DynamicPropertyType< Float > ItemAreaEndProperty
 Sets the proportional offset where the area meant for the fully visible items in the Grid List Box ends. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.GridListBoxConcept")
 Metaclass for GridListBoxConcept.
 
DynamicPropertyType< Boolean > ScrollingProperty
 Reports whether the Grid List Box is currently scrolling. More...
 
DynamicPropertyType< Vector2ScrollPositionProperty
 Sets the scroll position of the Grid List Box along the x and y axes as a relative position within the list box area. More...
 
DynamicPropertyType< Vector2ScrollSpeedProperty
 Reports the current scroll speed of the Grid List Box. More...
 
DynamicPropertyType< Vector2ScrollTargetPositionProperty
 Reports the current target scroll value of the Grid List Box. More...
 

Detailed Description

Metadata definitions for GridListBoxConcept.

Member Data Documentation

◆ CalculatedOffsetProperty

DynamicPropertyType<Float> CalculatedOffsetProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxConcept.CalculatedOffset", Float.class)

Reports the current relative offset of an item in the Grid List Box in proportional range [0, 1].

◆ CellHeightProperty

DynamicPropertyType<Float> CellHeightProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxConcept.CellHeight", Float.class)

Sets the height of each cell in the Grid List Box.

◆ CellWidthProperty

DynamicPropertyType<Float> CellWidthProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxConcept.CellWidth", Float.class)

Sets the width of each cell in the Grid List Box.

◆ DirectionProperty

DynamicPropertyType<Integer> DirectionProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxConcept.Direction", Integer.class)

Sets the direction in which the Grid List Box arranges its items.

When you change the layout direction you also change the scroll axis of the Grid List Box.

◆ GridListBoxDraggingAccelerationCoefficientProperty

DynamicPropertyType<Float> GridListBoxDraggingAccelerationCoefficientProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxDraggingAccelerationCoefficient", Float.class)

Sets the acceleration of the Grid List Box when the user scrolls the Grid List Box by dragging the pointer.

The higher the value, the quicker the Grid List Box reaches its final position. The default value is 80.

◆ GridListBoxDraggingDragCoefficientProperty

DynamicPropertyType<Float> GridListBoxDraggingDragCoefficientProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxDraggingDragCoefficient", Float.class)

Sets the amount that drag affects the movement of the Grid List Box when the user scrolls the Grid List Box by dragging the pointer.

The lower the value, the higher the drag and the quicker the scrolling stops. The default value is 150.

◆ GridListBoxDraggingImpulseFactorProperty

DynamicPropertyType<Float> GridListBoxDraggingImpulseFactorProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxDraggingImpulseFactor", Float.class)

Sets the amount of impulse to generate from the pointer movement when the user scrolls the Grid List Box by dragging the pointer.

◆ GridListBoxMaximumNumberOfTouchesProperty

DynamicPropertyType<Integer> GridListBoxMaximumNumberOfTouchesProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxMaximumNumberOfTouches", Integer.class)

Sets the maximum number of touch points allowed on the Grid List Box area for scrolling.

◆ GridListBoxMinimumNumberOfTouchesProperty

DynamicPropertyType<Integer> GridListBoxMinimumNumberOfTouchesProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxMinimumNumberOfTouches", Integer.class)

Sets the minimum number of touch points required on the Grid List Box area for scrolling.

◆ GridListBoxRecognitionThresholdProperty

DynamicPropertyType<Float> GridListBoxRecognitionThresholdProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxRecognitionThreshold", Float.class)

Sets the distance in pixels that the pointer has to move for the scrolling to start in the Grid List Box.

◆ GridListBoxSensitivityProperty

DynamicPropertyType<Float> GridListBoxSensitivityProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxSensitivity", Float.class)

Sets the amount that the scroll position changes relative to the movement of the pointer.

The default value 1 makes the Grid List Box scroll the same amount as the user drags the pointer. For example, to set the Grid List Box to scroll twice the amount that the user drags the pointer, set the value of the property to 2.

◆ GridListBoxSlidingAccelerationCoefficientProperty

DynamicPropertyType<Float> GridListBoxSlidingAccelerationCoefficientProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxSlidingAccelerationCoefficient", Float.class)

Sets the acceleration of the Grid List Box after the user releases the pointer with which they scroll the Grid List Box.

The higher the value, the quicker the Grid List Box reaches the scroll target. The default value is 40.

◆ GridListBoxSlidingDragCoefficientProperty

DynamicPropertyType<Float> GridListBoxSlidingDragCoefficientProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxSlidingDragCoefficient", Float.class)

Sets how much drag affects the movement of the Grid List Box after the user releases the pointer with which they scroll the Grid List Box.

The lower the value, the higher the drag and the quicker the scrolling of the Grid List Box stops. The default value is 80.

◆ GridListBoxSwipeDistanceProperty

DynamicPropertyType<Float> GridListBoxSwipeDistanceProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxSwipeDistance", Float.class)

Sets the distance that a swipe sends the scroll value in the Grid List Box, relative to the speed of the pointer.

◆ ItemAreaBeginProperty

DynamicPropertyType<Float> ItemAreaBeginProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxConcept.ItemAreaBegin", Float.class)

Sets the proportional offset where the area meant for the fully visible items in the Grid List Box starts.

Kanzi uses the values of the Item Area Begin and Item Area End properties to calculate the value of the Node.VisibleAmountInParent property for each list item.You can use the VisibleAmountInParent property in shaders to fade out those list items that are not fully visible.

◆ ItemAreaEndProperty

DynamicPropertyType<Float> ItemAreaEndProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxConcept.ItemAreaEnd", Float.class)

Sets the proportional offset where the area meant for the fully visible items in the Grid List Box ends.

Kanzi uses the values of the Item Area Begin and Item Area End properties to calculate the value of the Node.VisibleAmountInParent property for each list item.You can use the VisibleAmountInParent property in shaders to fade out those list items that are not fully visible.

◆ ScrollingProperty

DynamicPropertyType<Boolean> ScrollingProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxConcept.Scrolling", Boolean.class)

Reports whether the Grid List Box is currently scrolling.

◆ ScrollPositionProperty

DynamicPropertyType<Vector2> ScrollPositionProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxConcept.ScrollPosition", Vector2.class)

Sets the scroll position of the Grid List Box along the x and y axes as a relative position within the list box area.

Use this property to move the list to a scroll position immediately, without scrolling. To update the scroll position with a binding, use a two-way or to-source binding.

◆ ScrollSpeedProperty

DynamicPropertyType<Vector2> ScrollSpeedProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxConcept.ScrollSpeed", Vector2.class)

Reports the current scroll speed of the Grid List Box.

◆ ScrollTargetPositionProperty

DynamicPropertyType<Vector2> ScrollTargetPositionProperty
Initial value:
=
new DynamicPropertyType<>("GridListBoxConcept.ScrollTargetPosition", Vector2.class)

Reports the current target scroll value of the Grid List Box.