Class WizardItem

Defines the interface for OutSystemsUI Patterns

Hierarchy (View Summary)

OSFramework.OSUI.Patterns.AbstractChild<WizardItemConfig, IWizard>
- WizardItem

Implements

IWizardItem

Constructors

constructor

new WizardItem(
uniqueId: string,
configs: JSON,
): OSFramework.OSUI.Patterns.WizardItem.WizardItem
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.OSUI.Patterns.WizardItem.WizardItem
Overrides AbstractChild.constructor
- Defined in OSFramework/OSUI/Pattern/WizardItem/WizardItem.ts:15

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

Accessors

isFirstChild

get isFirstChild(): boolean
Getter that allows to check if it's the first child.

Returns boolean

Memberof
OSFramework.Patterns.AbstractChild
Implementation of IWizardItem.isFirstChild

Inherited from AbstractChild.isFirstChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:80

isLastChild

get isLastChild(): boolean
Getter that allows to check if it's the last child.

Returns boolean

Memberof
OSFramework.Patterns.AbstractChild
Implementation of IWizardItem.isLastChild

Inherited from AbstractChild.isLastChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:100
set isLastChild(value: boolean): void
Setter that allows to define it's the last child.
Parameters
- value: boolean
Returns void

Memberof
OSFramework.Patterns.AbstractChild
Implementation of IWizardItem.isLastChild

Inherited from AbstractChild.isLastChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:109

parentId

get parentId(): string
Getter that allows to obtain the parentId.

Returns string

Memberof
OSFramework.Patterns.AbstractChild
Inherited from AbstractChild.parentId
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:120

parentObject

get parentObject(): PT
Getter that allows to obtain the parent reference.

Returns PT

Memberof
OSFramework.Patterns.AbstractChild
Inherited from AbstractChild.parentObject
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:131

`Protected`_enableAccessibility

get _enableAccessibility(): boolean
Protected
Getter that allows to obtain the accessibility is enabled.

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractChild._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

get selfElement(): HTMLElement
Getter that allows to obtain the self element.

Returns HTMLElement

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IWizardItem.selfElement

Inherited from AbstractChild.selfElement
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:218

isBuilt

get isBuilt(): boolean
Getter that tells if the pattern is already built.

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IWizardItem.isBuilt

Inherited from AbstractChild.isBuilt
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:229

configs

get configs(): C
Current configurations/state of the pattern.

Returns C

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractChild.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

get uniqueId(): string
Unique id of the pattern. Internal use only.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IWizardItem.uniqueId

Inherited from AbstractChild.uniqueId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:251

widgetId

get widgetId(): string
Id of the pattern known by the developer. External use only.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IWizardItem.widgetId

Inherited from AbstractChild.widgetId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:262

Methods

`Protected`notifyParent

notifyParent(actionType: string): void
Method used to notify parent about the action that was performed
Parameters
- actionType: string
  Action Type name (Should be based on an Enum)
Returns void

Memberof
OSFramework.Patterns.AbstractChild
Inherited from AbstractChild.notifyParent
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:36

`Protected`setParentInfo

setParentInfo(
    parentSelector: string,
    getPatternByIdAPI: (patternId: string) => IWizard,
    canBeOrphan?: boolean,
): void
Protected
Method that will Get and Set parent element info.
Parameters
- parentSelector: string
  Selector to find for parent Element
- getPatternByIdAPI: (patternId: string) => IWizard
  API reference method from Parent Pattern that will return the PatternById
- OptionalcanBeOrphan: boolean
  option for patterns that can work without a parent
Returns void

Memberof
OSFramework.Patterns.AbstractChild
Inherited from AbstractChild.setParentInfo
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:49

`Protected`finishBuild

finishBuild(): void
Protected
Marks the built as being finished.

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractChild.finishBuild
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:61

`Protected`triggerPlatformEventCallback

triggerPlatformEventCallback(
platFormCallback: OSGeneric,
...args: unknown[],
): void
Protected
Triggers a generic platform event.
Parameters
- platFormCallback: OSGeneric
- ...args: unknown[]
Returns void

