Skip to content

@serenity-is/corelib / AbstractSelect2

Abstract Class: AbstractSelect2

Defined in: src/ui/editors/select2.tsx:1142

Extended by

Constructors

Constructor

new AbstractSelect2(): AbstractSelect2

Returns

AbstractSelect2

Properties

autofocus

protected autofocus: boolean

Defined in: src/ui/editors/select2.tsx:1149


container

container: HTMLElement

Defined in: src/ui/editors/select2.tsx:1150


containerEventName

protected containerEventName: string

Defined in: src/ui/editors/select2.tsx:1152


containerId

protected containerId: string

Defined in: src/ui/editors/select2.tsx:1151


context

protected context: any

Defined in: src/ui/editors/select2.tsx:1153


dropdown: HTMLElement

Defined in: src/ui/editors/select2.tsx:1154


elementTabIndex

protected elementTabIndex: string

Defined in: src/ui/editors/select2.tsx:1155


enabledInterface

protected enabledInterface: boolean

Defined in: src/ui/editors/select2.tsx:1156


id()

protected id: (item) => string

Defined in: src/ui/editors/select2.tsx:1157

Parameters

item

any

Returns

string


nextSearchTerm

protected nextSearchTerm: string

Defined in: src/ui/editors/select2.tsx:1158


opts

protected opts: Select2Options

Defined in: src/ui/editors/select2.tsx:1159


propertyObserver

protected propertyObserver: MutationObserver

Defined in: src/ui/editors/select2.tsx:1160


queryCount

protected queryCount: number

Defined in: src/ui/editors/select2.tsx:1161


results

protected results: HTMLElement

Defined in: src/ui/editors/select2.tsx:1162


resultsPage

protected resultsPage: number

Defined in: src/ui/editors/select2.tsx:1163


search: HTMLInputElement

Defined in: src/ui/editors/select2.tsx:1164


select

protected select: HTMLSelectElement

Defined in: src/ui/editors/select2.tsx:1374


selection

protected selection: HTMLElement

Defined in: src/ui/editors/select2.tsx:1165


showSearchInput

protected showSearchInput: boolean

Defined in: src/ui/editors/select2.tsx:1166

Methods

blur()

protected blur(): void

Defined in: src/ui/editors/select2.tsx:2429

Returns

void


cancel()

protected cancel(e?): void

Defined in: src/ui/editors/select2.tsx:2425

Parameters

e?

Event

Returns

void


clearDropdownAlignmentPreference()

protected clearDropdownAlignmentPreference(): void

Defined in: src/ui/editors/select2.tsx:1832

Returns

void


clearSearch()

protected clearSearch(): void

Defined in: src/ui/editors/select2.tsx:1996

Returns

void


clearTouchMoved()

protected clearTouchMoved(): void

Defined in: src/ui/editors/select2.tsx:2105

Returns

void


close()

close(): void

Defined in: src/ui/editors/select2.tsx:1948

Returns

void


countSelectableResults()

protected countSelectableResults(): number

Defined in: src/ui/editors/select2.tsx:2109

Returns

number


createContainer()

abstract protected createContainer(): HTMLElement

Defined in: src/ui/editors/select2.tsx:1168

Returns

HTMLElement


data()

abstract data(value?, triggerChange?): void | Select2Item | Select2Item[]

Defined in: src/ui/editors/select2.tsx:1169

Parameters

value?

Select2Item | Select2Item[]

triggerChange?

boolean

Returns

void | Select2Item | Select2Item[]


destroy()

destroy(): void

Defined in: src/ui/editors/select2.tsx:1304

Returns

void


disable()

disable(): void

Defined in: src/ui/editors/select2.tsx:1695

Returns

void


enable()

enable(enabled?): void

Defined in: src/ui/editors/select2.tsx:1686

Parameters

enabled?

boolean

Returns

void


enableInterface()

protected enableInterface(): boolean

Defined in: src/ui/editors/select2.tsx:1673

Returns

boolean


ensureHighlightVisible()

protected ensureHighlightVisible(): void

Defined in: src/ui/editors/select2.tsx:2004

Returns

void


externalSearch()

protected externalSearch(term): void

Defined in: src/ui/editors/select2.tsx:1990

Opens control, sets input value, and updates results.

Parameters

term

string

Returns

void


findHighlightableChoices()

protected findHighlightableChoices(): Element[]

Defined in: src/ui/editors/select2.tsx:2051

Returns

Element[]


focus()

abstract focus(): void

Defined in: src/ui/editors/select2.tsx:1170

Returns

void


focusSearch()

protected focusSearch(): void

Defined in: src/ui/editors/select2.tsx:2441

Returns

void


getMaximumSelectionSize()

protected getMaximumSelectionSize(): any

Defined in: src/ui/editors/select2.tsx:2000

Returns

any


getPlaceholder()

protected getPlaceholder(): string

Defined in: src/ui/editors/select2.tsx:2462

Returns

string


getPlaceholderOption()

protected getPlaceholderOption(): HTMLOptionElement

Defined in: src/ui/editors/select2.tsx:2470

Returns

HTMLOptionElement


