NavigationEventCallback


public abstract class NavigationEventCallback


Callback for handling NavigationEvents.

This class maintains its own isEnabled state and will only receive callbacks when enabled.

Summary

Public constructors

NavigationEventCallback(boolean isEnabled, boolean isPassThrough)

Public methods

final boolean
final boolean

Whether this callback should consume the events from NavigationEventDispatcher or allow it to continue.

void

Callback for handling NavigationEventDispatcher.dispatchOnCancelled.

void

Callback for handling NavigationEventDispatcher.dispatchOnCompleted.

void

Callback for handling NavigationEventDispatcher.dispatchOnProgressed.

void

Callback for handling NavigationEventDispatcher.dispatchOnStarted.

final void
final void
setEnabled(boolean isEnabled)

Public constructors

Added in 1.0.0-alpha03
public NavigationEventCallback(boolean isEnabled, boolean isPassThrough)
Parameters
boolean isEnabled

The enabled state for this callback.

boolean isPassThrough

Whether this callback should consume the events from NavigationEventDispatcher or allow it to continue.

Public methods

isEnabled

Added in 1.0.0-alpha03
public final boolean isEnabled()

isPassThrough

Added in 1.0.0-alpha03
public final boolean isPassThrough()

Whether this callback should consume the events from NavigationEventDispatcher or allow it to continue.

onEventCancelled

Added in 1.0.0-alpha03
public void onEventCancelled()

Callback for handling NavigationEventDispatcher.dispatchOnCancelled.

onEventCompleted

Added in 1.0.0-alpha03
public void onEventCompleted()

Callback for handling NavigationEventDispatcher.dispatchOnCompleted.

onEventProgressed

Added in 1.0.0-alpha03
public void onEventProgressed(@NonNull NavigationEvent event)

Callback for handling NavigationEventDispatcher.dispatchOnProgressed.

onEventStarted

Added in 1.0.0-alpha03
public void onEventStarted(@NonNull NavigationEvent event)

Callback for handling NavigationEventDispatcher.dispatchOnStarted.

remove

Added in 1.0.0-alpha03
public final void remove()

setEnabled

Added in 1.0.0-alpha03
public final void setEnabled(boolean isEnabled)