Kanzi  3.9.2
Java API
ScrollViewConceptMetadata Interface Reference

Metadata definitions for ScrollViewConcept. More...

Inheritance diagram for ScrollViewConceptMetadata:
[legend]

Classes

interface  ScrollDirectionMessageArguments
 Metadata definitions for ScrollDirectionMessageArguments. More...
 
interface  ScrollDownMessageArguments
 Metadata definitions for ScrollDownMessageArguments. More...
 
interface  ScrollEdgeMessageArguments
 Metadata definitions for ScrollEdgeMessageArguments. More...
 
interface  ScrolledMessageArguments
 Metadata definitions for ScrolledMessageArguments. More...
 
interface  ScrollEndMessageArguments
 Metadata definitions for ScrollEndMessageArguments. More...
 
interface  ScrollFinishedMessageArguments
 Metadata definitions for ScrollFinishedMessageArguments. More...
 
interface  ScrollHomeMessageArguments
 Metadata definitions for ScrollHomeMessageArguments. More...
 
interface  ScrollLeftMessageArguments
 Metadata definitions for ScrollLeftMessageArguments. More...
 
interface  ScrollMessageArguments
 Metadata definitions for ScrollMessageArguments. More...
 
interface  ScrollPageDownMessageArguments
 Metadata definitions for ScrollPageDownMessageArguments. More...
 
interface  ScrollPageMessageArguments
 Metadata definitions for ScrollPageMessageArguments. More...
 
interface  ScrollPageUpMessageArguments
 Metadata definitions for ScrollPageUpMessageArguments. More...
 
interface  ScrollPositionMessageArguments
 Metadata definitions for ScrollPositionMessageArguments. More...
 
interface  ScrollRightMessageArguments
 Metadata definitions for ScrollRightMessageArguments. More...
 
interface  ScrollStartedMessageArguments
 Metadata definitions for ScrollStartedMessageArguments. More...
 
interface  ScrollTargetMessageArguments
 Metadata definitions for ScrollTargetMessageArguments. More...
 
interface  ScrollUpMessageArguments
 Metadata definitions for ScrollUpMessageArguments. More...
 
interface  SetScrollMessageArguments
 Metadata definitions for SetScrollMessageArguments. More...
 
interface  SetScrollTargetMessageArguments
 Metadata definitions for SetScrollTargetMessageArguments. More...
 
interface  SnapMessageArguments
 Metadata definitions for SnapMessageArguments. More...
 
interface  SnapRequestMessageArguments
 Metadata definitions for SnapRequestMessageArguments. More...
 
interface  UserScrollFinishedMessageArguments
 Metadata definitions for UserScrollFinishedMessageArguments. More...
 
interface  UserScrollStartedMessageArguments
 Metadata definitions for UserScrollStartedMessageArguments. More...
 
interface  ZoomedMessageArguments
 Metadata definitions for ZoomedMessageArguments. More...
 

Public Attributes

DynamicPropertyType< Integer > AllowedScrollAxisProperty
 Sets the axis on which you want to allow this Scroll View node to scroll. More...
 
DynamicPropertyType< Float > DraggingAccelerationCoefficientProperty
 Sets the acceleration of the node controlled by a Scroll View node while you drag that Scroll View node. More...
 
DynamicPropertyType< Float > DraggingDragCoefficientProperty
 Sets the amount that drag affects the movement of the node controlled by a Scroll View node while you drag that Scroll View node. More...
 
DynamicPropertyType< Float > DraggingImpulseFactorProperty
 Sets the amount of impulse generated from the pointing device movement when dragging a Scroll View node. More...
 
DynamicPropertyType< Boolean > LoopingXEnabledProperty
 Sets the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the x axis. More...
 
DynamicPropertyType< Boolean > LoopingYEnabledProperty
 Sets the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the y axis. More...
 
DynamicPropertyType< Integer > MaximumNumberOfTouchesProperty
 Sets the maximum number of touch points allowed for a Scroll View pan. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ScrollViewConcept")
 Metaclass for ScrollViewConcept.
 