handleSearchBlur()

protected handleSearchBlur(): void

Defined in: src/ui/editors/select2.tsx:2194

Returns

void


handleSearchFocus()

protected handleSearchFocus(): void

Defined in: src/ui/editors/select2.tsx:2190

Returns

void


handleSearchInput()

protected handleSearchInput(): void

Defined in: src/ui/editors/select2.tsx:2186

Returns

void


highlight()

protected highlight(index?): number

Defined in: src/ui/editors/select2.tsx:2069

Parameters

index?

number

Returns

number


highlightUnderEvent()

protected highlightUnderEvent(event): void

Defined in: src/ui/editors/select2.tsx:2113

Parameters

event

Event

Returns

void


init()

init(opts): void

Defined in: src/ui/editors/select2.tsx:1178

Parameters

opts

Select2Options

Returns

void


initContainer()

abstract protected initContainer(): void

Defined in: src/ui/editors/select2.tsx:1172

Returns

void


initContainerWidth()

protected initContainerWidth(): void

Defined in: src/ui/editors/select2.tsx:2490

Get the desired width for the container element. This is derived first from option width passed to select2, then the inline 'style' on the original element, and finally falls back to the jQuery calculated element width.

Returns

void


initSelection()

abstract protected initSelection(): void

Defined in: src/ui/editors/select2.tsx:1173

Returns

void


isFocused()

abstract isFocused(): boolean

Defined in: src/ui/editors/select2.tsx:1171

Returns

boolean


isInterfaceEnabled()

protected isInterfaceEnabled(): boolean

Defined in: src/ui/editors/select2.tsx:1669

Returns

boolean


loadMoreIfNeeded()

protected loadMoreIfNeeded(): void

Defined in: src/ui/editors/select2.tsx:2124

Returns

void


monitorSource()

protected monitorSource(): void

Defined in: src/ui/editors/select2.tsx:1618

Monitor the original element for changes and update select2 accordingly

Returns

void


moveHighlight()

protected moveHighlight(delta): void

Defined in: src/ui/editors/select2.tsx:2055

Parameters

delta

number

Returns

void


onSelect()

abstract protected onSelect(item, options?): void

Defined in: src/ui/editors/select2.tsx:1174

Parameters

item

Select2Item

options?
noFocus

boolean

Returns

void


open()

open(): boolean

Defined in: src/ui/editors/select2.tsx:1844

Opens the dropdown

Returns

boolean

whether or not dropdown was opened. This method will return false if, for example, the dropdown is already open, or if the 'open' event listener on the element called preventDefault().


opened()

opened(): boolean

Defined in: src/ui/editors/select2.tsx:1708

Returns

boolean


opening()

protected opening(): void

Defined in: src/ui/editors/select2.tsx:1866

Performs the opening of the dropdown

Returns

void


optionToData()

optionToData(element): Select2Item

Defined in: src/ui/editors/select2.tsx:1354

Parameters

element

HTMLOptGroupElement | HTMLOptionElement

Returns

Select2Item


positionDropdown()

positionDropdown(): void

Defined in: src/ui/editors/select2.tsx:1712

Returns

void


postprocessResults()

abstract protected postprocessResults(data, initial, noHighlightUpdate?): void

Defined in: src/ui/editors/select2.tsx:1175

Parameters

data

Select2Result

initial

boolean

noHighlightUpdate?

boolean

Returns

void


prepareOpts()

protected prepareOpts(opts): Select2Options

Defined in: src/ui/editors/select2.tsx:1404

Parameters

opts

Select2Options

Returns

Select2Options


readonly()

readonly(enabled?): void

Defined in: src/ui/editors/select2.tsx:1699

Parameters

enabled?

boolean

Returns

void


removeHighlight()

protected removeHighlight(): void

Defined in: src/ui/editors/select2.tsx:2097

Returns

void


selectHighlighted()

protected selectHighlighted(options?): void

Defined in: src/ui/editors/select2.tsx:2445

Parameters

options?

any

Returns

void


shouldOpen()

protected shouldOpen(): boolean

Defined in: src/ui/editors/select2.tsx:1822

Returns

boolean


tokenize()

protected tokenize(): string

Defined in: src/ui/editors/select2.tsx:2182

Default tokenizer function which does nothing

Returns

string


touchMoved()

protected touchMoved(): void

Defined in: src/ui/editors/select2.tsx:2101

Returns

void


triggerChange()

protected triggerChange(details?): void

Defined in: src/ui/editors/select2.tsx:1650

Triggers the change event on the source element

Parameters

details?

any

Returns

void


triggerSelect()

protected triggerSelect(data): boolean

Defined in: src/ui/editors/select2.tsx:1641

Parameters

data

Select2Item

Returns

boolean


updateResults()

protected updateResults(initial?): void

Defined in: src/ui/editors/select2.tsx:2255

Parameters

initial?

boolean

whether or not this is the call to this method right after the dropdown has been opened

Returns

void


val()

abstract val(value?): string | string[]

Defined in: src/ui/editors/select2.tsx:1176

Parameters

value?

string | string[]

Returns

string | string[]