TriggerBuilders

public final 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.
@RequiresSchemaVersion(major = 1, minor = 200)
public final class TriggerBuilders.OnVisibleTrigger implements TriggerBuilders.Trigger

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

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

Interface defining the triggers that can be fired.

Public methods
static @NonNull TriggerBuilders.Trigger
@RequiresSchemaVersion(major = 1, minor = 200)
createOnConditionMetTrigger(
    @NonNull DynamicBuilders.DynamicBool dynamicBool
)

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

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

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

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

Public methods

createOnConditionMetTrigger

Added in 1.0.0
@RequiresSchemaVersion(major = 1, minor = 200)
public static @NonNull TriggerBuilders.Trigger createOnConditionMetTrigger(
    @NonNull DynamicBuilders.DynamicBool dynamicBool
)

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)
public static @NonNull TriggerBuilders.Trigger createOnLoadTrigger()

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

createOnVisibleOnceTrigger

Added in 1.3.0-alpha08
@RequiresSchemaVersion(major = 1, minor = 200)
@ProtoLayoutExperimental
public static @NonNull TriggerBuilders.Trigger createOnVisibleOnceTrigger()

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-alpha08
@RequiresSchemaVersion(major = 1, minor = 200)
public static @NonNull TriggerBuilders.Trigger createOnVisibleTrigger()

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.