DynamicPropertyType< Integer > MinimumNumberOfTouchesProperty
 Sets the required number of touch points pressed for a Scroll View node pan to start. More...
 
DynamicPropertyType< Float > RecognitionThresholdProperty
 Sets the amount a pointing device must move for the scrolling to start on a Scroll View node. More...
 
DynamicPropertyType< Vector2ScrollBoundsMaximumProperty
 Sets the coordinates of the bottom-right corner of the scroll bounds rectangle. More...
 
DynamicPropertyType< Vector2ScrollBoundsMinimumProperty
 Sets the coordinates of the top-left corner of the scroll bounds rectangle. More...
 
AbstractMessageType ScrollDirectionMessage
 Sets the scroll delta to one step and starts scrolling in that direction. More...
 
AbstractMessageType ScrollDownMessage
 Sets the scroll delta to one step down and starts scrolling in that direction. More...
 
AbstractMessageType ScrollEdgeMessage
 Sets the scroll target to the edge of a Scroll View node and starts scrolling in that direction. More...
 
AbstractMessageType ScrolledMessage = new AbstractMessageType("Message.ScrollView.Scrolled")
 Occurs when the scroll position of a Scroll View node changes.
 
AbstractMessageType ScrollEndedMessage
 Occurs when the scroll position of a Scroll View node stops changing. More...
 
AbstractMessageType ScrollEndMessage = new AbstractMessageType("Message.ScrollView.ScrollEnd")
 Sets the scroll delta to end and starts scrolling in that direction. More...
 
AbstractMessageType ScrollHomeMessage
 Sets the scroll delta to home and starts scrolling in that direction. More...
 
DynamicPropertyType< Boolean > ScrollingProperty
 Whether a Scroll View node is currently scrolling (read-only). More...
 
AbstractMessageType ScrollLeftMessage
 Sets the scroll delta to one step left and starts scrolling in that direction. More...
 
AbstractMessageType ScrollPageDownMessage
 Sets the scroll delta to one page down and starts scrolling in that direction. More...
 
AbstractMessageType ScrollPageMessage
 Sets the scroll delta to one page and starts scrolling in that direction. More...
 
AbstractMessageType ScrollPageUpMessage
 Sets the scroll delta to one page up and starts scrolling in that direction. More...
 
DynamicPropertyType< Vector2ScrollPositionProperty
 Sets the scroll position of the Scroll View along the x and y axes as a relative position within the scroll view area. More...
 
AbstractMessageType ScrollRightMessage
 Sets the scroll delta to one step right and starts scrolling in that direction. More...
 
DynamicPropertyType< Vector2ScrollSpeedProperty
 The current scroll speed (read-only). More...
 
AbstractMessageType ScrollStartedMessage
 Occurs when the scroll position of a Scroll View node starts changing. More...
 
DynamicPropertyType< Vector2ScrollTargetPositionProperty
 The current target scroll value (read-only). More...
 
AbstractMessageType ScrollUpMessage = new AbstractMessageType("Message.ScrollView.ScrollUp")
 Sets the scroll delta to one step up and starts scrolling in that direction. More...
 
DynamicPropertyType< Float > SensitivityProperty
 Sets the amount the position changes relative to the movement of the pointer that starts the swiping. More...
 
AbstractMessageType SetScrollMessage = new AbstractMessageType("Message.ScrollView.SetScroll")
 Sets the scroll position of a Scroll View node.
 
AbstractMessageType SetScrollTargetMessage
 Sets the scrolling target of the scroll view. More...
 
DynamicPropertyType< Float > SlidingAccelerationCoefficientProperty
 Sets the acceleration of the node controlled by a Scroll View node after you release the pointer with which you swipe. More...
 
DynamicPropertyType< Float > SlidingDragCoefficientProperty
 Sets the amount that drag affects the movement of the node controlled by a Scroll View node after you release the pointer with which you swipe. More...
 
