Class StreamBlock

Hierarchy (View Summary)

BaseSequenceBlock
- StreamBlock

Constructors

constructor

new StreamBlock(
    blockDef: any,
    placeholder: any,
    prefix: any,
    initialState: any,
    initialError: any,
): StreamBlock
Parameters
- blockDef: any
- placeholder: any
- prefix: any
- initialState: any
- initialError: any
Returns StreamBlock
Overrides BaseSequenceBlock.constructor
- Defined in components/StreamField/blocks/StreamBlock.js:174

Properties

blockCounter

blockCounter: number

blockDef

blockDef: any

childBlockCounts

childBlockCounts: Map<any, any>

children

children: any[]

container

container: JQuery<HTMLElement>

countInput

countInput: JQuery<HTMLElement>

inserters

inserters: any[]

prefix

prefix: any

sequenceContainer

sequenceContainer: JQuery<HTMLElement>

sortable

sortable: any

type

type: any

Methods

_createChild

_createChild(
    blockDef: any,
    placeholder: any,
    prefix: any,
    index: any,
    id: any,
    initialState: any,
    sequence: any,
    opts: any,
): StreamChild
Parameters
- blockDef: any
- placeholder: any
- prefix: any
- index: any
- id: any
- initialState: any
- sequence: any
- opts: any
Returns StreamChild
Overrides BaseSequenceBlock._createChild
- Defined in components/StreamField/blocks/StreamBlock.js:331

_createInsertionControl

_createInsertionControl(placeholder: any, opts: any): StreamBlockMenu
Parameters
- placeholder: any
- opts: any
Returns StreamBlockMenu
Overrides BaseSequenceBlock._createInsertionControl
- Defined in components/StreamField/blocks/StreamBlock.js:353

_getChildDataForInsertion

_getChildDataForInsertion(__namedParameters: { type: any }): any[]
Called when an 'insert new block' action is triggered: given a dict of data from the insertion control. For a StreamBlock, the dict of data consists of 'type' (the chosen block type name, as a string).
Parameters
- __namedParameters: { type: any }
Returns any[]
- The block definition, initial state, and id for the new block
Overrides BaseSequenceBlock._getChildDataForInsertion
- Defined in components/StreamField/blocks/StreamBlock.js:370

_insert

_insert(
    childBlockDef: any,
    initialState: any,
    id: any,
    index: any,
    opts: any,
): void
Parameters
- childBlockDef: any
- initialState: any
- id: any
- index: any
- opts: any
Returns void
Inherited from BaseSequenceBlock._insert
- Defined in components/StreamField/blocks/BaseSequenceBlock.js:483

_onRequestInsert

_onRequestInsert(index: any, opts: any): void
Parameters
- index: any
- opts: any
Returns void
Inherited from BaseSequenceBlock._onRequestInsert
- Defined in components/StreamField/blocks/BaseSequenceBlock.js:468

_updateBlockCount

_updateBlockCount(type: any): void
Parameters
- type: any
Returns void
- Defined in components/StreamField/blocks/StreamBlock.js:258

blockCountChanged

blockCountChanged(): void
Called whenever a block is added or removed Updates the state of add / duplicate block buttons to prevent too many blocks being inserted.

Returns void
Overrides BaseSequenceBlock.blockCountChanged
- Defined in components/StreamField/blocks/StreamBlock.js:269

clear

clear(): void
Returns void
Inherited from BaseSequenceBlock.clear
- Defined in components/StreamField/blocks/BaseSequenceBlock.js:446

deleteBlock

deleteBlock(index: any, opts: any): void
Parameters
- index: any
- opts: any
Returns void
Inherited from BaseSequenceBlock.deleteBlock
- Defined in components/StreamField/blocks/BaseSequenceBlock.js:562

duplicateBlock

duplicateBlock(index: any, opts: any): void
Parameters
- index: any
- opts: any
Returns void
- Defined in components/StreamField/blocks/StreamBlock.js:376

focus

focus(opts: any): void
Parameters
- opts: any
Returns void
Inherited from BaseSequenceBlock.focus
- Defined in components/StreamField/blocks/BaseSequenceBlock.js:713

getBlockCount

getBlockCount(type: any): any
Parameters
- type: any
Returns any
- Defined in components/StreamField/blocks/StreamBlock.js:239

getBlockGroups

getBlockGroups(): any
Returns any
Overrides BaseSequenceBlock.getBlockGroups
- Defined in components/StreamField/blocks/StreamBlock.js:235

getBlockMax

getBlockMax(type: any): any
Parameters
- type: any
Returns any
- Defined in components/StreamField/blocks/StreamBlock.js:250

getDuplicatedState

getDuplicatedState(): any[]
Returns any[]
Inherited from BaseSequenceBlock.getDuplicatedState
- Defined in components/StreamField/blocks/BaseSequenceBlock.js:680

getState

getState(): any[]
Returns any[]
Inherited from BaseSequenceBlock.getState
- Defined in components/StreamField/blocks/BaseSequenceBlock.js:676

getTextLabel

getTextLabel(opts: any): string
Parameters
- opts: any
Returns string
Inherited from BaseSequenceBlock.getTextLabel
- Defined in components/StreamField/blocks/BaseSequenceBlock.js:688

getValue

getValue(): any[]
Returns any[]
Inherited from BaseSequenceBlock.getValue
- Defined in components/StreamField/blocks/BaseSequenceBlock.js:684

initDragNDrop

initDragNDrop(): void
Returns void
Inherited from BaseSequenceBlock.initDragNDrop
- Defined in components/StreamField/blocks/BaseSequenceBlock.js:590

insert

insert(
    __namedParameters: { id: any; type: any; value: any },
    index: any,
    opts: any,
): void
Parameters
- __namedParameters: { id: any; type: any; value: any }
- index: any
- opts: any
Returns void
- Defined in components/StreamField/blocks/StreamBlock.js:359

moveBlock

moveBlock(oldIndex: any, newIndex: any): void
Parameters
- oldIndex: any
- newIndex: any
Returns void
Inherited from BaseSequenceBlock.moveBlock
- Defined in components/StreamField/blocks/BaseSequenceBlock.js:609

moveBlockDown

moveBlockDown(index: any): void
Parameters
- index: any
Returns void
Inherited from BaseSequenceBlock.moveBlockDown
- Defined in components/StreamField/blocks/BaseSequenceBlock.js:665

moveBlockUp

moveBlockUp(index: any): void
Parameters
- index: any
Returns void
Inherited from BaseSequenceBlock.moveBlockUp
- Defined in components/StreamField/blocks/BaseSequenceBlock.js:661

setError

setError(error: any): void
Parameters
- error: any
Returns void
- Defined in components/StreamField/blocks/StreamBlock.js:423

setState

setState(values: any): void
Parameters
- values: any
Returns void
Overrides BaseSequenceBlock.setState
- Defined in components/StreamField/blocks/StreamBlock.js:419

splitBlock

splitBlock(
    index: any,
    valueBefore: any,
    valueAfter: any,
    shouldMoveCommentFn: any,
    opts: any,
): void
Parameters
- index: any
- valueBefore: any
- valueAfter: any
- shouldMoveCommentFn: any
- opts: any
Returns void
- Defined in components/StreamField/blocks/StreamBlock.js:387