ButtonConceptMetadata Interface Reference

Metadata definitions for ButtonConcept. More...

Inheritance diagram for ButtonConceptMetadata:

Classes
class	CanceledMessageArguments
	Metadata definitions for CanceledMessageArguments. More...
class	ClickedMessageArguments
	Metadata definitions for ClickedMessageArguments. More...
class	LongPressMessageArguments
	Metadata definitions for LongPressMessageArguments. More...
class	PointerEnteredMessageArguments
	Metadata definitions for PointerEnteredMessageArguments. More...
class	PointerLeftMessageArguments
	Metadata definitions for PointerLeftMessageArguments. More...
class	PressedMessageArguments
	Metadata definitions for PressedMessageArguments. More...
class	ToggledOffMessageArguments
	Metadata definitions for ToggledOffMessageArguments. More...
class	ToggledOnMessageArguments
	Metadata definitions for ToggledOnMessageArguments. More...
class	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.
DynamicMessageType< ButtonConceptMetadata.CanceledMessageArguments >	CancelMessage
	Occurs when a user lifts their finger outside of a Button that they previously pressed.
DynamicMessageType< ButtonConceptMetadata.ClickedMessageArguments >	ClickMessage
	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.
DynamicMessageType< ButtonConceptMetadata.PressedMessageArguments >	DownMessage
	Occurs when the user presses down the Button.
DynamicMessageType< ButtonConceptMetadata.PointerEnteredMessageArguments >	EnterMessage
	Button: Enter trigger is set off:
DynamicPropertyType< Integer >	IndexInGroupProperty
	Sets the index of the Toggle Button in the Toggle Button Group to which that Toggle Button is registered.
DynamicPropertyType< Boolean >	IsPressedProperty
	Indicates whether the button is pressed and in the down state.
DynamicMessageType< ButtonConceptMetadata.PointerLeftMessageArguments >	LeaveMessage
	Button: Leave trigger is set off:
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.
DynamicMessageType< ButtonConceptMetadata.LongPressMessageArguments >	LongPressMessage
	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.
DynamicMessageType< ButtonConceptMetadata.ToggledOffMessageArguments >	ToggledOffMessage
	Occurs when a Toggle Button is toggled off.
DynamicMessageType< ButtonConceptMetadata.ToggledOnMessageArguments >	ToggledOnMessage
	Occurs when a Toggle Button is toggled on.
DynamicPropertyType< Integer >	ToggleStateCountProperty
	Sets the number of toggle states of a Toggle Button.
DynamicMessageType< ButtonConceptMetadata.ToggleStateChangedMessageArguments >	ToggleStateMessage
	Occurs when the toggle state of a Toggle Button changes.
DynamicPropertyType< Integer >	ToggleStateProperty
	Sets the toggle state of a Toggle Button.

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.

CancelMessage

DynamicMessageType<ButtonConceptMetadata.CanceledMessageArguments> CancelMessage

Initial value:

=
        new DynamicMessageType<>(
            "Message.Button.Cancel", ButtonConceptMetadata.CanceledMessageArguments.class)

Occurs when a user lifts their finger outside of a Button that they previously pressed.

ClickMessage

DynamicMessageType<ButtonConceptMetadata.ClickedMessageArguments> ClickMessage

Initial value:

=
        new DynamicMessageType<>(
            "Message.Button.Click", ButtonConceptMetadata.ClickedMessageArguments.class)

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.

DownMessage

DynamicMessageType<ButtonConceptMetadata.PressedMessageArguments> DownMessage

Initial value:

=
        new DynamicMessageType<>(
            "Message.Button.Down", ButtonConceptMetadata.PressedMessageArguments.class)

Occurs when the user presses down the Button.

EnterMessage

DynamicMessageType<ButtonConceptMetadata.PointerEnteredMessageArguments> EnterMessage

Initial value:

=
        new DynamicMessageType<>(
            "Message.Button.Enter", ButtonConceptMetadata.PointerEnteredMessageArguments.class)

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 Toggle Button in the Toggle Button Group to which that Toggle Button is registered.

If a Toggle Button does not have a 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 Toggle 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

DynamicMessageType<ButtonConceptMetadata.PointerLeftMessageArguments> LeaveMessage

Initial value:

=
        new DynamicMessageType<>(
            "Message.Button.Leave", ButtonConceptMetadata.PointerLeftMessageArguments.class)

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.

LongPressMessage

DynamicMessageType<ButtonConceptMetadata.LongPressMessageArguments> LongPressMessage

Initial value:

=
        new DynamicMessageType<>(
            "Message.Button.LongPress", ButtonConceptMetadata.LongPressMessageArguments.class)

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.

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

DynamicMessageType<ButtonConceptMetadata.ToggledOffMessageArguments> ToggledOffMessage

Initial value:

=
        new DynamicMessageType<>("Message.ToggleButton.ToggledOff",
            ButtonConceptMetadata.ToggledOffMessageArguments.class)

Occurs when a Toggle Button is toggled off.

ToggledOnMessage

DynamicMessageType<ButtonConceptMetadata.ToggledOnMessageArguments> ToggledOnMessage

Initial value:

=
        new DynamicMessageType<>("Message.ToggleButton.ToggledOn",
            ButtonConceptMetadata.ToggledOnMessageArguments.class)

Occurs when a Toggle Button is toggled on.

ToggleStateCountProperty

DynamicPropertyType<Integer> ToggleStateCountProperty

Initial value:

=
        new DynamicPropertyType<>("ButtonConcept.ToggleStateCount", Integer.class)

Sets the number of toggle states of a Toggle Button.

ToggleStateMessage

DynamicMessageType<ButtonConceptMetadata.ToggleStateChangedMessageArguments> ToggleStateMessage

Initial value:

= new DynamicMessageType<>("Message.ToggleButton.ToggleState",
            ButtonConceptMetadata.ToggleStateChangedMessageArguments.class)

Occurs when the toggle state of a Toggle Button changes.

ToggleStateProperty

DynamicPropertyType<Integer> ToggleStateProperty

Initial value:

=
        new DynamicPropertyType<>("ButtonConcept.ToggleState", Integer.class)

Sets the toggle state of a Toggle Button.

To update this property with a binding, use a to-source or two-way binding.