TriggerBuilders

class TriggerBuilders

Builders for triggers that can be used to start an animation.

Summary

Nested types

Triggers only once when the layout visibility state turns from invisible to fully visible for the first time.

Builder for OnVisibleOnceTrigger.

Triggers when the layout visibility state turns from invisible to fully visible.

Builder for OnVisibleTrigger.
@RequiresSchemaVersion(major = 1, minor = 200)
interface TriggerBuilders.Trigger

Interface defining the triggers that can be fired.

Public functions
java-static TriggerBuilders.Trigger

Creates a Trigger that fires *every time* the condition switches from false to true.
java-static TriggerBuilders.Trigger
@RequiresSchemaVersion(major = 1, minor = 200)
createOnLoadTrigger()

Creates a Trigger that fires immediately when the layout is loaded / reloaded.
java-static TriggerBuilders.Trigger

Creates a Trigger that fires the first time that layout becomes visible.
java-static TriggerBuilders.Trigger
@RequiresSchemaVersion(major = 1, minor = 200)
createOnVisibleTrigger()

Creates a Trigger that fires *every time* the layout becomes visible.

Public functions

createOnConditionMetTrigger

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
java-static fun createOnConditionMetTrigger(dynamicBool: DynamicBuilders.DynamicBool): TriggerBuilders.Trigger

Creates a Trigger that fires *every time* the condition switches from false to true. If the condition is true initially, that will fire the trigger on load.

createOnLoadTrigger

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
java-static fun createOnLoadTrigger(): TriggerBuilders.Trigger

Creates a Trigger that fires immediately when the layout is loaded / reloaded.

createOnVisibleOnceTrigger

Added in 1.3.0-alpha07
@RequiresSchemaVersion(major = 1, minor = 200)
@ProtoLayoutExperimental
java-static fun createOnVisibleOnceTrigger(): TriggerBuilders.Trigger

Creates a Trigger that fires the first time that layout becomes visible.

As opposed to createOnVisibleTrigger, this will only be fired the first time that the layout becomes visible.

createOnVisibleTrigger

Added in 1.3.0-alpha07
@RequiresSchemaVersion(major = 1, minor = 200)
java-static fun createOnVisibleTrigger(): TriggerBuilders.Trigger

Creates a Trigger that fires *every time* the layout becomes visible.

As opposed to createOnLoadTrigger, this will wait until layout is fully visible before firing a trigger.