A collection of states.
Go to Property Listing | Method Listing
[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
State [] (index:Number)
Returns the State with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
State add (withProperties:Object)
Creates a new State.
|
Parameter |
Type |
Description |
|---|---|---|
|
withProperties |
Initial values for properties of the new State (Optional) |
State anyItem ()
Returns any State in the collection.
Number count ()
Displays the number of elements in the State.
State everyItem ()
Returns every State in the collection.
State firstItem ()
Returns the first State in the collection.
State item (index:Varies LongInteger String)
Returns the State with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
State itemByID (id:Number)
Returns the State with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
State itemByName (name:String)
Returns the State with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
State itemByRange (from:Varies LongInteger State String, to:Varies LongInteger State String)
Returns the States within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The State, index, or name at the beginning of the range. Can accept: State, Long Integer or String. |
|
to |
LongInteger |
The State, index, or name at the end of the range. Can accept: State, Long Integer or String. |
State lastItem ()
Returns the last State in the collection.
State middleItem ()
Returns the middle State in the collection.
State nextItem (obj:State)
Returns the State whose index follows the specified State in the collection.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The State whose index comes before the desired State. |
State previousItem (obj:State)
Returns the State with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the State that follows the desired State. |
String toSource ()
Generates a string which, if executed, will return the State.