Constructs a format edit.
Optional parent: WidgetProtected m_Protected m_Protected m_Protected m_Protected m_Protected m_Returns true if events are blocked; otherwise returns false.
If blocked is true, then events emitted by this event watcher will be blocked, meaning that emitting an event will not trigger any callback functions that are bound to it.
Returns the dom of this edit.
Returns whether this widget or its parent chain is enabled or not. By default, the value of this property is true.
Sets whether this widget is enabled or not. Disabling a widget implicitly disables all its children, it is not possible to explicitly enable a child widget while its parent widget remains disabled.
Returns the height of this widget.
Sets the height of this widget to the given height.
The unit of height is px.
Returns the id of this widget.
Set the id of this widget to the given id. The id is utilized to set the style of the widget. See also css
Returns the left coordinate of this widget within its parent widget.
Sets the left coordinate of this widget within its parent widget.
The unit of left is px.
Returns the parent of this widget, or undefined if it does not have any parent widget.
Sets the parent of the widget to the given parent. If the new parent widget is the old parent widget, this function does nothing.
Returns the password property of this edit.
Sets the password property to the given password. If the property is true, this edit displays password mask characters instead of the characters actually entered.
Returns the placeholder text of this edit. By default, the value of this property is an empty string.
Sets the placeholder text of this edit. Normally, an empty edit shows the placeholder text.
Returns whether this edit is read only or not. In read only mode, the user cannot edit it. By default, the value of this property is false.
Sets whether this edit is read only or not.
Returns the style of this widget.
Returns the text of this edit. By default, the value of this property is an empty string.
Sets the text of this edit to the given text.
Returns the tooltip of this widget. When the mouse hovers over the widget for a period of time(it can be set by Tooltip::WakeUpDelay), a message will automatically pop up, and it will disappear automatically when the mouse moves away. By default, the value of this property is an empty string.
Sets the tooltip of this widget to the given tooltip.
Returns the top coordinate of this widget within its parent widget.
Sets the top coordinate of this widget to the given top.
The unit of top is px.
Returns whether this widget or its parent chain is visible or not. By default, the value of this property is true.
Sets whether this widget is visible or not. If an ancestor widget is not visible, the widget won't become visible until all its ancestors are visible.
Returns the width of this widget.
Sets the width of this widget to the given width.
The unit of width is px.
Static senderReturns the object that sent the event.
Adds the attribute of this widget. The attribute is utilized to set the style. See also css
Adds the class name of this widget. The class name is utilized to set the style. See also css. All widgets with the same class name use the same style.
Protected attachAdds a callback function that's going to be called when the event is emitted.
Rest ...data: EventMap[K]Rest ...data: any[]Protected createDelegates this event watcher to handle the given watcher's event named name.
Destroys the widget, all the widget's children are destroyed first. The widget is destroyed when it's parent is destroyed. When the widget is destroyed, make sure to release all resources, such as timers, etc. Releases the resources in the protected function free(), and the system will call this function automatically when the parent widget or itself is destroyed. See also free.
Protected detachEmits an arbitrary set of arguments to the callback function which is bound to the event named name.
Rest ...data: EventMap[K]Rest ...data: any[]Protected freeFrees the resources.See also destroy.
Inserts the child widget at index in the list of children.
Sets whether the widget uses flex layout.
Horizontal or vertical.
Optional alignItem: "center" | "inherit" | "stretch" | "flex-start" | "flex-end" | "initial" | "baseline"Optional spacing: numberthe spacing between widgets inside the layout.
Removes the specified watcher for the event named name.
Generated using TypeDoc
The FormatEdit is an edit widget that includes a validator. It allows the text to be constrained basing on the rules defined by the validator.