Class Search

Defines the interface for OutSystemsUI Patterns

Hierarchy (View Summary)

AbstractPattern<SearchConfig>
- Search

Implements

ISearch

Constructors

constructor

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

Memberof
Search
Overrides AbstractPattern.constructor
- Defined in OSFramework/OSUI/Pattern/Search/Search.ts:14

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
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.

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

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of ISearch.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 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.
Parameters
- patternId: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of ISearch.equalsToID

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

`Abstract`registerCallback

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

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns void

Memberof
OSFramework.Patterns.Search.Search
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.

Returns void

Memberof
OSFramework.Patterns.Search.Search
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.

Returns void

Memberof
OSFramework.Patterns.Search.Search
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.

Returns void

Memberof
Search
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.

Returns void

Memberof
OSFramework.Patterns.Search.Search
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Search/Search.ts:64

build

build(): void
Method to build the Search

Returns void

Memberof
OSFramework.Patterns.Search.Search
Implementation of ISearch.build

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

dispose

dispose(): void
Destroy the Search

Returns void

Memberof
OSFramework.Patterns.Search.Search
Implementation of ISearch.dispose

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

Class Search

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSFramework.OSUI.Patterns.Search.Search

Memberof

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

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

AbstractregisterCallback

Parameters

Returns void

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

dispose

Returns void

`Protected`isProviderBased

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Abstract`registerCallback

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`unsetCallbacks

`Protected`unsetHtmlElements