Class Submenu

Defines the interface for OutSystemsUI Patterns

Hierarchy (View Summary)

AbstractPattern<SubmenuConfig>
- Submenu

Implements

ISubmenu

Constructors

constructor

new Submenu(
uniqueId: string,
configs: JSON,
): OSFramework.OSUI.Patterns.Submenu.Submenu
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.OSUI.Patterns.Submenu.Submenu
Overrides AbstractPattern.constructor
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:29

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

hasClickOutsideToClose

hasClickOutsideToClose: boolean = true

Accessors

`Protected`_enableAccessibility

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern._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 ISubmenu.selfElement

Inherited from AbstractPattern.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 ISubmenu.isBuilt

Inherited from AbstractPattern.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 AbstractPattern.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 ISubmenu.uniqueId

Inherited from AbstractPattern.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 ISubmenu.widgetId

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

Methods

`Protected`finishBuild

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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern.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 AbstractPattern.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 AbstractPattern.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 AbstractPattern.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Changes the value of the properties in the configurations and if changes are to a common property, applies the changes.
Parameters
- propertyName: string
- propertyValue: unknown
Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of ISubmenu.changeProperty

Inherited from AbstractPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:128

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 ISubmenu.equalsToID

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

`Protected`setA11YProperties

setA11YProperties(): void
Protected
Add the A11Y attributes values

Returns void

Memberof
OSFramework.Patterns.Submenu.Submenu
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:265

`Protected`setCallbacks

setCallbacks(): void
Protected
Add Pattern Events

Returns void

Memberof
OSFramework.Patterns.Submenu.Submenu
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:294

`Protected`setHtmlElements

setHtmlElements(): void
Protected
Update info based on htmlContent

Returns void

Memberof
OSFramework.Patterns.Submenu.Submenu
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:312

`Protected`setInitialStates

setInitialStates(): void
Protected
Set the cssClasses that should be assigned to the element on it's initialization

Returns void

Memberof
OSFramework.Patterns.Submenu.Submenu
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:332

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
Remove all the assigned Events

Returns void

Memberof
OSFramework.Patterns.Submenu.Submenu
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:359

`Protected`unsetHtmlElements

unsetHtmlElements(): void
Protected
Reassign the HTML elements to undefined, preventing memory leaks

Returns void

Memberof
OSFramework.Patterns.Submenu.Submenu
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:376

build

build(): void
Method to build the Submenu

Returns void

Memberof
OSFramework.Patterns.Submenu.Submenu
Implementation of ISubmenu.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:388

clickOutsideToClose

clickOutsideToClose(clickOutsideToClose: boolean): void
Method to toggle the behaviour to close submenu when clicking the body
Parameters
- clickOutsideToClose: boolean
Returns void

Memberof
Submenu
Implementation of ISubmenu.clickOutsideToClose
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:410

close

close(): void
Close Submenu

Returns void

Memberof
OSFramework.Patterns.Submenu.Submenu
Implementation of ISubmenu.close
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:432

dispose

dispose(): void
Destroy the Submenu

Returns void

Memberof
OSFramework.Patterns.Submenu.Submenu
Implementation of ISubmenu.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:467

open

open(): void
Public Open Submenu

Returns void

Memberof
OSFramework.Patterns.Submenu.Submenu
Implementation of ISubmenu.open
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:484

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Method used to register the provider callback
Parameters
- eventName: string
- callback: OSGeneric
Returns void

Memberof
Submenu
Implementation of ISubmenu.registerCallback

Overrides AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:516

setOpenOnHover

setOpenOnHover(): void
Manage Callbacks needed to show submenu on hover

Returns void

Memberof
Submenu
Implementation of ISubmenu.setOpenOnHover
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:533

updateOnRender

updateOnRender(): void
Trigger on submenu onRender, to update active state

Returns void

Memberof
OSFramework.Patterns.Submenu.Submenu
Implementation of ISubmenu.updateOnRender
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:553

Class Submenu

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSFramework.OSUI.Patterns.Submenu.Submenu

Properties

ProtectedisProviderBased

hasClickOutsideToClose

Accessors

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

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

changeProperty

Parameters

Returns void

Memberof

equalsToID

Parameters

Returns boolean

Memberof

ProtectedsetA11YProperties

Returns void

Memberof

ProtectedsetCallbacks

Returns void

Memberof

ProtectedsetHtmlElements

Returns void

Memberof

ProtectedsetInitialStates

Returns void

Memberof

ProtectedunsetCallbacks

Returns void

Memberof

ProtectedunsetHtmlElements

Returns void

Memberof

build

Returns void

Memberof

clickOutsideToClose

Parameters

Returns void

`Protected`isProviderBased

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`setInitialStates

`Protected`unsetCallbacks

`Protected`unsetHtmlElements