Class Submenu

Defines the interface for OutSystemsUI Patterns

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractPattern<SubmenuConfig>
- Submenu

Implements

ISubmenu

Index

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _eventBalloonKeypress

_eventBalloonKeypress: Generic

`Private` _eventClick

_eventClick: Generic

`Private` _eventKeypress

_eventKeypress: Generic

`Private` _eventOnMouseEnter

_eventOnMouseEnter: Generic

`Private` _eventOnMouseLeave

_eventOnMouseLeave: Generic

`Private` _focusManagerInstance

_focusManagerInstance: FocusManager

`Private` _focusTrapInstance

_focusTrapInstance: FocusTrap

`Private` _globalEventBody

_globalEventBody: Generic

`Private` _hasActiveLinks

_hasActiveLinks: boolean = false

`Private` _hasElements

_hasElements: boolean = false

`Private` _isActive

_isActive: boolean = false

`Private` _isOpen

_isOpen: boolean = false

`Private` _platformEventOnToggleCallback

_platformEventOnToggleCallback: OSGeneric

`Private` _submenuActiveLinksElement

_submenuActiveLinksElement: HTMLElement

`Private` _submenuAllLinksElement

_submenuAllLinksElement: HTMLAnchorElement[]

`Private` _submenuHeaderElement

_submenuHeaderElement: HTMLElement

`Private` _submenuLinksElement

_submenuLinksElement: HTMLElement

hasClickOutsideToClose

hasClickOutsideToClose: boolean = true

Methods

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
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.

