Class Sidebar

Defines the interface for OutSystemsUI Patterns

Export

Sidebar

Implements

Hierarchy (View Summary)

AbstractPattern<SidebarConfig>
- Sidebar

Implements

Constructors

constructor

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

Properties

`Protected`isProviderBased

isProviderBased: 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 ISidebar.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 ISidebar.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 ISidebar.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 ISidebar.widgetId

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

gestureEventInstance

get gestureEventInstance(): DragEvent
Get Gesture Events Instance

Returns DragEvent

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Implementation of IDragEvent.gestureEventInstance
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:558

hasGestureEvents

get hasGestureEvents(): boolean
Get if has gesture events

Returns boolean

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Implementation of IDragEvent.hasGestureEvents
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:569

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

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

`Protected`setA11YProperties

setA11YProperties(): void
Protected
Sets the A11Y properties when the pattern is built.

Returns void

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:310

`Protected`setCallbacks

setCallbacks(): void
Protected
Sets the callbacks to be used in the pattern.

Returns void

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:333

`Protected`setHtmlElements

setHtmlElements(): void
Protected
Set the html references that will be used to manage the cssClasses and atribute properties

Returns void

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:345

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
Method to remove all assigned callbacks

Returns void

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

`Protected`unsetHtmlElements

unsetHtmlElements(): void
Protected
Release references to HTML elements.

Returns void

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:373

build

build(): void
Method to build the Sidebar

Returns void

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Implementation of ISidebar.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:383

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.Sidebar.Sidebar
Implementation of ISidebar.changeProperty

Overrides AbstractPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:408

clickOutsideToClose

clickOutsideToClose(closeOnOutSideClick: boolean): void
Public method to toggle the click on outside to close the sidebar.
Parameters
- closeOnOutSideClick: boolean
Returns void

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Implementation of ISidebar.clickOutsideToClose
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:437

close

close(): void
Public method to close the sidebar, if it's open.

Returns void

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Implementation of ISidebar.close
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:446

dispose

dispose(): void
Method to remove event listener and destroy sidebar instance

Returns void

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Implementation of ISidebar.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:457

open

open(): void
Method that opens the sidebar.

Returns void

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Implementation of ISidebar.open
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:479

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Method to set the callbacks for the pattern
Parameters
- eventName: string
- callback: OSGeneric
Returns void

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Implementation of ISidebar.registerCallback

Overrides AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:492

removeGestureEvents

removeGestureEvents(): void
Method that removes the gesture events to open/close the Sidebar on Native Apps

Returns void

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Implementation of IDragEvent.removeGestureEvents
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:512

`Protected`setGestureEvents

setGestureEvents(
    onGestureStartCallback: GestureStart,
    onGestureMoveCallback: OSFramework.OSUI.Event.GestureEvent.Callbacks.GestureMove,
    onGestureEndCallback: OSFramework.OSUI.Event.GestureEvent.Callbacks.GestureEnd,
): void
Protected
Method that sets the gesture events to open/close the Sidebar on Native Apps
Parameters
- onGestureStartCallback: GestureStart
- onGestureMoveCallback: OSFramework.OSUI.Event.GestureEvent.Callbacks.GestureMove
- onGestureEndCallback: OSFramework.OSUI.Event.GestureEvent.Callbacks.GestureEnd
Returns void

Memberof
OSFramework.Patterns.Sidebar.Sidebar
Implementation of IDragEvent.setGestureEvents
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:528

toggleGestures

toggleGestures(enableSwipe: boolean): void
Method that toggle swipes on sidebar.
Parameters
- enableSwipe: boolean
Returns void

Memberof
Sidebar
Implementation of ISidebar.toggleGestures
- Defined in OSFramework/OSUI/Pattern/Sidebar/Sidebar.ts:547

Class Sidebar

Export

Implements

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSFramework.OSUI.Patterns.Sidebar.Sidebar

Properties

ProtectedisProviderBased

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

gestureEventInstance

Returns DragEvent

Memberof

hasGestureEvents

Returns boolean

Memberof

Methods

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

ProtectedsetHtmlElements

Returns void

Memberof

ProtectedunsetCallbacks

Returns void

Memberof

ProtectedunsetHtmlElements

Returns void

Memberof

build

Returns void

Memberof

changeProperty

Parameters

Returns void

`Protected`isProviderBased

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`unsetCallbacks

`Protected`unsetHtmlElements

`Protected`setGestureEvents