Class StiComponentsCollection

Hierarchy

CollectionBase<StiComponent>
- StiComponentsCollection

Implements

Index

Constructors

constructor

Properties

list

Accessors

count
length

Constructors

constructor

new StiComponentsCollection(parent?: StiContainer): StiComponentsCollection

Parameters
- Default value parent: StiContainer = null
Returns StiComponentsCollection

Properties

list

list: StiComponent[] = []

Accessors

count

get count(): number

Inherited from CollectionBase.count

Gets the number of elements contained in the CollectionBase instance.

Returns number

length

get length(): number

Inherited from CollectionBase.length

Returns number

Methods

add

add(component: StiComponent): void

Overrides CollectionBase.add

Parameters
- component: StiComponent
Returns void

addRange

addRange(data: StiComponent[] | CollectionBase<StiComponent>): void

Inherited from CollectionBase.addRange

Parameters
- data: StiComponent[] | CollectionBase<StiComponent>
Returns void

clear

clear(): void

Implementation of ICollection.clear

Inherited from CollectionBase.clear

Removes all objects from the CollectionBase instance.

Returns void

clone

clone(): StiComponentsCollection

Implementation of ICloneable.clone

Returns StiComponentsCollection

contains

contains(item: StiComponent | any): boolean

Inherited from CollectionBase.contains

Parameters
- item: StiComponent | any
Returns boolean

findByName

findByName(name: string): StiComponent

Parameters
- name: string
Returns StiComponent

getByIndex

getByIndex(index: number): StiComponent

Implementation of ICollection.getByIndex

Inherited from CollectionBase.getByIndex

Parameters
- index: number
Returns StiComponent

getByName

getByName(name: string): StiComponent

Parameters
- name: string
Returns StiComponent

getComponentByGuid

getComponentByGuid(guid: string, container: StiContainer): StiComponent

Parameters
- guid: string
- container: StiContainer
Returns StiComponent

getComponentByName

getComponentByName(componentName: string, container: StiContainer): StiComponent

Parameters
- componentName: string
- container: StiContainer
Returns StiComponent

getPageByAlias

getPageByAlias(alias: string): StiPage

Parameters
- alias: string
Returns StiPage

implements

implements(): any[]

Returns any[]

indexOf

indexOf(param: string | StiComponent | any): number

Overrides CollectionBase.indexOf

Parameters
- param: string | StiComponent | any
Returns number

insert

insert(index: number, component: StiComponent): void

Overrides CollectionBase.insert

Parameters
- index: number
- component: StiComponent
Returns void

insertRange

insertRange(index: number, components: StiComponentsCollection): void

Parameters
- index: number
- components: StiComponentsCollection
Returns void

loadFromJsonObject

loadFromJsonObject(jObject: StiJson): void

Implementation of IStiJsonReportObject.loadFromJsonObject

Parameters
- jObject: StiJson
Returns void

loadFromXml

loadFromXml(xmlNode: XmlNode): void

Parameters
- xmlNode: XmlNode
Returns void

memberwiseClone

memberwiseClone(): StiComponentsCollection

Returns StiComponentsCollection

remove

remove(component: StiComponent, clearParent?: boolean): void

Overrides CollectionBase.remove

Parameters
- component: StiComponent
- Default value clearParent: boolean = true
Returns void

removeAt

removeAt(index: number): void

Implementation of ICollection.removeAt

Inherited from CollectionBase.removeAt

Parameters
- index: number
Returns void

saveToJsonObject

saveToJsonObject(mode: StiJsonSaveMode): StiJson

Implementation of IStiJsonReportObject.saveToJsonObject

Parameters
- mode: StiJsonSaveMode
Returns StiJson

setByIndex

setByIndex(index: number, value: StiComponent): void

Inherited from CollectionBase.setByIndex

Parameters
- index: number
- value: StiComponent
Returns void

setByName

setByName(name: string, component: StiComponent): void

Parameters
- name: string
- component: StiComponent
Returns void

setParent

setParent(parent: StiContainer): void

Parameters
- parent: StiContainer
Returns void

sortBandsByLeftPosition

sortBandsByLeftPosition(): void

Returns void

sortBandsByTopPosition

sortBandsByTopPosition(): void

Returns void

sortByBottomPosition

sortByBottomPosition(): void

Returns void

sortByLeftPosition

sortByLeftPosition(): void

Returns void

sortByPriority

sortByPriority(): void

Returns void

sortByRightPosition

sortByRightPosition(): void

Returns void

sortByTopPosition

sortByTopPosition(): void

Returns void

toCast

toCast<C>(): C[]

Implementation of ICollection.toCast

Inherited from CollectionBase.toCast

Type parameters
- C
Returns C[]

toList

toList(): List<StiComponent>

Inherited from CollectionBase.toList

Returns List<StiComponent>

Generated using TypeDoc