Memberof
AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
- Rest ...args: unknown[]
Returns void
Inherited from AbstractPattern.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected` triggerPlatformInitializedEventCallback

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

Memberof
AbstractPattern

Returns void
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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
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.

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
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.

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- patternId: string
Returns boolean
Implementation of ISubmenu.equalsToID

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

`Private` _bodyClickCallback

_bodyClickCallback(_args: string, e: MouseEvent): void
Parameters
- _args: string
- e: MouseEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:33

`Private` _checkForActiveLinks

_checkForActiveLinks(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:44

`Private` _clickCallback

_clickCallback(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:54

`Private` _handleFocusBehavior

_handleFocusBehavior(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:59

`Private` _keypressBalloonCallback

_keypressBalloonCallback(e: KeyboardEvent): void
Parameters
- e: KeyboardEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:76

`Private` _keypressCallback

_keypressCallback(e: KeyboardEvent): void
Parameters
- e: KeyboardEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:88

`Private` _onMouseEnterCallback

_onMouseEnterCallback(e: MouseEvent): void
Parameters
- e: MouseEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:129

`Private` _onMouseLeaveCallback

_onMouseLeaveCallback(e: MouseEvent): void
Parameters
- e: MouseEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:135

`Private` _removeActive

_removeActive(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:148

`Private` _removeEvents

_removeEvents(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:156

`Private` _setActive

_setActive(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:178

`Private` _show

_show(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:186

`Private` _toggleSubmenu

_toggleSubmenu(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:198

`Private` _updateA11yProperties

_updateA11yProperties(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:208

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Add the A11Y attributes values

Memberof
OSFramework.Patterns.Submenu.Submenu

Returns void
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:230

`Protected` setCallbacks

setCallbacks(): void
Protected
Add Pattern Events

Memberof
OSFramework.Patterns.Submenu.Submenu

Returns void
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:259

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Update info based on htmlContent

Memberof
OSFramework.Patterns.Submenu.Submenu

Returns void
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:285

`Protected` setInitialStates

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

Memberof
OSFramework.Patterns.Submenu.Submenu

Returns void
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:305

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Remove all the assigned Events

Memberof
OSFramework.Patterns.Submenu.Submenu

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:330

`Protected` unsetHtmlElements

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

Memberof
OSFramework.Patterns.Submenu.Submenu

Returns void
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:347

build

build(): void
Method to build the Submenu

Memberof
OSFramework.Patterns.Submenu.Submenu

Returns void
Implementation of ISubmenu.build

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

clickOutsideToClose

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

Memberof
Submenu
Parameters
- clickOutsideToClose: boolean
Returns void
Implementation of ISubmenu.clickOutsideToClose
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:381

close

close(): void
Close Submenu

Memberof
OSFramework.Patterns.Submenu.Submenu

Returns void
Implementation of ISubmenu.close
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:403

dispose

dispose(): void
Destroy the Submenu

Memberof
OSFramework.Patterns.Submenu.Submenu

Returns void
Implementation of ISubmenu.dispose

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

open

open(): void
Public Open Submenu

Memberof
OSFramework.Patterns.Submenu.Submenu

Returns void
Implementation of ISubmenu.open
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:453

registerCallback

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

Memberof
Submenu
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of ISubmenu.registerCallback

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

setOpenOnHover

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

Memberof
Submenu

Returns void
Implementation of ISubmenu.setOpenOnHover
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:500

updateOnRender

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

Memberof
OSFramework.Patterns.Submenu.Submenu

Returns void
Implementation of ISubmenu.updateOnRender
- Defined in OSFramework/OSUI/Pattern/Submenu/Submenu.ts:519

Accessors

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractPattern._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns HTMLElement
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.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
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.

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from AbstractPattern.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
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.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of ISubmenu.widgetId

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

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:28

Class Submenu

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Private _eventBalloonKeypress

Private _eventClick

Private _eventKeypress

Private _eventOnMouseEnter

Private _eventOnMouseLeave

Private _focusManagerInstance

Private _focusTrapInstance

Private _globalEventBody

Private _hasActiveLinks

Private _hasElements

Private _isActive

Private _isOpen

Private _platformEventOnToggleCallback

Private _submenuActiveLinksElement

Private _submenuAllLinksElement

Private _submenuHeaderElement

Private _submenuLinksElement

hasClickOutsideToClose

Methods

Protected finishBuild

Memberof

Returns void

Protected triggerPlatformEventCallback

Memberof

Parameters

platFormCallback: OSGeneric

Rest ...args: unknown[]

Returns void

Protected triggerPlatformInitializedEventCallback

Memberof

Returns void

Protected unsetGlobalCallbacks

Memberof

Returns void

changeProperty

Memberof

Parameters

propertyName: string

propertyValue: unknown

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Private _bodyClickCallback

Parameters

_args: string

e: MouseEvent

Returns void

Private _checkForActiveLinks

Returns void

Private _clickCallback

Returns void

Private _handleFocusBehavior

Returns void

Private _keypressBalloonCallback

Parameters

e: KeyboardEvent

Returns void

Private _keypressCallback

Parameters

e: KeyboardEvent

Returns void

Private _onMouseEnterCallback

Parameters

e: MouseEvent

`Protected` isProviderBased

`Private` _eventBalloonKeypress

`Private` _eventClick

`Private` _eventKeypress

`Private` _eventOnMouseEnter

`Private` _eventOnMouseLeave

`Private` _focusManagerInstance

`Private` _focusTrapInstance

`Private` _globalEventBody

`Private` _hasActiveLinks

`Private` _hasElements

`Private` _isActive

`Private` _isOpen

`Private` _platformEventOnToggleCallback

`Private` _submenuActiveLinksElement

`Private` _submenuAllLinksElement

`Private` _submenuHeaderElement

`Private` _submenuLinksElement

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _bodyClickCallback

`Private` _checkForActiveLinks

`Private` _clickCallback

`Private` _handleFocusBehavior

`Private` _keypressBalloonCallback

`Private` _keypressCallback

`Private` _onMouseEnterCallback

`Private` _onMouseLeaveCallback

`Private` _removeActive

`Private` _removeEvents

`Private` _setActive

`Private` _show

`Private` _toggleSubmenu

`Private` _updateA11yProperties

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` setInitialStates

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` _enableAccessibility