Class ItemPositionDescriptor

Object
   |
   +--ItemDescriptor
         |
         +--ItemPositionDescriptor

class ItemPositionDescriptor

extends ItemDescriptor

An item descriptor that specifies an item withing a group by item position. This type of descriptor is the only one supported if the related group has been specified by using a GroupIdDescriptor or a group identifier.
Note that directly passing a Number object (or a String object that evaluates to a number) is supported, as a shorthand for an ItemPositionDescriptor, by all interface methods that require an ItemDescriptor object.
Defined in lspushpage.js

Constructor Detail

ItemPositionDescriptor

ItemPositionDescriptor(<Number> itemPos)

Creates an item descriptor object that specifies an item by position within the related group.

Parameters:
itemPos - a 1-based index that represents a position.

getPosition

Number getPosition()

Inquiry method that gets the item position specified by this item descriptor.

Returns:
A 1-based index that represents a position.