ui.htmlform
A control for integration with an HTML form.
The component allows you to get an HTML Form as a lib-based view, so that to use it together with the other lib components (common API, techniques, architecture etc.). Check htmlform documentation for more detailed description.
Constructor
var htmlform = webix.ui({
view:"htmlform",
container:"mydiv",
...config options goes here..
})
//or, in case of jQuery
$("#mydiv").webix_htmlform({
...config options goes here..
});
Where to start
Based on:
ui.template,
Scrollable,
AtomDataLoader,
AtomRender,
EventSystem,
ui.view,
ui.baseview,
Settings,
Destruction,
BaseBind,
UIExtension,
Values
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 behaviour 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 |
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 |
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 |
parse | loads data to the component from an inline data source |
refresh | repaints the component |
render | renders the specified item or the whole component |
resize | adjusts the view to a new size |
scrollTo | scrolls the data container to a certain position |
setContent | attaches html container to the template |
setDirty | marks the form as the one with changed values and vice versa |
setHTML | set hmlt for template |
setValues | sets values into all the form inputs |
show | makes the component visible |
sync | allows you to sync two copy of data (all or just a part of it) from one DataCollection to another |
unbind | breaks "bind" link |
unblockEvent | cancels blocking events that was enabled by the 'blockEvent' command |
Events
onAfterLoad | fires after server side loading is complete |
onAfterRender | occurs immediately after the component has been rendered. |
onAfterScroll | occurs when some webix view has been scrolled |
onBeforeLoad | occurs immediately before data loading has been started |
onBeforeRender | occurs immediately before the component has been rendered |
onBindRequest | fires when the component is ready to receive data from the master component |
onChange | fires when data in the input or related form/toolbar is changed |
onDestruct | occurs when component destroyed |
onKeyPress | occurs when keyboard key is pressed for the control in focus |
onLoadError | fires when an error occurs during data loading ( invalid server side response ) |
onLongTouch | fires on holding finger in some position for a certain period of time |
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 |
onValues | fires after values have been set within toolbar or form |
onViewResize | view size was changed by resizer |
Properties
animate | defines or disables view change animation. |
autoheight | lets the component autosize to its contents |
borderless | used to hide the component borders |
container | an html container (or its id) where the component needs initializing |
content | the id or node, whose content will be moved to the view |
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 or not |
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 |
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 |
onClick | attaches a click behavior for component items with the specified CSS class. |
scroll | enables/disables the scroll bar |
scrollSpeed | the time during which the component is scrolled to the specified position (in milliseconds) |
src | the path to an external template that is loaded by Ajax |
template | the component template |
type | name of predefined styling type |
url | the URL the component will use to load data after its initialization |
width | sets the width of the component |
Other
$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 | method, which will be called when skin 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