Class FieldPositionDescriptor

Object
   |
   +--FieldDescriptor
         |
         +--FieldPositionDescriptor

class FieldPositionDescriptor

extends FieldDescriptor

A field descriptor that specifies a field withing a schema by field position. This type of descriptor is the only one supported if the related schema has been specified by using a SchemaIdDescriptor or a schema identifier.
An field descriptor can also be used to specify an extra field. In this case, a descriptor of this type can still be used, provided that a position higher than the highest field position in the related schema is specified.
Note that directly passing a Number object (or a String object that evaluates to a number) is supported, as a shorthand for a FieldPositionDescriptor, by all interface methods that require a FieldDescriptor object.
Defined in lspushpage.js

Constructor Detail

FieldPositionDescriptor

FieldPositionDescriptor(<Number> fieldPos)

Creates a field descriptor object that specifies a field by position within the related schema.

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

getPosition

Number getPosition()

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

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