Memberof
AbstractProviderPattern
Inherited from AbstractChild.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected`triggerPlatformInitializedEventCallback

triggerPlatformInitializedEventCallback(): void
Protected
Trigger the Initialized callback platform event.

Returns void

Memberof
AbstractPattern
Inherited from AbstractChild.triggerPlatformInitializedEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:93

`Protected`unsetGlobalCallbacks

unsetGlobalCallbacks(): void
Protected
Unsets the global callbacks. This naming is used to prevent overriding the unsetCallback method on all patterns

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractChild.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

equalsToID

equalsToID(patternId: string): boolean
Enables to uniquely identify the pattern in all ways.
Parameters
- patternId: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IWizardItem.equalsToID

Inherited from AbstractChild.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

`Protected`setA11YProperties

setA11YProperties(): void
Protected
This method has no implementation on this pattern context!

Returns void

Memberof
OSFramework.Patterns.WizardItem.WizardItem
Overrides AbstractChild.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/WizardItem/WizardItem.ts:92

`Protected`setCallbacks

setCallbacks(): void
Protected
This method has no implementation on this pattern context!

Returns void

Memberof
OSFramework.Patterns.WizardItem.WizardItem
Overrides AbstractChild.setCallbacks
- Defined in OSFramework/OSUI/Pattern/WizardItem/WizardItem.ts:138

`Protected`setHtmlElements

setHtmlElements(): void
Protected
This method has no implementation on this pattern context!

Returns void

Memberof
OSFramework.Patterns.WizardItem.WizardItem
Overrides AbstractChild.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/WizardItem/WizardItem.ts:148

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
This method has no implementation on this pattern context!

Returns void

Memberof
OSFramework.Patterns.WizardItem.WizardItem
Overrides AbstractChild.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/WizardItem/WizardItem.ts:164

`Protected`unsetHtmlElements

unsetHtmlElements(): void
Protected
This method has no implementation on this pattern context!

Returns void

Memberof
OSFramework.Patterns.WizardItem.WizardItem
Overrides AbstractChild.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/WizardItem/WizardItem.ts:174

beNotifiedByParent

beNotifiedByParent(notificationType: HasNewProps): void
Method to be notified by the parent that a new property value has been set
Parameters
- notificationType: HasNewProps
  Notification type
Returns void

Memberof
OSFramework.Patterns.WizardItem.WizardItem
Implementation of IWizardItem.beNotifiedByParent
- Defined in OSFramework/OSUI/Pattern/WizardItem/WizardItem.ts:184

build

build(): void
Method to build the WizardItem

Returns void

Memberof
OSFramework.Patterns.WizardItem.WizardItem
Implementation of IWizardItem.build

Overrides AbstractChild.build
- Defined in OSFramework/OSUI/Pattern/WizardItem/WizardItem.ts:197

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method to change the value of configs/current state.
Parameters
- propertyName: string
- propertyValue: unknown
Returns void

Memberof
OSFramework.Patterns.WizardItem.WizardItem
Implementation of IWizardItem.changeProperty

Overrides AbstractChild.changeProperty
- Defined in OSFramework/OSUI/Pattern/WizardItem/WizardItem.ts:220

dispose

dispose(): void
Method to destroy WizardItem instance

Returns void

Memberof
OSFramework.Patterns.WizardItem.WizardItem
Implementation of IWizardItem.dispose

Overrides AbstractChild.dispose
- Defined in OSFramework/OSUI/Pattern/WizardItem/WizardItem.ts:235

`Abstract`registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Register a given callback event handler.
Parameters
- eventName: string
- callback: OSGeneric
Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IWizardItem.registerCallback

Overrides AbstractChild.registerCallback
- Defined in OSFramework/OSUI/Pattern/WizardItem/WizardItem.ts:244

Class WizardItem

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSFramework.OSUI.Patterns.WizardItem.WizardItem

Properties

ProtectedisProviderBased

Accessors

isFirstChild

Returns boolean

Memberof

isLastChild

Returns boolean

Memberof

Parameters

Returns void

Memberof

parentId

Returns string

Memberof

parentObject

Returns PT

Memberof

Protected_enableAccessibility

Returns boolean

Memberof

selfElement

Returns HTMLElement

Memberof

isBuilt

Returns boolean

Memberof

configs

Returns C

Memberof

uniqueId

Returns string

Memberof

widgetId

Returns string

Memberof

Methods

ProtectednotifyParent

Parameters

Returns void

Memberof

ProtectedsetParentInfo

Parameters

Returns void

Memberof

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

equalsToID

Parameters

Returns boolean

Memberof

ProtectedsetA11YProperties

Returns void

Memberof

ProtectedsetCallbacks

Returns void

Memberof

`Protected`isProviderBased

`Protected`_enableAccessibility

`Protected`notifyParent

`Protected`setParentInfo

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`unsetCallbacks

`Protected`unsetHtmlElements

`Abstract`registerCallback