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.
- Alphabetic
- By Inheritance
- StateApi
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new StateApi(context: StageContext, item: StateItem)
- new StateApi(key: String, context: StageContext, existingValues: Map[String, String], existingItems: (String, StateApi)*)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def _createItem: StateItem
- 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.
- 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.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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.
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- var items: HashMap[String, StateApi]
- val key: String
- 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.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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.
- 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.
- 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.
- 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.
- var values: HashMap[String, String]
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)