Class LoopIterator

• TopLevel.Object
  • dw.util.Iterator
    • dw.web.LoopIterator

Iterator used in implementation. It defines properties used to determine loop status. LoopIterator object is assigned to variable declared in “status” attribute of the tag.

Property Summary 

Property	Description
begin: Number (read-only)	Return begin iteration index.
count: Number (read-only)	Return iteration count, starting with 1.
end: Number (read-only)	Return end iteration index.
even: Boolean (read-only)	Identifies if count is an even value.
first: Boolean (read-only)	Identifies if the iterator is positioned at first iteratable item.
index: Number (read-only)	Return iteration index, which is the position of the iterator in the underlying iteratable object.
last: Boolean (read-only)	Identifies if the iterator is positioned at last iteratable item.
length: Number (read-only)	Return the length of the object.
odd: Boolean (read-only)	Identifies if count is an odd value.
step: Number (read-only)	Return iterator step.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

Method	Description
getBegin()	Return begin iteration index.
getCount()	Return iteration count, starting with 1.
getEnd()	Return end iteration index.
getIndex()	Return iteration index, which is the position of the iterator in the underlying iteratable object.
getLength()	Return the length of the object.
getStep()	Return iterator step.
isEven()	Identifies if count is an even value.
isFirst()	Identifies if the iterator is positioned at first iteratable item.
isLast()	Identifies if the iterator is positioned at last iteratable item.
isOdd()	Identifies if count is an odd value.

Methods inherited from class Iterator 

asList, asList, hasNext, next

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Property Details 

begin 

begin: Number (read-only)

Return begin iteration index. By default begin index is 0.

---

count 

count: Number (read-only)

Return iteration count, starting with 1.

---

end 

end: Number (read-only)

Return end iteration index. By default end index equals 'length - 1', provided that length is determined. If length cannot be determined end index is -1.

---

even 

even: Boolean (read-only)

Identifies if count is an even value.

---

first 

first: Boolean (read-only)

Identifies if the iterator is positioned at first iteratable item.

---

index 

index: Number (read-only)

Return iteration index, which is the position of the iterator in the underlying iteratable object. Index is 0-based and is calculated according the following formula: Index = (Count - 1) * Step.

---

last 

last: Boolean (read-only)

Identifies if the iterator is positioned at last iteratable item.

---

length 

length: Number (read-only)

Return the length of the object. If length cannot be determined, -1 is returned.

---

odd 

odd: Boolean (read-only)

Identifies if count is an odd value.

---

step 

step: Number (read-only)

Return iterator step.

---

Method Details 

getBegin() 

getBegin(): Number

Return begin iteration index. By default begin index is 0.

Returns:

• the begin iteration index.

---

getCount() 

getCount(): Number

Return iteration count, starting with 1.

Returns:

• the iteration count.

---

getEnd() 

getEnd(): Number

Return end iteration index. By default end index equals 'length - 1', provided that length is determined. If length cannot be determined end index is -1.

---

getIndex() 

getIndex(): Number

Return iteration index, which is the position of the iterator in the underlying iteratable object. Index is 0-based and is calculated according the following formula: Index = (Count - 1) * Step.

Returns:

• the iteration index.

---

getLength() 

getLength(): Number

Return the length of the object. If length cannot be determined, -1 is returned.

Returns:

• the length of the object

---

getStep() 

getStep(): Number

Return iterator step.

Returns:

• the iterator step.

---

isEven() 

isEven(): Boolean

Identifies if count is an even value.

Returns:

• true if count is even, false otherwise.

---

isFirst() 

isFirst(): Boolean

Identifies if the iterator is positioned at first iteratable item.

Returns:

• true if the iterator is at first item, false otherwise.

---

isLast() 

isLast(): Boolean

Identifies if the iterator is positioned at last iteratable item.

Returns:

• true if iterator is at last item, false otherwise.

---

isOdd() 

isOdd(): Boolean

Identifies if count is an odd value.

Returns:

• true if count is odd, false otherwise.

---