-
- All Implemented Interfaces:
-
java.io.Serializable
public final class Onboarding implements Serializable
UI components that can be used to onboard the user.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classOnboarding.Companion
-
Field Summary
Fields Modifier and Type Field Description private List<DocutainListItem>itemsprivate DocutainButtonbuttonNextprivate DocutainButtonbuttonFinishprivate DocutainButtonbuttonSkipprivate DocutainButtonbuttonBackprivate ScanHintPopupscanHintPopup
-
Constructor Summary
Constructors Constructor Description Onboarding()
-
Method Summary
Modifier and Type Method Description final List<DocutainListItem>getItems()The items you want to show within the onboarding. final UnitsetItems(List<DocutainListItem> items)The items you want to show within the onboarding. final DocutainButtongetButtonNext()The button that goes to the next item. final UnitsetButtonNext(DocutainButton buttonNext)The button that goes to the next item. final DocutainButtongetButtonFinish()The button that closes the onboarding on the last item. final UnitsetButtonFinish(DocutainButton buttonFinish)The button that closes the onboarding on the last item. final DocutainButtongetButtonSkip()The button to skip (close) the onboarding. final UnitsetButtonSkip(DocutainButton buttonSkip)The button to skip (close) the onboarding. final DocutainButtongetButtonBack()The button that goes to the previous item. final UnitsetButtonBack(DocutainButton buttonBack)The button that goes to the previous item. final ScanHintPopupgetScanHintPopup()A popup that appears when scan is opened for the first time, explaining the user how to scan. final UnitsetScanHintPopup(ScanHintPopup scanHintPopup)A popup that appears when scan is opened for the first time, explaining the user how to scan. -
-
Method Detail
-
getItems
final List<DocutainListItem> getItems()
The items you want to show within the onboarding. See DocutainListItem for more details on what each item can display. You can use defaultItems if you don't want to provide your own. If you want to disable it, set it to null.
-
setItems
final Unit setItems(List<DocutainListItem> items)
The items you want to show within the onboarding. See DocutainListItem for more details on what each item can display. You can use defaultItems if you don't want to provide your own. If you want to disable it, set it to null.
-
getButtonNext
final DocutainButton getButtonNext()
The button that goes to the next item.
-
setButtonNext
final Unit setButtonNext(DocutainButton buttonNext)
The button that goes to the next item.
-
getButtonFinish
final DocutainButton getButtonFinish()
The button that closes the onboarding on the last item.
-
setButtonFinish
final Unit setButtonFinish(DocutainButton buttonFinish)
The button that closes the onboarding on the last item.
-
getButtonSkip
final DocutainButton getButtonSkip()
The button to skip (close) the onboarding.
-
setButtonSkip
final Unit setButtonSkip(DocutainButton buttonSkip)
The button to skip (close) the onboarding.
-
getButtonBack
final DocutainButton getButtonBack()
The button that goes to the previous item. It is disabled by default.
-
setButtonBack
final Unit setButtonBack(DocutainButton buttonBack)
The button that goes to the previous item. It is disabled by default.
-
getScanHintPopup
final ScanHintPopup getScanHintPopup()
A popup that appears when scan is opened for the first time, explaining the user how to scan.
-
setScanHintPopup
final Unit setScanHintPopup(ScanHintPopup scanHintPopup)
A popup that appears when scan is opened for the first time, explaining the user how to scan.
-
-
-
-