Class AttributeWidget

Hierarchy

MemberWidget

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new AttributeWidget(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit, container: AbstractElement): AttributeWidget

Overwrites MemberWidget.constructor

Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- unit: ModelUnit
- container: AbstractElement
Returns AttributeWidget

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

appearance

get (): Appearance
set (newValue: Appearance): any

Inherited from Widget.appearance

In version 8.0.0: introduced

Returns Appearance
Inherited from Widget.appearance

In version 8.0.0: introduced

Parameters
- newValue: Appearance
Returns any

ariaRequired

get (): boolean
set (newValue: boolean): any

In version 9.2.0: introduced

Returns boolean
In version 9.2.0: introduced

Parameters
- newValue: boolean
Returns any

attributePath

get (): string
set (newValue: string): any

Inherited from MemberWidget.attributePath

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

In version 7.11.0: deleted

Returns string
Inherited from MemberWidget.attributePath

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

In version 7.11.0: deleted

Parameters
- newValue: string
Returns any

attributeRef

get (): AttributeRef | null
set (newValue: AttributeRef | null): any

Inherited from MemberWidget.attributeRef

In version 7.11.0: introduced

Returns AttributeRef | null
Inherited from MemberWidget.attributeRef

In version 7.11.0: introduced

Parameters
- newValue: AttributeRef | null
Returns any

class

get (): string
set (newValue: string): any

Inherited from Widget.class

In version 8.0.0: deleted

Returns string
Inherited from Widget.class

In version 8.0.0: deleted

Parameters
- newValue: string
Returns any

conditionalEditabilitySettings

get (): ConditionalEditabilitySettings | null
set (newValue: ConditionalEditabilitySettings | null): any

Inherited from ConditionallyEditableWidget.conditionalEditabilitySettings

Returns ConditionalEditabilitySettings | null
Inherited from ConditionallyEditableWidget.conditionalEditabilitySettings

Parameters
- newValue: ConditionalEditabilitySettings | null
Returns any

conditionalVisibilitySettings

get (): ConditionalVisibilitySettings | null
set (newValue: ConditionalVisibilitySettings | null): any

Inherited from ConditionallyVisibleWidget.conditionalVisibilitySettings

Returns ConditionalVisibilitySettings | null
Inherited from ConditionallyVisibleWidget.conditionalVisibilitySettings

Parameters
- newValue: ConditionalVisibilitySettings | null
Returns any

container

get (): AbstractElement

Inherited from AbstractUnit.container

Returns AbstractElement

containerAsBuildingBlock

get (): BuildingBlock

Overwrites MemberWidget.containerAsBuildingBlock

Returns BuildingBlock

containerAsDataView

get (): DataView

Overwrites MemberWidget.containerAsDataView

Returns DataView

containerAsDivContainer

get (): DivContainer

Overwrites MemberWidget.containerAsDivContainer

Returns DivContainer

containerAsGroupBox

get (): GroupBox

Overwrites MemberWidget.containerAsGroupBox

Returns GroupBox

containerAsHeader

get (): Header

Overwrites MemberWidget.containerAsHeader

Returns Header

containerAsLayout

get (): Layout

Overwrites MemberWidget.containerAsLayout

Returns Layout

containerAsLayoutCallArgument

get (): LayoutCallArgument

Overwrites MemberWidget.containerAsLayoutCallArgument

Returns LayoutCallArgument

containerAsLayoutGridColumn

get (): LayoutGridColumn

Overwrites MemberWidget.containerAsLayoutGridColumn

Returns LayoutGridColumn

containerAsListView

get (): ListView

Overwrites MemberWidget.containerAsListView

Returns ListView

containerAsListViewTemplate

get (): ListViewTemplate

Overwrites MemberWidget.containerAsListViewTemplate

Returns ListViewTemplate

containerAsMasterDetailRegion

get (): MasterDetailRegion

Overwrites MemberWidget.containerAsMasterDetailRegion

Returns MasterDetailRegion

containerAsNativeLayout

get (): NativeLayout

Overwrites MemberWidget.containerAsNativeLayout

Returns NativeLayout

containerAsNativeLayoutCallArgument

get (): NativeLayoutCallArgument

Overwrites MemberWidget.containerAsNativeLayoutCallArgument

Returns NativeLayoutCallArgument

containerAsNativeLayoutContent

