class StateApi extends AnyRef

Class providing access to the writable wizard state accessible to the implementer. The state is used to persist information across pages.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StateApi
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new StateApi(context: StageContext, item: StateItem)
  2. new StateApi(key: String, context: StageContext, existingValues: Map[String, String], existingItems: (String, StateApi)*)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def _createItem: StateItem
  5. def addItem(key: String): StateApi

    Add an item to the state for a given key.

    Add an item to the state for a given key.

    key

    The key of the item.

  6. def apply(key: String): String

    Get a value from the state by key.

    Get a value from the state by key.

    key

    The key of the value.

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def getItem(key: String): StateApi

    Get an item from the state by key.

    Get an item from the state by key.

    key

    The key of the item.

  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. var items: HashMap[String, StateApi]
  16. val key: String
  17. def list(key: String): List[String]

    Get a comma-separated value from the state as a list.

    Get a comma-separated value from the state as a list.

    key

    The key of the value.

  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. def tryGet(key: String): Option[String]

    Get a value from the state by key, if available.

    Get a value from the state by key, if available.

    key

    The key of the value.

  24. def tryGetItem(key: String): Option[StateApi]

    Get an item from the state by key, if available.

    Get an item from the state by key, if available.

    key

    The key of the item.

  25. def tryList(key: String): List[String]

    Get a comma-separated value from the state as a list, if the key exists and an empty list otherwise.

    Get a comma-separated value from the state as a list, if the key exists and an empty list otherwise.

    key

    The key of the value.

  26. def update(key: String, value: String): String

    Update or add a value in the state by key.

    Update or add a value in the state by key.

    key

    The key of the value.

  27. var values: HashMap[String, String]
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped