ui.checksuggest

A suggest control with a multiple-choice list.

Offers select options in the form of Webix list component equipped with checkboxes. Features the ability to select multiple items at a time.

Can be used standalone or as a suggest list for text, combo and richselect controls as well as component editors. Is used by a multiselect control already.

Methods
adjust adjusts the component to the size of the parent HTML container
attachEvent attaches the handler to an inner event of the component (allows behavior customizations)
bind binds components
blockEvent temporarily blocks triggering of ALL events of the calling object
callEvent calls an inner event
close removes a window
define redefines a single configuration property (or a hash of properties)
destructor destructs the calling object
detachEvent detaches a handler from an event (which was attached before by the attachEvent method)
disable disables the calling view (makes it dimmed and unclickable)
enable enables the calling view that was disabled by the 'disable' method
getBody gets the UI view of the window body
getButton gets the button object of a multiselect popup
getChildViews returns child views of the calling component
getFormView returns master form for the input
getHead gets the ui view of the window header
getItemText returns rendered text of suggest's item
getList returns inner data control from suggest
getMasterValue returns current value of master control
getNode returns the main HTML container for the calling object
getParentView returns the parent view of the component
getSuggestion returns id of top suggestion from the suggest list
getTopParentView returns top parent view
getValue gets the ID of a selected item in the option list
hasEvent checks whether the component has the specified event
hide hides the view
isEnabled checks whether the view is enabled
isVisible checks whether the view is visible
linkInput links a suggest list to an input field
mapEvent routes events from one object to another
resize adjusts the view to a new size
resizeChildren resizes all children of the calling component
setMasterValue set value in master control
setPosition sets window's position
setValue selects an item in the option list
show makes the component visible
unbind breaks "bind" link
unblockEvent cancels blocking events that was enabled by the 'blockEvent' command
Events
onAfterScroll occurs when some webix view has been scrolled
onBeforeShow fires right after show() method is called for the window (popup) and before the window is shown
onBindRequest fires when the component is ready to receive data from the master component
onBlur fires when focus is moved out of the view
onDestruct occurs when component destroyed
onFocus fires when a view gets focus
onHide fires when window is hidden
onKeyPress occurs when keyboard key is pressed for the control in focus
onLongTouch fires on holding finger in some position for a certain period of time
onShow fires when window is shown
onSwipeX occurs on a horizontal swipe movement
onSwipeY occurs on a vertical swipe movement
onTimedKeyPress fires after typing has been finished in the field
onTouchEnd occurs when the touch event is ended
onTouchMove occurs during touch movement
onTouchStart when some webix view has been touched
onValueSuggest some item selected in the suggest control
onViewMove fires while view is moving
onViewMoveEnd fires when view has stopped moving
onViewResize view size was changed by resizer
Properties
animate defines or disables view change animation.
autofit adjusts window size to the size of an html node it is initiated in
autofocus sets focus on the window the moment it appears on the page
body the content of window body: template or view
borderless used to hide the component borders
button sets a button at the bottom of the suggest
buttonText defines text for the 'Select' button
container an HTML container (or its id) where the component should be initialized
css the name of a css class that will be applied to the view container
data JavaScript array containing data for the component
disabled indicates whether an item is enabled
filter custom filtering function
fitMaster size suggest box to the master control
gravity sets the view gravity (1 by default)
head sets the view header
headHeight defines the header height (43 by default)
height sets the height of the component
hidden defines whether the view will be hidden initially
id the component ID
input points to an HTML input field that houses the suggest list
keyPressTimeout time between key pressing and filtering start
left the left offset of the window
master reference to the master view
maxHeight sets the maximum height for the view
maxWidth sets the maximum width for the view
minHeight sets the minimal height for the view
minWidth sets the minimal width for the view
modal switches window modality
move makes view movable
on allows attaching custom handlers to inner events of the component
padding sets paddings of the chart content
position sets position of the window relative to the the screen
relative positions a popup window relative to the component it's connected with
resize enables/disables window resizing
separator sets a delimiter for multisuggest values
template template which will be used to fill parent input from selected record
textValue defines which field from suggest list will be used as text after selecting an option
toFront places window above other windows on clicking it
top the top offset of a window
type defines type of suggest control
url the URL which the component will use to load data after its initialization
value sets the initial value for a control
width sets the width of the component
zIndex stack order of the component
Other
$enterKey the method that will be called when the Enter key is pressed
$getSize returns the current size of the component
$height current height of the view
$scope scope for resolving event and method names
$setSize sets the component size
$skin the method which will be called when skin is defined
$view reference to top html element of the view
$width current width of the view
config all options from initial component configuration
name indicates the name of the component (a read-only property)
Back to top