get (): NativeLayoutContent

Overwrites MemberWidget.containerAsNativeLayoutContent

Returns NativeLayoutContent

containerAsNavigationListItem

get (): NavigationListItem

Overwrites MemberWidget.containerAsNavigationListItem

Returns NavigationListItem

containerAsReportPane

get (): ReportPane

Overwrites MemberWidget.containerAsReportPane

Returns ReportPane

containerAsScrollContainerRegion

get (): ScrollContainerRegion

Overwrites MemberWidget.containerAsScrollContainerRegion

Returns ScrollContainerRegion

containerAsSnippet

get (): Snippet

Overwrites MemberWidget.containerAsSnippet

Returns Snippet

containerAsSplitPane

get (): SplitPane

Overwrites MemberWidget.containerAsSplitPane

Returns SplitPane

containerAsTabPage

get (): TabPage

Overwrites MemberWidget.containerAsTabPage

Returns TabPage

containerAsTableCell

get (): TableCell

Overwrites MemberWidget.containerAsTableCell

Returns TableCell

containerAsTemplateGridContents

get (): TemplateGridContents

Overwrites MemberWidget.containerAsTemplateGridContents

Returns TemplateGridContents

containerAsVerticalFlow

get (): VerticalFlow

Overwrites MemberWidget.containerAsVerticalFlow

Returns VerticalFlow

containerAsWebLayoutContent

get (): WebLayoutContent

Overwrites MemberWidget.containerAsWebLayoutContent

Returns WebLayoutContent

containerAsWidgetValue

get (): WidgetValue

Overwrites MemberWidget.containerAsWidgetValue

Returns WidgetValue

editable

get (): EditableEnum
set (newValue: EditableEnum): any

Inherited from ConditionallyEditableWidget.editable

Returns EditableEnum
Inherited from ConditionallyEditableWidget.editable

Parameters
- newValue: EditableEnum
Returns any

isLoaded

get (): boolean

Inherited from Element.isLoaded

Overwrites AbstractElement.isLoaded
Checks whether all attributes are available ATM
- if false, a load is required to access these properties.
Returns boolean

label

get (): Text | null
set (newValue: Text | null): any

Inherited from InputWidget.label

In version 7.18.0: deleted

Returns Text | null
Inherited from InputWidget.label

In version 7.18.0: deleted

Parameters
- newValue: Text | null
Returns any

labelTemplate

get (): ClientTemplate | null
set (newValue: ClientTemplate | null): any

Inherited from InputWidget.labelTemplate

In version 7.18.0: introduced

Returns ClientTemplate | null
Inherited from InputWidget.labelTemplate

In version 7.18.0: introduced

Parameters
- newValue: ClientTemplate | null
Returns any

model

get (): IModel

Inherited from AbstractUnit.model

Returns IModel

name

get (): string
set (newValue: string): any

Inherited from Widget.name

Returns string
Inherited from Widget.name

Parameters
- newValue: string
Returns any

onChangeAction

get (): ClientAction
set (newValue: ClientAction): any

In version 7.13.0: introduced

Returns ClientAction
In version 7.13.0: introduced

Parameters
- newValue: ClientAction
Returns any

onChangeMicroflowSettings

get (): MicroflowSettings
set (newValue: MicroflowSettings): any

In version 7.13.0: deleted

Returns MicroflowSettings
In version 7.13.0: deleted

Parameters
- newValue: MicroflowSettings
Returns any

onEnterAction

get (): ClientAction
set (newValue: ClientAction): any

In version 7.13.0: introduced

Returns ClientAction
In version 7.13.0: introduced

Parameters
- newValue: ClientAction
Returns any

onEnterMicroflowSettings

get (): MicroflowSettings
set (newValue: MicroflowSettings): any

In version 7.13.0: deleted

Returns MicroflowSettings
In version 7.13.0: deleted

Parameters
- newValue: MicroflowSettings
Returns any

onLeaveAction

get (): ClientAction
set (newValue: ClientAction): any

In version 7.13.0: introduced

Returns ClientAction
In version 7.13.0: introduced

Parameters
- newValue: ClientAction
Returns any

onLeaveMicroflowSettings

get (): MicroflowSettings
set (newValue: MicroflowSettings): any

In version 7.13.0: deleted

Returns MicroflowSettings
In version 7.13.0: deleted

