tinymce.ui.TextBox

Creates a new textbox.

Settings

name type summary defined by
autofocus Boolean True if the control should be focused when rendered. tinymce.ui.Widget
border String Border box values example: 1 1 1 1 tinymce.ui.Control
classes String Space separated list of classes to add. tinymce.ui.Control
disabled Boolean Is the control disabled by default. tinymce.ui.Control
hidden Boolean Is the control hidden by default. tinymce.ui.Control
margin String Margin box values example: 1 1 1 1 tinymce.ui.Control
maxLength Number Max length for the textbox. tinymce.ui.TextBox
minHeight Number Minimal height for the control. tinymce.ui.Control
minWidth Number Minimal width for the control. tinymce.ui.Control
multiline Boolean True if the textbox is a multiline control. tinymce.ui.TextBox
name String Name of the control instance. tinymce.ui.Control
padding String Padding box values example: 1 1 1 1 tinymce.ui.Control
role String WAI-ARIA role to use for control. tinymce.ui.Control
size Number Size of the textbox in characters. tinymce.ui.TextBox
style String Style CSS properties to add. tinymce.ui.Control
text String Text to display inside widget. tinymce.ui.Widget
tooltip String Tooltip text to display when hovering. tinymce.ui.Widget

Constructors

name summary defined by
Control() Constructs a new control instance with the specified settings. tinymce.ui.Control
TextBox() Constructs a instance with the specified settings. tinymce.ui.TextBox
Widget() Constructs a instance with the specified settings. tinymce.ui.Widget

Methods

name summary defined by
active() Sets/gets the active for the control. tinymce.ui.Control
after() Adds items after the current control. tinymce.ui.Control
aria() Sets the specified aria property. tinymce.ui.Control
before() Adds items before the current control. tinymce.ui.Control
blur() Blurs the current control. tinymce.ui.Control
disabled() Sets/gets the disabled state on the control. tinymce.ui.Control
encode() Encodes the specified string with HTML entities. It will also translate the string to different languages. tinymce.ui.Control
fire() Fires the specified event by name and arguments on the control. This will execute all bound event handlers. tinymce.ui.Control
focus() Focuses the current control. tinymce.ui.Control
getContainerElm() Returns the root element to render controls into. tinymce.ui.Control
getEl() Returns the control DOM element or sub element. tinymce.ui.Control
getParentCtrl() Returns a control instance for the current DOM element. tinymce.ui.Control
hasEventListeners() Returns true/false if the specified event has any listeners. tinymce.ui.Control
hide() Sets the visible state to false. tinymce.ui.Control
initLayoutRect() Initializes the current controls layout rect. This will be executed by the layout managers to determine the default minWidth/minHeight etc. tinymce.ui.Control
innerHtml() Sets the inner HTML of the control element. tinymce.ui.Control
layoutRect() Getter/setter for the current layout rect. tinymce.ui.Control
name() Sets/gets the name for the control. tinymce.ui.Control
next() Returns the control next to the current control. tinymce.ui.Control
off() Unbinds the specified event and optionally a specific callback. If you omit the name parameter all event handlers will be removed. If you omit the callback all event handles by the specified name will be removed. tinymce.ui.Control
on() Binds a callback to the specified event. This event can both be native browser events like "click" or custom ones like PostRender. The callback function will be passed a DOM event like object that enables yout do stop propagation. tinymce.ui.Control
parent() Sets/gets the parent container for the control. tinymce.ui.Control
parents() Returns a control collection with all parent controls. tinymce.ui.Control
parentsAndSelf() Returns the current control and it's parents. tinymce.ui.Control
postRender() Called after the control has been rendered. tinymce.ui.TextBox
prev() Returns the control previous to the current control. tinymce.ui.Control
reflow() Reflows the current control and it's parents. This should be used after you for example append children to the current control so that the layout managers know that they need to reposition everything. tinymce.ui.Control
remove() Removes the current control from DOM and from UI collections. tinymce.ui.Widget
renderBefore() Renders the control to the specified element. tinymce.ui.Control
renderHtml() Renders the control as a HTML string. tinymce.ui.TextBox
repaint() Repaints the control after a layout operation. tinymce.ui.TextBox
scrollIntoView() Scrolls the current control into view. tinymce.ui.Control
show() Sets the visible state to true. tinymce.ui.Control
text() Sets/gets the text for the control. tinymce.ui.Control
title() Sets/gets the title for the control. tinymce.ui.Control
tooltip() Returns the current tooltip instance. tinymce.ui.Widget
translate() Returns the translated string. tinymce.ui.Control
visible() Sets/gets the visible for the control. tinymce.ui.Control

Constructors

Control

public constructor function Control(settings:Object)

Constructs a new control instance with the specified settings.

Parameters

TextBox

