Class CrosslinksFieldHandler

Hierarchy

ItemSelectionFieldHandler
- CrosslinksFieldHandler

Index

Constructors

Properties

config data fieldType name

Methods

addSignatures appendItem clear getData getFieldName getFieldType getItemCount getItems hasItem hasItems initData insertItem removeItem setData setFieldName setItems UpdateFieldConfig

Constructors

constructor

new CrosslinksFieldHandler(configIn): CrosslinksFieldHandler
Parameters
- configIn: XRFieldTypeAnnotatedParamJson
Returns CrosslinksFieldHandler
Overrides ItemSelectionFieldHandler.constructor
- Defined in build/js/core/common/businesslogic/FieldHandlers/CrosslinksFieldHandler.d.ts:7

Properties

`Protected` config

config: XRFieldTypeAnnotatedParamJson

`Protected` data

data: string

`Protected` fieldType

fieldType: string

`Protected` name

name: string

Methods

addSignatures

addSignatures(signatures, includeAll): void
Parameters
- signatures: string[]
- includeAll: boolean
Returns void
Inherited from ItemSelectionFieldHandler.addSignatures
- Defined in build/js/core/common/businesslogic/FieldHandlers/ItemSelectionFieldHandler.d.ts:10

appendItem

appendItem(item): CrosslinksFieldHandler
Append the given item to the end of the list of items.
Parameters
- item: IReference
Returns CrosslinksFieldHandler
the field handler.

Throws
Error in case a projectShort label doesn't exist in the item.
Overrides ItemSelectionFieldHandler.appendItem
- Defined in build/js/core/common/businesslogic/FieldHandlers/CrosslinksFieldHandler.d.ts:22

clear

clear(): ItemSelectionFieldHandler
Returns ItemSelectionFieldHandler
Inherited from ItemSelectionFieldHandler.clear
- Defined in build/js/core/common/businesslogic/FieldHandlers/ItemSelectionFieldHandler.d.ts:22

getData

getData(): string
Returns string
Inherited from ItemSelectionFieldHandler.getData
- Defined in build/js/core/common/businesslogic/FieldHandlers/ItemSelectionFieldHandler.d.ts:13

getFieldName

getFieldName(): string
Returns string
Inherited from ItemSelectionFieldHandler.getFieldName
- Defined in build/js/core/common/businesslogic/FieldHandlers/ItemSelectionFieldHandler.d.ts:25

getFieldType

getFieldType(): string
Returns string
Inherited from ItemSelectionFieldHandler.getFieldType
- Defined in build/js/core/common/businesslogic/FieldHandlers/ItemSelectionFieldHandler.d.ts:11

getItemCount

getItemCount(): number
Returns number
Inherited from ItemSelectionFieldHandler.getItemCount
- Defined in build/js/core/common/businesslogic/FieldHandlers/ItemSelectionFieldHandler.d.ts:16

getItems

getItems(): IReference[]
Returns IReference[]
Inherited from ItemSelectionFieldHandler.getItems
- Defined in build/js/core/common/businesslogic/FieldHandlers/ItemSelectionFieldHandler.d.ts:15

hasItem

hasItem(itemId, projectShortLabel?): boolean
Parameters
- itemId: string
- Optional projectShortLabel: string
Returns boolean
Inherited from ItemSelectionFieldHandler.hasItem
- Defined in build/js/core/common/businesslogic/FieldHandlers/ItemSelectionFieldHandler.d.ts:18

hasItems

hasItems(): boolean
Returns boolean
Inherited from ItemSelectionFieldHandler.hasItems
- Defined in build/js/core/common/businesslogic/FieldHandlers/ItemSelectionFieldHandler.d.ts:17

initData

initData(serializedFieldData): void
Parameters
- serializedFieldData: string
Returns void
Inherited from ItemSelectionFieldHandler.initData
- Defined in build/js/core/common/businesslogic/FieldHandlers/ItemSelectionFieldHandler.d.ts:12

insertItem

insertItem(position, item): CrosslinksFieldHandler
Add an item to the list at the given position
Parameters
- position: number
- item: IReference
Returns CrosslinksFieldHandler
the field handler

Throws
Error in case a projectShortLabel doesn't exist in the item.
Overrides ItemSelectionFieldHandler.insertItem
- Defined in build/js/core/common/businesslogic/FieldHandlers/CrosslinksFieldHandler.d.ts:15

removeItem

removeItem(position): ItemSelectionFieldHandler
Parameters
- position: number
Returns ItemSelectionFieldHandler
Inherited from ItemSelectionFieldHandler.removeItem
- Defined in build/js/core/common/businesslogic/FieldHandlers/ItemSelectionFieldHandler.d.ts:21

setData

setData(value, doValidation?): void
Parameters
- value: string
- Optional doValidation: boolean
Returns void
Inherited from ItemSelectionFieldHandler.setData
- Defined in build/js/core/common/businesslogic/FieldHandlers/ItemSelectionFieldHandler.d.ts:14

setFieldName

setFieldName(value): void
Parameters
- value: string
Returns void
Inherited from ItemSelectionFieldHandler.setFieldName
- Defined in build/js/core/common/businesslogic/FieldHandlers/ItemSelectionFieldHandler.d.ts:26

setItems

setItems(selectedItems): void
Parameters
- selectedItems: IReference[]
Returns void
Inherited from ItemSelectionFieldHandler.setItems
- Defined in build/js/core/common/businesslogic/FieldHandlers/ItemSelectionFieldHandler.d.ts:23

`Static` UpdateFieldConfig

UpdateFieldConfig(params): void
Parameters
- params: XRFieldTypeAnnotatedParamJson
Returns void
- Defined in build/js/core/common/businesslogic/FieldHandlers/CrosslinksFieldHandler.d.ts:6

Generated using TypeDoc