Class FolderBase

Hierarchy

StructuralUnit<IModel>

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new FolderBase(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, container: IFolderBase | IProject): FolderBase

Overwrites StructuralUnit.constructor

Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- container: IFolderBase | IProject
Returns FolderBase

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

container

get (): StructuralUnit

Inherited from AbstractUnit.container

Returns StructuralUnit

containerAsFolderBase

get (): FolderBase

Returns FolderBase

containerAsProject

get (): Project

Returns Project

documents

get (): IList<IDocument>

Returns IList<IDocument>

folders

get (): IList<IFolder>

Returns IList<IFolder>

isLoadable

get (): boolean

Inherited from AbstractUnit.isLoadable

Returns boolean

isLoaded

get (): boolean

Inherited from AbstractUnit.isLoaded

Overwrites Structure.isLoaded

Checks whether all attributes are available at this instant; if false, a load is required to access these properties.

Returns boolean

isReadOnly

get (): boolean

Inherited from AbstractUnit.isReadOnly

Returns boolean

model

get (): IModel

Inherited from AbstractUnit.model

Returns IModel

unit

get (): this

Inherited from StructuralUnit.unit

Overwrites AbstractUnit.unit

Returns this

Methods

allProperties

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

Implementation of IFolderBase.allProperties

Inherited from AbstractUnit.allProperties

Returns AbstractProperty<any, any>[]

deepCopyInto

deepCopyInto(newParent: IStructuralUnit): AbstractUnit

Inherited from StructuralUnit.deepCopyInto

Overwrites AbstractUnit.deepCopyInto

Parameters
- newParent: IStructuralUnit
Returns AbstractUnit

delete

delete(): void

Implementation of IFolderBase.delete

Inherited from StructuralUnit.delete

Overwrites AbstractUnit.delete

Returns void

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from AbstractUnit.getContainerAs

Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

loadedProperties

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

Implementation of IFolderBase.loadedProperties

Inherited from AbstractUnit.loadedProperties

Returns AbstractProperty<any, any>[]

publicProperties

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

Implementation of IFolderBase.publicProperties

Inherited from AbstractUnit.publicProperties

Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IAbstractElementJson

Implementation of IFolderBase.toJSON

Inherited from StructuralUnit.toJSON

Overwrites AbstractUnit.toJSON

Returns IAbstractElementJson

traverse

traverse(visit: function): void

Inherited from AbstractUnit.traverse

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

traverseFind

traverseFind<T>(visit: function): T | null

Inherited from AbstractUnit.traverseFind

Type parameters
- T
Parameters
- visit: function
  - - (structure: IStructure): T
    - Parameters
      - structure: IStructure
      Returns T
Returns T | null

traversePublicParts

traversePublicParts(visit: function): void

Inherited from AbstractUnit.traversePublicParts

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

Generated using TypeDoc