Kanzi framework  3.9.1
Java API
ButtonConceptMetadata Interface Reference

Metadata definitions for ButtonConcept. More...

Inheritance diagram for ButtonConceptMetadata:
[legend]

Classes

interface  CanceledMessageArguments
 Metadata definitions for CanceledMessageArguments. More...
 
interface  ClickedMessageArguments
 Metadata definitions for ClickedMessageArguments. More...
 
interface  LongPressMessageArguments
 Metadata definitions for LongPressMessageArguments. More...
 
interface  PointerEnteredMessageArguments
 Metadata definitions for PointerEnteredMessageArguments. More...
 
interface  PointerLeftMessageArguments
 Metadata definitions for PointerLeftMessageArguments. More...
 
interface  PressedMessageArguments
 Metadata definitions for PressedMessageArguments. More...
 
interface  ToggledOffMessageArguments
 Metadata definitions for ToggledOffMessageArguments. More...
 
interface  ToggledOnMessageArguments
 Metadata definitions for ToggledOnMessageArguments. More...
 
interface  ToggleStateChangedMessageArguments
 Metadata definitions for ToggleStateChangedMessageArguments. More...
 

Public Attributes

DynamicPropertyType< Float > AutoClickIntervalProperty
 Sets the time in milliseconds after which a button that the user keeps pressed down sends the Button: Click message. More...
 
AbstractMessageType CancelMessage = new AbstractMessageType("Message.Button.Cancel")
 Occurs when a user lifts their finger outside of a Button that they previously pressed.
 
AbstractMessageType ClickMessage = new AbstractMessageType("Message.Button.Click")
 Occurs when a user lifts their finger on top of a Button that they previously pressed and when the time set by the Auto Press Interval property in the pressed Button expires.
 
AbstractMessageType DownMessage = new AbstractMessageType("Message.Button.Down")
 Occurs when the user presses down the Button.
 
AbstractMessageType EnterMessage = new AbstractMessageType("Message.Button.Enter")
 Button: Enter trigger is set off: More...
 
DynamicPropertyType< Integer > IndexInGroupProperty
 Sets the index of the Button in the Toggle Button Group to which that Button is registered. More...
 
DynamicPropertyType< Boolean > IsPressedProperty
 Indicates whether the button is pressed and in the down state. More...
 
AbstractMessageType LeaveMessage = new AbstractMessageType("Message.Button.Leave")
 Button: Leave trigger is set off: More...
 
DynamicPropertyType< Float > LongPressIntervalProperty
 Sets the amount of time in milliseconds that the user must hold the button pressed down for Kanzi to recognize it as a long-press gesture. More...
 
AbstractMessageType LongPressMessage = new AbstractMessageType("Message.Button.LongPress")
 Occurs when the user presses down a Button and holds the Button pressed for the amount of milliseconds defined in the Hold Interval property of that Button.
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ButtonConcept")
 Metaclass for ButtonConcept.
 
DynamicPropertyType< Boolean > PressOnHoverProperty
 Whether holding a finger on the device screen and moving it over the button transitions the button to the down state. More...
 
AbstractMessageType ToggledOffMessage
 Occurs when the Button is toggled off. More...
 
AbstractMessageType ToggledOnMessage
 Occurs when the Button is toggled on. More...
 
DynamicPropertyType< Integer > ToggleStateCountProperty
 Sets the number of toggle states of the Button. More...
 
AbstractMessageType ToggleStateMessage
 Occurs when the toggle state of the Button changes. More...
 
DynamicPropertyType< Integer > ToggleStateProperty
 Sets the toggle state of the Button. More...
 

Detailed Description

Metadata definitions for ButtonConcept.

Member Data Documentation

◆ AutoClickIntervalProperty

DynamicPropertyType<Float> AutoClickIntervalProperty
Initial value:
=
new DynamicPropertyType<>("ButtonConcept.AutoClickInterval", Float.class)

Sets the time in milliseconds after which a button that the user keeps pressed down sends the Button: Click message.

While the user holds the button down, the button keeps sending the Button: Click message at the time interval set by this property. To disable the behavior, set to 0.

◆ EnterMessage

AbstractMessageType EnterMessage = new AbstractMessageType("Message.Button.Enter")

Button: Enter trigger is set off:

  • When the user presses down the button.
  • When the user presses down the button, moves the pointer outside of the button area, and then moves the pointer back to the button area while still holding down the pointer.

◆ IndexInGroupProperty

DynamicPropertyType<Integer> IndexInGroupProperty
Initial value:
=
new DynamicPropertyType<>("ButtonConcept.IndexInGroup", Integer.class)

Sets the index of the Button in the Toggle Button Group to which that Button is registered.

If a Button does not have local value for this property, it is not registered to the ancestor Toggle Button Group. When set to -1 the Toggle Button Group assigns an index for the Button.

◆ IsPressedProperty

DynamicPropertyType<Boolean> IsPressedProperty
Initial value:
=
new DynamicPropertyType<>("ButtonConcept.IsPressed", Boolean.class)

Indicates whether the button is pressed and in the down state.

◆ LeaveMessage

AbstractMessageType LeaveMessage = new AbstractMessageType("Message.Button.Leave")

Button: Leave trigger is set off:

  • When the user presses down the button and then lifts the pointer.
  • When the user presses down the button and then moves the pointer outside of the button area.
  • When the user sets off a Button : Long Press trigger.

◆ LongPressIntervalProperty

DynamicPropertyType<Float> LongPressIntervalProperty
Initial value:
=
new DynamicPropertyType<>("ButtonConcept.LongPressInterval", Float.class)

Sets the amount of time in milliseconds that the user must hold the button pressed down for Kanzi to recognize it as a long-press gesture.

To disable the long-press gesture, set to 0.

◆ PressOnHoverProperty

DynamicPropertyType<Boolean> PressOnHoverProperty
Initial value:
=
new DynamicPropertyType<>("ButtonConcept.PressOnHover", Boolean.class)

Whether holding a finger on the device screen and moving it over the button transitions the button to the down state.

◆ ToggledOffMessage

AbstractMessageType ToggledOffMessage
Initial value:
=
new AbstractMessageType("Message.ToggleButton.ToggledOff")

Occurs when the Button is toggled off.

◆ ToggledOnMessage

AbstractMessageType ToggledOnMessage
Initial value:
=
new AbstractMessageType("Message.ToggleButton.ToggledOn")

Occurs when the Button is toggled on.

◆ ToggleStateCountProperty

DynamicPropertyType<Integer> ToggleStateCountProperty
Initial value:
=
new DynamicPropertyType<>("ButtonConcept.ToggleStateCount", Integer.class)

Sets the number of toggle states of the Button.

◆ ToggleStateMessage

AbstractMessageType ToggleStateMessage
Initial value:
=
new AbstractMessageType("Message.ToggleButton.ToggleState")

Occurs when the toggle state of the Button changes.

◆ ToggleStateProperty

DynamicPropertyType<Integer> ToggleStateProperty
Initial value:
=
new DynamicPropertyType<>("ButtonConcept.ToggleState", Integer.class)

Sets the toggle state of the Button.