Parameters
- newValue: MicroflowSettings
Returns any

readOnlyStyle

get (): ReadOnlyStyle
set (newValue: ReadOnlyStyle): any

Inherited from MemberWidget.readOnlyStyle

In version 6.9.0: introduced

Returns ReadOnlyStyle
Inherited from MemberWidget.readOnlyStyle

In version 6.9.0: introduced

Parameters
- newValue: ReadOnlyStyle
Returns any

required

get (): boolean
set (newValue: boolean): any

In version 7.6.0: deleted

Returns boolean
In version 7.6.0: deleted

Parameters
- newValue: boolean
Returns any

requiredMessage

get (): Text
set (newValue: Text): any

In version 7.6.0: deleted

Returns Text
In version 7.6.0: deleted

Parameters
- newValue: Text
Returns any

screenReaderLabel

get (): ClientTemplate | null
set (newValue: ClientTemplate | null): any

Inherited from InputWidget.screenReaderLabel

In version 8.12.0: introduced

Returns ClientTemplate | null
Inherited from InputWidget.screenReaderLabel

In version 8.12.0: introduced

Parameters
- newValue: ClientTemplate | null
Returns any

sourceVariable

get (): PageVariable | null
set (newValue: PageVariable | null): any

In version 8.8.0: introduced

Returns PageVariable | null
In version 8.8.0: introduced

Parameters
- newValue: PageVariable | null
Returns any

style

get (): string
set (newValue: string): any

Inherited from Widget.style

In version 8.0.0: deleted

Returns string
Inherited from Widget.style

In version 8.0.0: deleted

Parameters
- newValue: string
Returns any

tabIndex

get (): number
set (newValue: number): any

Inherited from Widget.tabIndex

Returns number
Inherited from Widget.tabIndex

Parameters
- newValue: number
Returns any

unit

get (): ModelUnit<IAbstractModel>

Inherited from Element.unit

Overwrites AbstractUnit.unit

Returns ModelUnit<IAbstractModel>

validation

get (): WidgetValidation
set (newValue: WidgetValidation): any

In version 7.6.0: introduced

Returns WidgetValidation
In version 7.6.0: introduced

Parameters
- newValue: WidgetValidation
Returns any

Methods

allProperties

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

Implementation of IElement.allProperties

Inherited from AbstractUnit.allProperties

Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): this

Implementation of IElement.asLoaded

Inherited from ModelUnit.asLoaded
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.
Returns this

deepCopy

deepCopy(targetModel: IAbstractModel): this

Inherited from Element.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns this

deepCopyWithIdMap

deepCopyWithIdMap(targetModel: IAbstractModel): object

Inherited from Element.deepCopyWithIdMap

Creates a deep copy of this element and its children. Also returns a map from original to new IDs.

Parameters
- targetModel: IAbstractModel
Returns object
- copy: Element
- idMap: IMap<Structure>

delete

delete(): void

Inherited from AbstractElement.delete

Overwrites AbstractUnit.delete

Deletes this element from the model.

Returns void

detach

detach(): this

Inherited from Element.detach

Detaches this element from the model, so that it can be attached in a different place.

Returns this

findElementById

findElementById(id: string): AbstractElement | null

Implementation of IElement.findElementById

Inherited from AbstractElement.findElementById

Given an element id, returns the element in this abstract element with that id, otherwise null.

Parameters
- id: string
Returns AbstractElement | null

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from AbstractUnit.getContainerAs

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

load

load(callback: function, forceRefresh?: undefined | false | true): void
load(forceRefresh?: undefined | false | true): Promise<this>

Inherited from ModelUnit.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.
Parameters
- callback: function
  - - (elem: this): void
    - Parameters
      - elem: this
      Returns void
- Optional forceRefresh: undefined | false | true
Returns void
Implementation of IElement.load

Inherited from ModelUnit.load

Parameters
- Optional forceRefresh: undefined | false | true
Returns Promise<this>

loadedProperties

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

Implementation of IElement.loadedProperties

Inherited from AbstractUnit.loadedProperties

Returns AbstractProperty<any, any>[]

publicProperties

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

Implementation of IElement.publicProperties

Inherited from AbstractUnit.publicProperties

Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IStructureJSON

Implementation of IElement.toJSON

Inherited from AbstractUnit.toJSON

Returns IStructureJSON

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