Class AutoCompleteField

Object
   |
   +--Field
         |
         +--ComponentField
               |
               +--AutoCompleteField

class AutoCompleteField

extends ComponentField

Defined in form/autocompletefield.js

Field Detail

autoComplete

Object autoComplete

Holds the div element used to show autocomplete choices

choiceCount

Number choiceCount

Last count of choices

choiceItems

Array choiceItems

Last list of available choices

choosing

Boolean choosing

Indicates a choice is being made

fldChanged

Boolean fldChanged

Indicates text field changed

options

Object options

Component settings

overChoices

Boolean overChoices

Flag that indicates mouse is over the choices container

selectedIndex

Boolean selectedIndex

Index of the current selected choice

AutoCompleteField

AutoCompleteField(<String> id, <Object> options)

AutoCompleteField adds autocomplete funcionality to a normal text input. The choices can be filtered locally or through an Ajax request. It supports multiple selection, and it's totally integrated with PHP2Go forms API

Parameters:
id - Field ID
options - Settings

blurHandler

void blurHandler(<Event> e)

Gets called when text input looses focus. Must hide choices if typed key is 9 (TAB) or mouse is not over the choices container

Parameters:
e - Event

choiceClickHandler

void choiceClickHandler(<Event> e)

Handles click on choice items

Parameters:
e - Event

choiceHoverHandler

void choiceHoverHandler(<Event> e)

Handles mouseover/mouseout events on choice items

Parameters:
e - Event

chooseByIndex

 <private> void chooseByIndex(<Number> idx)

Choose an available choice from its index

Parameters:
idx - Choice index

clear

void clear()

Clear the component's value

disable

void disable()

Disable the component

findLastSeparator

Number findLastSeparator()

Finds the last separator position in the field contents

getChoices

void getChoices()

Retrieve the choices for the current search token. When ajax mode is on, a request will be performed. Otherwise, local choices will be filtered

getLastToken

String getLastToken()

Retrieve the search token. When incremental mode is on, the rightmost token will be returned.

getValue

Object getValue()

Retrieve the component's value. Returns a string (incremental=false) or an array (incremental=true)

hideChoices

void hideChoices()

Hide the auto complete choices box

isEmpty

Boolean isEmpty()

Check if the component's value is empty

keyDownHandler

void keyDownHandler(<Event> e)

Handles keydown event. Capture action keys when choices are being displayed. Store last field value and cancel last keyup timer

Parameters:
e - Event

keyUpHandler

void keyUpHandler(<Event> e)

Handles keyup event. Triggers timer function when the value of the field has changed

Parameters:
e - Event

mouseHandler

void mouseHandler(<Event> e)

Mouse events handler for the choices container. Controls the state of the overChoices flag (mouseover and mouseout) and prevents text input blur upon scroll

Parameters:
e - Event

navigate

 <private> void navigate(<Number> fw)

Navigate by a given offset in the available choices

Parameters:
fw - Offset

setup

void setup()

Initializes all options and event handlers

setValue

void setValue(<Object> val)

Define a new value for the component. Expects an array when incremental mode is on

Parameters:
val - New value

showChoices

void showChoices()

Display a box containing the available choices

timerHandler

void timerHandler()

Gets called when the delay after the last typed key is reached. Calls AutoCompleteField.getChoices() when current token exceeds the minimum required length

updateChoices

 <private> void updateChoices(<String> html)

Update the choices box contents

Parameters:
html - New contents