io.scanbot.sdk.ui.utils.navigator

Interface NodeNavigator.NavigationNode<A extends Activity>

Enclosing class:

NodeNavigator<A extends Activity>

public static NodeNavigator.NavigationNode<A extends Activity>

Node which can be navigated to and from.

Note that implementation MUST be immutable and all methods must produce the same outcome no matter how many times they were called (in other words - be idempotent).

Method Detail

isActionNode

boolean isActionNode()

Returns:

true if this node should remain in navigation history (i.e. should be restored during NodeNavigator.bind or be reachable by NodeNavigator.navigateBack). false if node is fire-and-forget.

navigateTo

void navigateTo(@NotNull
                A activity,
                @NotNull
                java.lang.Object data)

Called when this node is on the top of navigation queue. In other words - show contents of the node.

Take special care to revert ALL changes made at this step in .navigateFrom.

See Also:

.navigateFrom

navigateFrom

void navigateFrom(@NotNull
                  A activity,
                  @NotNull
                  java.lang.Object data)

Called when this node is becoming inactive. In other words - contents of the node should be hidden.

You should revert all changes made in .navigateTo

See Also:

.navigateTo

interceptBackNavigation

boolean interceptBackNavigation(@NotNull
                                A activity)

Returns:

true if this node intercepts .navigateBack event and therefore event should be cancelled. false if this node does not intercept .navigateBack and therefore back navigation will be performed.

canHandleNavigationEvent

boolean canHandleNavigationEvent(@NotNull
                                 java.lang.Object event)

Returns:

true if this node is capable of handling given navigation event. false if this node can't handle this event and it therefore should be passed further.