Class baja.SlotCursor

Extends baja.FilterCursor.
A Cursor used for Slot iteration.
Defined in: comp.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	baja.SlotCursor()

Method Summary
Method Attributes	Method Name and Description
	actions() Adds a filter to the Cursor for Actions.
	dynamic() Adds a filter to the Cursor for dynamic Slots.
	eachDisplay(func) Iterate through the Cursor and call 'each' on every Property Slot and get its display String.
	eachValue(func) Iterate through the Cursor and call 'each' on every Property Slot and get its value.
	equalType(typeSpec) Adds a filter for Properties whose Type matches via equals.
	equalValue(value) Adds a filter for Property values that match via equals.
	equivalent(value) Adds a filter for Property values that match via equivalent.
	firstDisplay() Return the first Property display String in the cursor (regardless of iterative state).
	firstValue() Return the first Property value in the cursor (regardless of iterative state).
	flags(flgs) Adds a filter for Slots that match the requested Slot Flags.
	frozen() Adds a filter to the Cursor for frozen Slots.
	getDisplay() If the Slot is a Property, return its display String (otherwise return null).
	getValue() If the Slot is a Property, return its value (otherwise return null).
	is(typeSpec) Adds a filter for Property values that match the TypeSpec via Type#is.
	isComplex() Adds a filter for Property values that are of Type baja:Complex Type#isComplex.
	isComponent() Adds a filter for Property values that are of Type baja:Component Type#isComponent.
	isNumber() Adds a filter for Property values that are of Type baja:Number Type#isNumber.
	isSimple() Adds a filter for Property values that are of Type baja:Simple Type#isSimple.
	isStruct() Adds a filter for Property values that are of Type baja:Struct Type#isStruct.
	isValue() Adds a filter for Property values that are of Type baja:Value Type#isValue.
	lastDisplay() Return the last Property display String in the cursor (regardless of iterative state).
	lastValue() Return the last Property value in the cursor (regardless of iterative state).
	properties() Adds a filter to the Cursor for Properties.
	slotName(slotName) Adds a filter for Slots that match the given Slot name.
	toDisplayArray() Return an array of Property display Strings (regardless of iterative state).
	toDisplayMap() Return an Object Map of Property names with their corresponding display Strings (regardless of iterative state).
	topics() Adds a filter to the Cursor for Topics.
	toValueArray() Return an array of Property values (regardless of iterative state).
	toValueMap() Return an Object Map of Property names with their corresponding values (regardless of iterative state).

Methods borrowed from class baja.FilterCursor:: each, filter, first, get, getIndex, getKey, getSize, isEmpty, last, next, toArray, toMap

Class Detail

baja.SlotCursor()

Method Detail

{baja.SlotCursor} actions()

Adds a filter to the Cursor for Actions.

Returns:: {baja.SlotCursor} itself.

{baja.SlotCursor} dynamic()

Adds a filter to the Cursor for dynamic Slots.

Returns:: {baja.SlotCursor} itself.

eachDisplay(func)

Iterate through the Cursor and call 'each' on every Property Slot and get its display String.

When the function is called, 'this' refers to the associated Complex and the argument is the display String.

Parameters:
{Function} func: function called on every iteration with the argument being a Property's display String

eachValue(func)

Iterate through the Cursor and call 'each' on every Property Slot and get its value.

When the function is called, 'this' refers to the associated Complex and the argument is the value of the Property.

Parameters:
{Function} func: function called on every iteration with the argument being a Property's value.

{baja.SlotCursor} equalType(typeSpec)

Adds a filter for Properties whose Type matches via equals.

This method can take a variable number of TypeSpecs. If a variable number of TypeSpecs are specified then a slot will be filtered through if any of the TypeSpecs match (logical OR).

Parameters:
{Type|String|Array} typeSpec: the TypeSpec to test against.

Returns:: {baja.SlotCursor} itself.

{baja.SlotCursor} equalValue(value)

Adds a filter for Property values that match via equals.

This method can take a variable number of values. If a variable number of values are specified then a slot will be filtered through if any of the values match (logical OR).

Parameters:
value: the value to be used for equals.