AbstractMessageType SnapRequestMessage
 Occurs when a Scroll View node requests snapping target from the hosting component. More...
 
DynamicPropertyType< Float > StepMultiplierProperty
 Sets the smallest distance that a Scroll View scrolls. More...
 
DynamicPropertyType< Float > SwipeDistanceProperty
 Sets the distance that a swipe sends the scroll value, relative to the pointing device speed. More...
 
AbstractMessageType UserScrollEndedMessage
 Occurs when the user stops scrolling a Scroll View node. More...
 
AbstractMessageType UserScrollStartedMessage
 Occurs when the user starts scrolling a Scroll View node. More...
 
DynamicPropertyType< Boolean > ZoomAffectsScrollingProperty
 Controls whether the scroll position is scaled, according to the zoom level. More...
 
AbstractMessageType ZoomedMessage = new AbstractMessageType("Message.ScrollView.Zoomed")
 Occurs when the zoom level of a Scroll View node changes.
 
DynamicPropertyType< Boolean > ZoomEnabledProperty
 Sets whether to install a pinch manipulator that generates zoom messages. More...
 
DynamicPropertyType< Float > ZoomMaximumProperty
 Sets the maximum zoom level. More...
 
DynamicPropertyType< Float > ZoomMinimumProperty
 Sets the minimum zoom level. More...
 
DynamicPropertyType< Float > ZoomProperty
 Sets the current zoom level. More...
 

Detailed Description

Metadata definitions for ScrollViewConcept.

Member Data Documentation

◆ AllowedScrollAxisProperty

DynamicPropertyType<Integer> AllowedScrollAxisProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.AllowedScrollAxis", Integer.class)

Sets the axis on which you want to allow this Scroll View node to scroll.

◆ DraggingAccelerationCoefficientProperty

DynamicPropertyType<Float> DraggingAccelerationCoefficientProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.DraggingAccelerationCoefficient", Float.class)

Sets the acceleration of the node controlled by a Scroll View node while you drag that Scroll View node.

Use low values when you want that node to slowly reach the final position. Use high values when you want that node to quickly reach the final position.

◆ DraggingDragCoefficientProperty

DynamicPropertyType<Float> DraggingDragCoefficientProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.DraggingDragCoefficient", Float.class)

Sets the amount that drag affects the movement of the node controlled by a Scroll View node while you drag that Scroll View node.

The lower the value the higher the drag and the faster the sliding of that node stops.

◆ DraggingImpulseFactorProperty

DynamicPropertyType<Float> DraggingImpulseFactorProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.DraggingImpulseFactor", Float.class)

Sets the amount of impulse generated from the pointing device movement when dragging a Scroll View node.

◆ LoopingXEnabledProperty

DynamicPropertyType<Boolean> LoopingXEnabledProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.LoopingXEnabled", Boolean.class)

Sets the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the x axis.

When the scroll value reaches the maximum value of the bound, the value changes to the minimum value and the other way around. Use the Scroll Bounds Minimum and Scroll Bounds Maximum properties to set the scroll bounds.

◆ LoopingYEnabledProperty

DynamicPropertyType<Boolean> LoopingYEnabledProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.LoopingYEnabled", Boolean.class)

Sets the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the y axis.

When the scroll value reaches the maximum value of the bound, the value changes to the minimum value and the other way around. Use the Scroll Bounds Minimum and Scroll Bounds Maximum properties to set the scroll bounds.

◆ MaximumNumberOfTouchesProperty

DynamicPropertyType<Integer> MaximumNumberOfTouchesProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.MaximumNumberOfTouches", Integer.class)

Sets the maximum number of touch points allowed for a Scroll View pan.

◆ MinimumNumberOfTouchesProperty

DynamicPropertyType<Integer> MinimumNumberOfTouchesProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.MinimumNumberOfTouches", Integer.class)

Sets the required number of touch points pressed for a Scroll View node pan to start.

Scroll View nodes with minimum number of touches greater than one precede the children in touch processing.

◆ RecognitionThresholdProperty

