com.xuexiang.xui.widget.guidview

Class GuideCaseQueue

java.lang.Object

com.xuexiang.xui.widget.guidview.GuideCaseQueue

All Implemented Interfaces:

DismissListener

public class GuideCaseQueue
extends java.lang.Object
implements DismissListener

Handles queues of GuideCaseView so that they are shown one after another takes care to skip views that should not be shown because of their one shot id

Constructor Summary

Constructors

Constructor and Description
GuideCaseQueue() Constructor

Method Summary

Modifier and Type	Method and Description
GuideCaseQueue	add(GuideCaseView showCaseView) Adds a GuideCaseView to the queue
void	cancel(boolean hideCurrent) Cancels the queue
void	onDismiss(java.lang.String id) is called when a GuideCaseView is dismissed
void	onSkipped(java.lang.String id) is called when a GuideCaseView is skipped because of it's show once id
GuideCaseQueue	setCompleteListener(OnCompleteListener completeListener)
void	show() Starts displaying all views in order of their insertion in the queue, one after another

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GuideCaseQueue

public GuideCaseQueue()

Constructor

Method Detail

add

public GuideCaseQueue add(GuideCaseView showCaseView)

Adds a GuideCaseView to the queue

Parameters:

showCaseView - the view that should be added to the queue

Returns:

Builder

show

public void show()

Starts displaying all views in order of their insertion in the queue, one after another

cancel

public void cancel(boolean hideCurrent)

Cancels the queue

Parameters:

hideCurrent - hides current GuideCaseView

onDismiss

public void onDismiss(java.lang.String id)

Description copied from interface: DismissListener

is called when a GuideCaseView is dismissed

Specified by:

onDismiss in interface DismissListener

Parameters:

id - the show once id of the dismissed view

onSkipped

public void onSkipped(java.lang.String id)

Description copied from interface: DismissListener

is called when a GuideCaseView is skipped because of it's show once id

Specified by:

onSkipped in interface DismissListener

Parameters:

id - the show once id of the dismissed view

setCompleteListener

public GuideCaseQueue setCompleteListener(OnCompleteListener completeListener)