Class ComparisonSearchField

See: relevant section in reference guide

Hierarchy

SingleSearchField
- ComparisonSearchField

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ComparisonSearchField(model: AbstractModel, typeName: string, id: string, isPartial: boolean, unit: ModelUnit, container: AbstractElement): ComparisonSearchField

Overwrites SingleSearchField.constructor

Parameters
- model: AbstractModel
- typeName: string
- id: string
- isPartial: boolean
- unit: ModelUnit
- container: AbstractElement
Returns ComparisonSearchField

Properties

attributePath

attributePath: string

The value of this property is conceptually of type paths.AttributePath.

caption

caption: Text

container

container: AbstractElement

containerAsControlBar

containerAsControlBar: ControlBar

containerAsGridControlBar

containerAsGridControlBar: GridControlBar

defaultValue

defaultValue: string

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

if false, a load is required to access these properties.

model

model: IModel

name

name: string

operator

operator: SearchFieldOperator

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

type

type: SearchFieldType

typeName

typeName: string

unit

unit: ModelUnit

versionInfo

versionInfo: StructureVersionInfo

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

Protected _scheduleDeltaAfterCreate

_scheduleDeltaAfterCreate(delta: IDelta): void

Inherited from Structure._scheduleDeltaAfterCreate

Parameters
- delta: IDelta
Returns void

Protected _sendDeleteDelta

_sendDeleteDelta(): void

Inherited from Structure._sendDeleteDelta

Sends the delete in case that we were removed from the model.

Returns void

Protected _updateElementsContainer

_updateElementsContainer(unit: ModelUnit): void

Inherited from AbstractElement._updateElementsContainer

updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

Parameters
- unit: ModelUnit
Returns void

Protected _updateWithJsonImpl

_updateWithJsonImpl(json: IStructureJson): void

Inherited from Structure._updateWithJsonImpl

Update an existing (probably partial) interface with real contents received from the server.

Parameters
- json: IStructureJson
Returns void

allProperties

allProperties(): AbstractProperty<any, any>[]

Implementation of IComparisonSearchField.allProperties

Inherited from Structure.allProperties

Returns AbstractProperty<any, any>[]

deepCopyInto

deepCopyInto(newParent: AbstractElement, targetPropertyName: string): AbstractElement

Inherited from Element.deepCopyInto

Overwrites Structure.deepCopyInto

Sends the appropriate create delta to the server after this element has been moved to a new parent.

Parameters
- newParent: AbstractElement
- targetPropertyName: string
Returns AbstractElement

delete

delete(): void

Inherited from AbstractElement.delete

Overwrites Structure.delete

Removes the given back reference.

Returns void

Protected getContainerAs

getContainerAs(containerType: any): IStructuralUnit | IAbstractElement

Inherited from Structure.getContainerAs

Parameters
- containerType: any
Returns IStructuralUnit | IAbstractElement

load

load<T>(callback: function, forceRefresh?: boolean): any
load<T>(): T

Inherited from AbstractElement.load
Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)
- If invoked without callback, it checks whether the properties are available or it will throw;
- If invoked with callback, it will load the data from the server if needed, and then invoke the callback.
Type parameters
- T: AbstractElement
Parameters
- callback: function
  - - (elem: T): void
    - Parameters
      - elem: T
      Returns void
- Optional forceRefresh: boolean
Returns any
Implementation of IComparisonSearchField.load

Inherited from AbstractElement.load

Type parameters
- T: AbstractElement
Returns T

toJSON

toJSON(): Object

Implementation of IComparisonSearchField.toJSON

Inherited from Structure.toJSON

Returns Object

traverse

traverse(visit: function): void

Inherited from Structure.traverse

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

traversePublicParts

traversePublicParts(visit: function): void

Inherited from Structure.traversePublicParts

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static create

create(model: IModel): ComparisonSearchField

Creates and returns a new ComparisonSearchField instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

Parameters
- model: IModel
Returns ComparisonSearchField

Static createIn

createIn(container: ControlBar): ComparisonSearchField

Creates and returns a new ComparisonSearchField instance in the SDK and on the server. The new ComparisonSearchField will be automatically stored in the 'items' property of the parent ControlBar element passed as argument.

Parameters
- container: ControlBar
Returns ComparisonSearchField

Generated using TypeDoc