DynamicPropertyType<Float> RecognitionThresholdProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.RecognitionThreshold", Float.class)

Sets the amount a pointing device must move for the scrolling to start on a Scroll View node.

◆ ScrollBoundsMaximumProperty

DynamicPropertyType<Vector2> ScrollBoundsMaximumProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.ScrollBoundsMaximum", Vector2.class)

Sets the coordinates of the bottom-right corner of the scroll bounds rectangle.

Scroll bounds define where the scrolling begins and ends.

◆ ScrollBoundsMinimumProperty

DynamicPropertyType<Vector2> ScrollBoundsMinimumProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.ScrollBoundsMinimum", Vector2.class)

Sets the coordinates of the top-left corner of the scroll bounds rectangle.

Scroll bounds define where the scrolling begins and ends.

◆ ScrollDirectionMessage

AbstractMessageType ScrollDirectionMessage
Initial value:
=
new AbstractMessageType("Message.ScrollView.ScrollDirection")

Sets the scroll delta to one step and starts scrolling in that direction.

◆ ScrollDownMessage

AbstractMessageType ScrollDownMessage
Initial value:
=
new AbstractMessageType("Message.ScrollView.ScrollDown")

Sets the scroll delta to one step down and starts scrolling in that direction.

Use this action to scroll a Scroll View or Grid List Box node.

◆ ScrollEdgeMessage

AbstractMessageType ScrollEdgeMessage
Initial value:
=
new AbstractMessageType("Message.ScrollView.ScrollEdge")

Sets the scroll target to the edge of a Scroll View node and starts scrolling in that direction.

◆ ScrollEndedMessage

AbstractMessageType ScrollEndedMessage
Initial value:
=
new AbstractMessageType("Message.ScrollView.ScrollEnded")

Occurs when the scroll position of a Scroll View node stops changing.

◆ ScrollEndMessage

AbstractMessageType ScrollEndMessage = new AbstractMessageType("Message.ScrollView.ScrollEnd")

Sets the scroll delta to end and starts scrolling in that direction.

Use this action to scroll a Scroll View or Grid List Box node.

◆ ScrollHomeMessage

AbstractMessageType ScrollHomeMessage
Initial value:
=
new AbstractMessageType("Message.ScrollView.ScrollHome")

Sets the scroll delta to home and starts scrolling in that direction.

Use this action to scroll a Scroll View or Grid List Box node.

◆ ScrollingProperty

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

Whether a Scroll View node is currently scrolling (read-only).

◆ ScrollLeftMessage

AbstractMessageType ScrollLeftMessage
Initial value:
=
new AbstractMessageType("Message.ScrollView.ScrollLeft")

Sets the scroll delta to one step left and starts scrolling in that direction.

Use this action to scroll a Scroll View or Grid List Box node.

◆ ScrollPageDownMessage

AbstractMessageType ScrollPageDownMessage
Initial value:
=
new AbstractMessageType("Message.ScrollView.ScrollPageDown")

Sets the scroll delta to one page down and starts scrolling in that direction.

Use this action to scroll a Scroll View or Grid List Box node.

◆ ScrollPageMessage

AbstractMessageType ScrollPageMessage
Initial value:
=
new AbstractMessageType("Message.ScrollView.ScrollPage")

Sets the scroll delta to one page and starts scrolling in that direction.

◆ ScrollPageUpMessage

AbstractMessageType ScrollPageUpMessage
Initial value:
=
new AbstractMessageType("Message.ScrollView.ScrollPageUp")

Sets the scroll delta to one page up and starts scrolling in that direction.

Use this action to scroll a Scroll View or Grid List Box node.

◆ ScrollPositionProperty

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

Sets the scroll position of the Scroll View along the x and y axes as a relative position within the scroll view area.

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

◆ ScrollRightMessage

AbstractMessageType ScrollRightMessage
Initial value:
=
new AbstractMessageType("Message.ScrollView.ScrollRight")

Sets the scroll delta to one step right and starts scrolling in that direction.