Returns:: {baja.SlotCursor} itself.

{baja.SlotCursor} equivalent(value)

Adds a filter for Property values that match via equivalent.

This method can take a variable number of values. If a variable number of values are specified then a slot will be filtered through if any of the values match (logical OR).

Parameters:
value: the value to be used for equivalent.

Returns:: {baja.SlotCursor} itself.

firstDisplay()

Return the first Property display String in the cursor (regardless of iterative state).

Returns:: first Property display String found in the Cursor (or null if nothing found).

firstValue()

Return the first Property value in the cursor (regardless of iterative state).

Returns:: first Property value found in the Cursor (or null if nothing found).

{baja.SlotCursor} flags(flgs)

Adds a filter for Slots that match the requested Slot Flags.

Parameters:
{Number} flgs: the Slot flags to be tested for.

Returns:: {baja.SlotCursor} itself.

See:: baja.Flags

{baja.SlotCursor} frozen()

Adds a filter to the Cursor for frozen Slots.

Returns:: {baja.SlotCursor} itself.

{String} getDisplay()

If the Slot is a Property, return its display String (otherwise return null).

Returns:: {String} display String.

getValue()

If the Slot is a Property, return its value (otherwise return null).

Returns:: a Property value.

{baja.SlotCursor} is(typeSpec)

Adds a filter for Property values that match the TypeSpec via Type#is.

This method can take a variable number of TypeSpecs. If a variable number of TypeSpecs are specified then a slot will be filtered through if any of the TypeSpecs match (logical OR).

Parameters:
{Type|String} typeSpec: the TypeSpec to test against.

Returns:: {baja.SlotCursor} itself.

See:: Type#is

{baja.SlotCursor} isComplex()

Adds a filter for Property values that are of Type baja:Complex Type#isComplex.

Returns:: {baja.SlotCursor} itself.

See:: Type#isComplex

{baja.SlotCursor} isComponent()

Adds a filter for Property values that are of Type baja:Component Type#isComponent.

Returns:: {baja.SlotCursor} itself.

See:: Type#isComponent

{baja.SlotCursor} isNumber()

Adds a filter for Property values that are of Type baja:Number Type#isNumber.

Returns:: {baja.SlotCursor} itself.

See:: Type#isNumber

{baja.SlotCursor} isSimple()

Adds a filter for Property values that are of Type baja:Simple Type#isSimple.

Returns:: {baja.SlotCursor} itself.

See:: Type#isSimple

{baja.SlotCursor} isStruct()

Adds a filter for Property values that are of Type baja:Struct Type#isStruct.

Returns:: {baja.SlotCursor} itself.

See:: Type#isStruct

{baja.SlotCursor} isValue()

Adds a filter for Property values that are of Type baja:Value Type#isValue.

Returns:: {baja.SlotCursor} itself.

See:: Type#isValue

lastDisplay()

Return the last Property display String in the cursor (regardless of iterative state).

Returns:: first Property display String found in the Cursor (or null if nothing found).

lastValue()

Return the last Property value in the cursor (regardless of iterative state).

Returns:: first Property value found in the Cursor (or null if nothing found).

{baja.SlotCursor} properties()

Adds a filter to the Cursor for Properties.

Returns:: {baja.SlotCursor} itself.

{baja.SlotCursor} slotName(slotName)

Adds a filter for Slots that match the given Slot name.

Parameters:
{String|RegEx} slotName: a String or Regular Expression for matching Slots via name.

Returns:: {baja.SlotCursor} itself.

{Number} toDisplayArray()

Return an array of Property display Strings (regardless of iterative state).

Returns:: {Number}

{Object} toDisplayMap()

Return an Object Map of Property names with their corresponding display Strings (regardless of iterative state).

Returns:: {Object}

{baja.SlotCursor} topics()

Adds a filter to the Cursor for Topics.

Returns:: {baja.SlotCursor} itself.

{Number} toValueArray()

Return an array of Property values (regardless of iterative state).

Returns:: {Number}

{Object} toValueMap()

Return an Object Map of Property names with their corresponding values (regardless of iterative state).

Returns:: {Object}

Classes

Class baja.SlotCursor