Kanzi  3.9.6
Java API
ScrollViewConceptMetadata.ScrollMessageArguments Class Reference

Metadata definitions for ScrollMessageArguments. More...

Inheritance diagram for ScrollViewConceptMetadata.ScrollMessageArguments:
[legend]

Public Member Functions

 ScrollMessageArguments ()
 Construct a new messageArgumentsClassName instance.
 
 ScrollMessageArguments (long nativeObject)
 Wrap a native instance. More...
 
Float getScrollPositionXProperty ()
 Getter for ScrollPositionXProperty.
 
Float getScrollPositionYProperty ()
 Getter for ScrollPositionYProperty.
 
Vector2 getScrollSpeedProperty ()
 Getter for ScrollSpeedProperty.
 
void setScrollPositionXProperty (Float value)
 Setter for ScrollPositionXProperty.
 
void setScrollPositionYProperty (Float value)
 Setter for ScrollPositionYProperty.
 
void setScrollSpeedProperty (Vector2 value)
 Setter for ScrollSpeedProperty.
 
- Public Member Functions inherited from MessageArguments
 MessageArguments ()
 Constructs a new MessageArguments object. More...
 
TDataType getArgument (PropertyType< TDataType > propertyType)
 Returns the value of an argument. More...
 
TDataType getOptionalArgument (PropertyType< TDataType > propertyType)
 Returns the value of an argument, but does not use the default value if there are no inputs to the argument value. More...
 
TNodeType getSource ()
 Returns the source node for a message. More...
 
boolean isHandled ()
 Returns whether the message is handled. More...
 
void setArgument (PropertyType< TDataType > propertyType, TDataType value)
 Sets the value of an argument. More...
 
void setArgument (PropertyType< Integer > propertyType, EnumType value)
 Sets the value of an integer argument using a constant from an enumeration. More...
 
void setHandled (boolean handled)
 Sets the handling status for a message. More...
 

Static Public Attributes

static final AbstractMetaclass metaclass
 Metaclass for ScrollMessageArguments. More...
 
static final DynamicPropertyType< Float > ScrollPositionXProperty
 Sets the x axis coordinate for the new scroll position of a Scroll View node. More...
 
static final DynamicPropertyType< Float > ScrollPositionYProperty
 Sets the y axis coordinate for the new scroll position of a Scroll View node. More...
 
static final DynamicPropertyType< Vector2ScrollSpeedProperty
 Sets the scrolling speed of a Scroll View node. More...
 

Additional Inherited Members

- Public Attributes inherited from ScrollViewConceptMetadata.ScrollTargetMessageArguments
AbstractMetaclass metaclass
 Metaclass for ScrollTargetMessageArguments. More...
 
DynamicPropertyType< Vector2ScrollTargetProperty
 Sets the target position for a Scroll View node. More...
 
- Public Attributes inherited from ScrollViewConceptMetadata.ScrollPositionMessageArguments
AbstractMetaclass metaclass
 Metaclass for ScrollPositionMessageArguments. More...
 
DynamicPropertyType< Vector2ScrollPositionProperty
 Sets the x and y axis coordinates for the new scroll position of a Scroll View node. More...
 
- Public Attributes inherited from ScrollViewConceptMetadata.SnapMessageArguments
AbstractMetaclass metaclass
 Metaclass for SnapMessageArguments. More...
 
DynamicPropertyType< Vector2SnapDirectionProperty
 Sets the direction of a snap request. More...
 
DynamicPropertyType< Vector2SnapPositionProperty
 Sets the target of a snap request. More...
 
- Protected Member Functions inherited from MessageArguments
 MessageArguments (long nativeObject)
 Wraps a native message argument. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ ScrollMessageArguments()

ScrollMessageArguments ( long  nativeObject)

Wrap a native instance.

Parameters
nativeObjectReference to a native instance.

Member Data Documentation

◆ metaclass

final AbstractMetaclass metaclass
static
Initial value:
=
new AbstractMetaclass("Kanzi.ScrollViewConcept.ScrollMessageArguments")

Metaclass for ScrollMessageArguments.

◆ ScrollPositionXProperty

final DynamicPropertyType<Float> ScrollPositionXProperty
static
Initial value:
=
new DynamicPropertyType<>("MessageArgument.ScrollView.ScrollPositionX", Float.class)

Sets the x axis coordinate for the new scroll position of a Scroll View node.

◆ ScrollPositionYProperty

final DynamicPropertyType<Float> ScrollPositionYProperty
static
Initial value:
=
new DynamicPropertyType<>("MessageArgument.ScrollView.ScrollPositionY", Float.class)

Sets the y axis coordinate for the new scroll position of a Scroll View node.

◆ ScrollSpeedProperty

final DynamicPropertyType<Vector2> ScrollSpeedProperty
static
Initial value:
=
new DynamicPropertyType<>("MessageArgument.ScrollView.ScrollSpeed", Vector2.class)

Sets the scrolling speed of a Scroll View node.