Class Search

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<SearchConfig>
- Search

Implements

ISearch

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

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

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

registerCallback

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

Abstract

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of ISearch.registerCallback

Inherited from AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:184

`Protected` setA11YProperties

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

Memberof
OSFramework.Patterns.Search.Search

Returns void
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/Search/Search.ts:24

`Protected` setCallbacks

setCallbacks(): void
Protected
Set the callbacks that will be assigned to the pattern.

Memberof
OSFramework.Patterns.Search.Search

Returns void
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Search/Search.ts:34

`Protected` setHtmlElements

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

Memberof
OSFramework.Patterns.Search.Search

Returns void
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/Search/Search.ts:44

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Unset the callbacks that will be assigned to the pattern.

Memberof
Search

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Search/Search.ts:54

`Protected` unsetHtmlElements

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

Memberof
OSFramework.Patterns.Search.Search

Returns void
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Search/Search.ts:64

build

build(): void
Method to build the Search

Memberof
OSFramework.Patterns.Search.Search

Returns void
Implementation of ISearch.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/Search/Search.ts:73

dispose

dispose(): void
Destroy the Search

Memberof
OSFramework.Patterns.Search.Search

Returns void
Implementation of ISearch.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/Search/Search.ts:84

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 ISearch.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 ISearch.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 ISearch.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 ISearch.widgetId

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

Constructors

constructor

new Search(uniqueId: string, configs: JSON): OSFramework.OSUI.Patterns.Search.Search
Creates an instance of Search.

Memberof
Search
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.OSUI.Patterns.Search.Search
Overrides AbstractPattern.constructor
- Defined in OSFramework/OSUI/Pattern/Search/Search.ts:14

Class Search

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

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

registerCallback

Abstract

Memberof

Parameters

eventName: string

callback: OSGeneric

Returns void

Protected setA11YProperties

Memberof

Returns void

Protected setCallbacks

Memberof

Returns void

Protected setHtmlElements

Memberof

Returns void

Protected unsetCallbacks

Memberof

Returns void

Protected unsetHtmlElements

Memberof

Returns void

build

Memberof

Returns void

dispose

Memberof

Returns void

Accessors

Protected _enableAccessibility

Memberof

Returns boolean

selfElement

Memberof

Returns HTMLElement

isBuilt

Memberof

Returns boolean

configs

Memberof

`Protected` isProviderBased

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` _enableAccessibility