Class PLIndex

Object
   |
   +--GrvObject
         |
         +--EDOIndex
               |
               +--PLIndex

class PLIndex

extends EDOIndex

This class encapsulates an EDO index for Plain/Loan.
Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)
See:

- konstructor()

Constructor Detail

PLIndex

PLIndex()

Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)
See:
- konstructor()

_itString

String _itString( pindex )

return item/property description

_lonString

String _lonString( cindex )

return loan description

_noString

Object _noString()

asEventArgs

String asEventArgs()

return "this" as event handler arg list string

asString

String asString()

return "this" as a description string

equals

boolean equals(x)

return whether "this" equals given EDOIndex

hasSelection

boolean hasSelection()

return whether "this" contains a selection

invoke

Object invoke(<Object> self,<Function> pMethod,<Function> lMethod,<Object> optArg)

Invoke the appropriate method given the index type and return its result. Methods are expected to have the signature

 self.method(this.subindex,optionalArgument)

Parameters:
self - the parent object of the method
pMethod - method to call if xi is Plain type
lMethod - method to call if xi is Loan type
optArg - optional extra param to pass to method

Returns:
the result of the called method

konstructor

void konstructor( <int> optP,<int> optL )

Parameters:
optP - index into Item list for current Auction
optL - index into Loan list for specified Item If args not specified or if all are null then this represents "no selection".

Item

<static> PLIndex Item()

synonym for PLIndex.Plain

Loan

<static> BSCIndex Loan()

Static factory method to generate Loan-flavored index

Parameters:
index - Loan index

Plain

<static> PLIndex Plain()

Static factory method to generate Item-flavored index

Parameters:
index - Item index