ui.forminput
Since 4.3
A wrapper that transforms a widget into a form input.
The control allows placing other control or a widget into an area with a label and making it look and behave as a default form input. Check FormInput documentation for a more detailed description.
Constructor
// a widget to be transformed into a form input
var list1 = {
view:"dbllist",
data:[
{id:"1", value:"Guest"},
{id:"2", value:"Member"},
{id:"3", value:"Moderator"}
]
};
// form input initialization
var forminput = webix.ui({
view:"forminput",
name:"access",
body:list1,
labelWidth: 140,
labelAlign:"right",
label:"Access levels"
});
Where to start
Methods
adjust | adjusts the component to the size of the parent HTML container |
bind | binds components |
define | redefines a single configuration property (or a object with properties) |
destructor | destructs the calling object |
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 to the control |
getBody | returns sub-view of fieldset |
getChildViews | returns child views of the calling component |
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 |
getTopParentView | returns the top parent view |
getValue | returns the current value of the control |
hide | hides the view |
isEnabled | checks whether the view is enabled |
isVisible | checks whether the view is visible |
queryView | returns inner element/elements of a widget that correspond(s) to the defined parameters |
resize | adjusts the view to a new size |
resizeChildren | resizes all children of the called component |
setBottomText | adds custom text at the bottom of the FormInput control |
setValue | sets a new value for the control |
show | makes the component visible |
unbind | breaks "bind" link |
Events
onAfterScroll | occurs when some webix view has been scrolled |
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 |
onEnter | fires when the Enter key has been pressed |
onFocus | fires when a view gets focus |
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 |
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 | fires when some webix view has been touched |
onViewResize | fires when the size of a view has been changed by resizer |
onViewShow | fires when any hidden view is shown |
Properties
$cssName | name of the widget the CSS of which you want to inherit for a custom widget |
animate | defines the type of animation, with which the view is shown, if it is a Multiview cell |
body | config for sub-view of fieldset |
borderless | used to hide the component borders |
container | an HTML container (or its ID) where the component should be initialized |
css | the name of the CSS class or the object with styles that will be applied to the view container |
disabled | indicates whether an item is enabled |
gravity | sets the view gravity |
height | sets the height of the component |
hidden | defines whether the view will be hidden initially |
id | the ID of a widget |
keyPressTimeout | a delay between the key press and the action |
label | legend of fieldset |
labelAlign | the alignment of a label towards its container |
labelWidth | the width of the label |
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 |
value | sets the initial value for the control wrapped into FormInput |
width | sets the width of a widget |
Other
$getSize | returns the current size of the component |
$height | the current height of the view |
$scope | scope for resolving event and method names |
$setNode | defines HTML element for the component |
$setSize | sets the component size |
$skin | the method which will be called when skin is defined |
$view | reference to the top HTML element of the view |
$width | the current width of the view |
config | all options from the initial component configuration |
name | indicates the name of the component (a read-only property) |
Back to top