TextBox

TextBox

Creates a static box for multiline text. Accepts HTML text.

Constructor

# new TextBox(parent, x, y, text)

Constructor
Parameters:
Name Type Description
parent HTMLElement The element to add this text box to.
x number The x position of the text box. Default 0.
y number The y position of the text box. Default 0.
text string The initial text to display in the text box. Default empty string.
Source:
Example 
const panel = new Panel(document.body, 20, 20, 200, 200);
new TextBox(panel, 20, 20, "Hello");

Extends

Classes

TextBox

Members

# align

Gets and sets the horizontal alignment of the text in the text box (left, right, center).
Source:

# bold

Gets and sets whether or not the text will be bold.
Source:

# color

Gets and sets the color of the text.
Source:

# enabled

Sets and gets whether or not this component is enabled. Non-enabled components will be faded out and not respond to events.
Overrides:
Source:

# fontSize

Gets and sets the size of the text.
Source:

# height

Sets and gets the height of this component.
Overrides:
Source:

# html

Gets and sets a string of HTML text to display. This will accept pretty much any kind of valid HTML markup you can put into a string.
Source:

# italic

Gets and sets whether or not the text will be italicized.
Source:

# text

Gets and sets the plain text to be displayed. Compare with the htmlText property.
Source:

# width

Sets and gets the width of this component.
Overrides:
Source:

# x

Sets and gets the x position of this component.
Overrides:
Source:

# y

Sets and gets the y position of this component.
Overrides:
Source:

Methods

# getAlign()

Source:
Returns:
the alignment of the text.

# getBold()

Source:
Returns:
whether or not the text will be bold.

# getColor()

Source:
Returns:
the color of the text.

# getEnabled()

Gets whether the component is enabled.
Overrides:
Source:
Returns:
Whether or not the component is enabled.

# getFontSize()

Source:
Returns:
the font size of th text.

# getHeight()

Gets the height of the component.
Overrides:
Source:
Returns:
The height of the component.

# getHtml()

Source:
Returns:
the html text in the textbox (if any).

# getItalic()

Source:
Returns:
whether the text will be italic.

# getText()

Source:
Returns:
the text in the textbox.

# getWidth()

Gets the width of the component.
Overrides:
Source:
Returns:
The width of the component.

# getX()

Gets the x position of the component.
Overrides:
Source:
Returns:
The x position of the component.

# getY()

Gets the y position of the component.
Overrides:
Source:
Returns:
The y position of the component.

# move(x, y)

Moves the component to a specified position.
Parameters:
Name Type Description
x number The new x position of the component.
y number The new y position of the component.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# rotate(rad)

Rotates the component.
Parameters:
Name Type Description
rad number The number of radians to rotate the component by.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# rotateDeg(deg)

Rotates the component.
Parameters:
Name Type Description
deg number The number of degrees to rotate the component by.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# setAlign(align)

Sets the alignment of the text box's text - "left" (default), "right" or "center".
Parameters:
Name Type Description
align string The alignment of the text.
Source:
Returns:
This instance, suitable for chaining.

# setBold(bold)

Sets wheter or not the text will be bold.
Parameters:
Name Type Description
bold boolean Whether or not the text will be bold.
Source:
Returns:
This instance, suitable for chaining.

# setColor(color)

Sets the color of the text.
Parameters:
Name Type Description
color string The color of the text.
Source:
Returns:
This instance, suitable for chaining.

# setEnabled(enabled)

Sets the enabled state of this component.
Parameters:
Name Type Description
enabled boolean Whether or not the component will be enabled.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# setFontSize(fontSize)

Sets the font size of the text.
Parameters:
Name Type Description
fontSize number The font size of the text.
Source:
Returns:
This instance, suitable for chaining.

# setHeight(height)

Sets the height of this component.
Parameters:
Name Type Description
height number The height of this component.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# setHtml(html)

Sets a string of HTML text to display. This will accept pretty much any kind of valid HTML markup you can put into a string.
Parameters:
Name Type Description
html string The HTML to set.
Source:
Returns:
This instance, suitable for chaining.

# setItalic(italics)

Sets whether or not the text will be italicized.
Parameters:
Name Type Description
italics boolean Whether or not the text will be italicized.
Source:
Returns:
This instance, suitable for chaining.

# setSize(w, h)

Sizes the component.
Parameters:
Name Type Description
w number The new width of the component.
h number The new height of the component.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# setText(text)

Sets the text box's text.
Parameters:
Name Type Description
text string The text of the text box.
Source:
Returns:
This instance, suitable for chaining.

# setWidth(width)

Sets the width of this component.
Parameters:
Name Type Description
width number The width of this component.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# setX(x)

Sets the x position of this component.
Parameters:
Name Type Description
x number The x position of this component.
Overrides:
Source:
Returns:
This instance, suitable for chaining.

# setY(y)

Sets the y position of this component.
Parameters:
Name Type Description
y number The y position of this component.
Overrides:
Source:
Returns:
this instance, suitable for chaining.