public constructor function TextBox(settings:Object)

Constructs a instance with the specified settings.

Parameters

Widget

public constructor function Widget(settings:Object)

Constructs a instance with the specified settings.

Parameters

Methods

active

active(state:Boolean):Boolean, tinymce.ui.Control

Sets/gets the active for the control.

Parameters
Return value

after

after(items:Array):tinymce.ui.Control

Adds items after the current control.

Parameters
Return value

aria

aria(name:String, value:String):tinymce.ui.Control

Sets the specified aria property.

Parameters
Return value

before

before(items:Array):tinymce.ui.Control

Adds items before the current control.

Parameters
Return value

blur

blur():tinymce.ui.Control

Blurs the current control.

Return value

disabled

disabled(state:Boolean):Boolean, tinymce.ui.Control

Sets/gets the disabled state on the control.

Parameters
Return value

encode

encode(text:String, translate:Boolean):String

Encodes the specified string with HTML entities. It will also translate the string to different languages.

Parameters
Return value

fire

fire(name:String, args:Object, bubble:Boolean):Object

Fires the specified event by name and arguments on the control. This will execute all bound event handlers.

Parameters
Return value

focus

focus():tinymce.ui.Control

Focuses the current control.

Return value

getContainerElm

getContainerElm():Element

Returns the root element to render controls into.

Return value

getEl

getEl(suffix:String):Element

Returns the control DOM element or sub element.

Parameters
Return value

getParentCtrl

getParentCtrl(elm:Element):tinymce.ui.Control

Returns a control instance for the current DOM element.

Parameters
Return value

hasEventListeners

hasEventListeners(name:String):Boolean

Returns true/false if the specified event has any listeners.

Parameters
Return value

hide

hide():tinymce.ui.Control

Sets the visible state to false.

Return value

initLayoutRect

initLayoutRect():Object

Initializes the current controls layout rect. This will be executed by the layout managers to determine the default minWidth/minHeight etc.

Return value

innerHtml

innerHtml(html:String):tinymce.ui.Control

Sets the inner HTML of the control element.

Parameters
Return value

layoutRect

layoutRect(newRect:Object):tinymce.ui.Control, Object

Getter/setter for the current layout rect.

Parameters
Return value

name

name(value:String):String, tinymce.ui.Control

Sets/gets the name for the control.

Parameters
Return value

next

next():tinymce.ui.Control

Returns the control next to the current control.

Return value

off

off(name:String, callback:function):tinymce.ui.Control

Unbinds the specified event and optionally a specific callback. If you omit the name parameter all event handlers will be removed. If you omit the callback all event handles by the specified name will be removed.

Parameters
Return value

on

on(name:String, callback:String):tinymce.ui.Control

Binds a callback to the specified event. This event can both be native browser events like "click" or custom ones like PostRender. The callback function will be passed a DOM event like object that enables yout do stop propagation.

Parameters
Return value

parent

parent(parent:tinymce.ui.Container):tinymce.ui.Control

Sets/gets the parent container for the control.

Parameters
Return value

parents

parents(selector:String):tinymce.ui.Collection

Returns a control collection with all parent controls.

Parameters
Return value

parentsAndSelf

parentsAndSelf(selector:String):tinymce.ui.Collection

Returns the current control and it's parents.

Parameters
Return value

postRender

postRender()

Called after the control has been rendered.

prev

prev():tinymce.ui.Control

Returns the control previous to the current control.

Return value

reflow

reflow():tinymce.ui.Control

Reflows the current control and it's parents. This should be used after you for example append children to the current control so that the layout managers know that they need to reposition everything.

Examples
container.append({type: 'button', text: 'My button'}).reflow();
Return value

remove

remove():tinymce.ui.Control

Removes the current control from DOM and from UI collections.

Return value

renderBefore

renderBefore(elm:Element):tinymce.ui.Control

Renders the control to the specified element.

Parameters
Return value

renderHtml

renderHtml():String

Renders the control as a HTML string.

Return value

repaint

repaint()

Repaints the control after a layout operation.

scrollIntoView

scrollIntoView(align:String):tinymce.ui.Control

Scrolls the current control into view.

Parameters
Return value

show

show():tinymce.ui.Control

Sets the visible state to true.

Return value

text

text(value:String):String, tinymce.ui.Control

Sets/gets the text for the control.

Parameters
Return value

title

title(value:String):String, tinymce.ui.Control

Sets/gets the title for the control.

Parameters
Return value

tooltip

tooltip():tinymce.ui.Tooltip

Returns the current tooltip instance.

Return value

translate

translate(text:String):String

Returns the translated string.

Parameters
Return value

visible

visible(state:Boolean):Boolean, tinymce.ui.Control

Sets/gets the visible for the control.

Parameters
Return value

Can't find what you're looking for? Let us know.

Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.