Class OverflowMenu

Class for the OverflowMenu Pattern

Export

OverflowMenu

Implements

Hierarchy (View Summary)

AbstractPattern<OverflowMenuConfig>
- OverflowMenu

Implements

IOverflowMenu

Constructors

constructor

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

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

balloonOptions

balloonOptions: BalloonOptions

isOpen

isOpen: boolean = false

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 IOverflowMenu.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 IOverflowMenu.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 IOverflowMenu.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 IOverflowMenu.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

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

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

`Protected`removeEventListeners

removeEventListeners(): void
Protected
Method that removes the event listeners

Returns void

Memberof
OverflowMenu
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:120

`Protected`setA11YProperties

setA11YProperties(): void
Protected
Add the Accessibility Attributes values

Returns void

Memberof
OSFramework.Patterns.OverflowMenu.OverflowMenu
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:136

`Protected`setCallbacks

setCallbacks(): void
Protected
Set the callbacks

Returns void

Memberof
OSFramework.Patterns.OverflowMenu.OverflowMenu
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:156

`Protected`setEventListeners

setEventListeners(): void
Protected
Method to set the event listeners

Returns void

Memberof
OverflowMenu
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:168

`Protected`setHtmlElements

setHtmlElements(): void
Protected
Update info based on htmlContent

Returns void

Memberof
OSFramework.Patterns.OverflowMenu.OverflowMenu
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:184

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
Method to unset the callbacks.

Returns void

Memberof
OSFramework.Patterns.OverflowMenu.OverflowMenu
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:195

`Protected`unsetHtmlElements

unsetHtmlElements(): void
Protected
Removes the local value of the variables pointing to HTML elements;

Returns void

Memberof
OSFramework.Patterns.OverflowMenu.OverflowMenu
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:206

build

build(): void
Method to build the OverflowMenu

Returns void

Memberof
OverflowMenu
Implementation of IOverflowMenu.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:217

changeProperty

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

Memberof
OverflowMenu
Implementation of IOverflowMenu.changeProperty

Overrides AbstractPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:235

close

close(): void
Method to close the Pattern

Returns void

Memberof
OverflowMenu
Implementation of IOverflowMenu.close
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:256

disable

disable(): void
Method to disable the pattern

Returns void

Memberof
OverflowMenu
Implementation of IOverflowMenu.disable
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:267

dispose

dispose(): void
Method to destroy the Pattern

Returns void

Memberof
OverflowMenu
Implementation of IOverflowMenu.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:282

enable

enable(): void
Method to enable the pattern

Returns void

Memberof
OverflowMenu
Implementation of IOverflowMenu.enable
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:295

open

open(isOpenedByApi: boolean, keyPressed?: ArrowDown | ArrowUp): void
Method to open the Pattern
Parameters
- isOpenedByApi: boolean
- OptionalkeyPressed: ArrowDown | ArrowUp
Returns void

Memberof
OverflowMenu
Implementation of IOverflowMenu.open
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:305

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Register the callbacks for the Pattern
Parameters
- eventName: string
- callback: OSGeneric
Returns void

Memberof
OSFramework.Patterns.OverflowMenu.OverflowMenu
Implementation of IOverflowMenu.registerCallback

Overrides AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:322

setBalloonOptions

setBalloonOptions(balloonOptions?: BalloonOptions): void
Method to set the Balloon Feature options
Parameters
- OptionalballoonOptions: BalloonOptions
Returns void

Memberof
OverflowMenu
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:343

setTriggerAriaLabel

setTriggerAriaLabel(ariaLabelText: string): void
Method to set the aria-label text for the Trigger element
Parameters
- ariaLabelText: string
Returns void

Memberof
OverflowMenu
- Defined in OSFramework/OSUI/Pattern/OverflowMenu/OverflowMenu.ts:374