Use this action to scroll a Scroll View or Grid List Box node.

◆ ScrollSpeedProperty

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

The current scroll speed (read-only).

◆ ScrollStartedMessage

AbstractMessageType ScrollStartedMessage
Initial value:
=
new AbstractMessageType("Message.ScrollView.ScrollStarted")

Occurs when the scroll position of a Scroll View node starts changing.

◆ ScrollTargetPositionProperty

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

The current target scroll value (read-only).

◆ ScrollUpMessage

AbstractMessageType ScrollUpMessage = new AbstractMessageType("Message.ScrollView.ScrollUp")

Sets the scroll delta to one step up and starts scrolling in that direction.

Use this action to scroll a Scroll View or Grid List Box node.

◆ SensitivityProperty

DynamicPropertyType<Float> SensitivityProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.Sensitivity", Float.class)

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

The higher the value the more the position of the node controlled by a Scroll View node changes. The default value is 1.

◆ SetScrollTargetMessage

AbstractMessageType SetScrollTargetMessage
Initial value:
=
new AbstractMessageType("Message.ScrollView.SetScrollTarget")

Sets the scrolling target of the scroll view.

◆ SlidingAccelerationCoefficientProperty

DynamicPropertyType<Float> SlidingAccelerationCoefficientProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.SlidingAccelerationCoefficient", Float.class)

Sets the acceleration of the node controlled by a Scroll View node after you release the pointer with which you swipe.

Use low values when you want that node to slowly reach the final position. Use high values when you want that node to quickly reach the final position.

◆ SlidingDragCoefficientProperty

DynamicPropertyType<Float> SlidingDragCoefficientProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.SlidingDragCoefficient", Float.class)

Sets the amount that drag affects the movement of the node controlled by a Scroll View node after you release the pointer with which you swipe.

The lower the value the higher the drag and the faster the sliding of the object controlled by the Scroll View node stops.

◆ SnapRequestMessage

AbstractMessageType SnapRequestMessage
Initial value:
=
new AbstractMessageType("Message.ScrollView.SnapRequest")

Occurs when a Scroll View node requests snapping target from the hosting component.

◆ StepMultiplierProperty

DynamicPropertyType<Float> StepMultiplierProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.StepMultiplier", Float.class)

Sets the smallest distance that a Scroll View scrolls.

◆ SwipeDistanceProperty

DynamicPropertyType<Float> SwipeDistanceProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.SwipeDistance", Float.class)

Sets the distance that a swipe sends the scroll value, relative to the pointing device speed.

◆ UserScrollEndedMessage

AbstractMessageType UserScrollEndedMessage
Initial value:
=
new AbstractMessageType("Message.ScrollView.UserScrollEnded")

Occurs when the user stops scrolling a Scroll View node.

◆ UserScrollStartedMessage

AbstractMessageType UserScrollStartedMessage
Initial value:
=
new AbstractMessageType("Message.ScrollView.UserScrollStarted")

Occurs when the user starts scrolling a Scroll View node.

◆ ZoomAffectsScrollingProperty

DynamicPropertyType<Boolean> ZoomAffectsScrollingProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.ZoomAffectsScrolling", Boolean.class)

Controls whether the scroll position is scaled, according to the zoom level.

◆ ZoomEnabledProperty

DynamicPropertyType<Boolean> ZoomEnabledProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.ZoomEnabled", Boolean.class)

Sets whether to install a pinch manipulator that generates zoom messages.

◆ ZoomMaximumProperty

DynamicPropertyType<Float> ZoomMaximumProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.ZoomMaximum", Float.class)

Sets the maximum zoom level.

◆ ZoomMinimumProperty

DynamicPropertyType<Float> ZoomMinimumProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.ZoomMinimum", Float.class)

Sets the minimum zoom level.

◆ ZoomProperty

DynamicPropertyType<Float> ZoomProperty
Initial value:
=
new DynamicPropertyType<>("ScrollViewConcept.Zoom", Float.class)

Sets the current zoom level.