ui.form

A form that supports an extended set of elements.

The component provides validation and the ability to save user input to the backend database. Check form documentation for more detailed description.

Constructor

var form = webix.ui({
    view:"form", 
    elements:[
        { view:"text", label:"Email" },
        { view:"text", type:"password", label:"Password" },
        {cols:[
            { view:"button", value:"Login", type:"form" },
            { view:"button", value:"Cancel" }
        ]}
    ]
});

Where to start

Methods
addView adds a new view to a layout-like component
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
clear clears all the field in a specified form
clearValidation removes "data incorrect" highlighting from invalid text fields
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
focus sets focus into the necessary component
getChildViews returns child views of the calling component
getCleanValues returns hash of original form values
getDirtyValues returns hash of changed values
getFormView returns master form for the input
getNode returns the main HTML container for the calling object
getParentView returns the parent view of the component
getScrollState returns the scroll position
getTopParentView returns top parent view
getValues derives input values from the form
hasEvent checks whether the component has the specified event
hide hides the view
index returns the cell index in the layout collection
isDirty checks whether changes within form were made
isEnabled checks whether the view is enabled
isVisible checks whether the view is visible
load loads data from an external data source.
mapEvent routes events from one object to another
markInvalid marks a form control invalid
parse loads data to the component from an inline data source
reconstruct rebuilds the layout
refresh repaints the component
removeView removes view from layout-like component
render renders the specified item or the whole component
resize adjusts the view to a new size
resizeChildren resizes all children of the called component
scrollTo scrolls the data container to a certain position
setDirty marks the form as the one with changed values and vice versa
setValues sets values into the inputs of a form/toolbar/property sheet control
show makes the component visible
showBatch makes visible those elements which parameter 'batch' is set to the specified name
unbind breaks "bind" link
unblockEvent cancels blocking events that was enabled by the 'blockEvent' command
validate checks data in the form
Events
onAfterLoad fires after server side loading is complete
onAfterScroll fires when to component is scrolled in any direction
onAfterValidation fires after data has been validated
onBeforeLoad occurs immediately before data loading has been started
onBeforeValidate called before running validation
onBindRequest fires when the component is ready to receive data from the master component
onChange fires when data in the input of related form/toolbar is changed
onDestruct occurs when component destroyed
onLoadError fires when an error occurs during data loading ( invalid server side response )
onSubmit fires when enter key is pressed for a focused control in the form
onValidationError fires when a form input fails to pass validation
onValidationSuccess fires after a form input has passed validation successfully
onValues fires after values have been set within toolbar or form
Properties
animate defines or disables view change animation.
autoheight sets component height according to its contents
borderless used to hide the component borders
cols array of views objects arranged horizontally
complexData enables complex data parsing mode
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
dataFeed the URL that the component will use to reload data during binding
datatype the type of loaded data
disabled indicates whether an item is enabled
elements collection of subviews
elementsConfig settings, which will be applied to all nested inputs
gravity sets the view gravity (1 by default)
height sets the height of the component
hidden defines whether the view will be hidden initially
id the component ID
isolate masks IDs of all inner elements
margin defines the space around elements (applies the specified value to all elements)
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
on allows attaching custom handlers to inner events of the component
padding defines the space between the element borders and content (applies the specified value to all sides).
paddingX sets the right and left padding (applies the specified value to both sides)
paddingY sets the top and bottom padding (applies the specified value to both sides)
responsive enables responsive mode for horizontal layout
rows array of views objects arranged vertically
rules defines a set of rules for input field(s) of the form(htmlform)
scroll enables/disables the scroll bar
scrollSpeed the time during which the component is scrolled to the specified position (in milliseconds)
type defines the layout borders
url the URL which the component will use to load data after its initialization
visibleBatch sets the batch that will be shown initially
width sets the width of the component
Other
$getSize returns the current size of the component
$height current height of the view
$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