Google Apps Script

Class TextArea

A text box that allows multiple lines of text to be entered.

Here is an example of how to use this widget:

 
function doGet() {
   var app = UiApp.createApplication();
   var text = app.createTextArea().setName("text");
   var handler = app.createServerHandler("count").addCallbackElement(text);
   app.add(text);
   app.add(app.createButton("Count", handler));
   app.add(app.createLabel("0 characters").setId("label"));
   return app;
 }

 function count(eventInfo) {
   var app = UiApp.createApplication();
   // Because the text area was named "text" and added as a callback element to the
   // button's click event, we have its value available in eventInfo.parameter.text.
   app.getElementById("label").setText(eventInfo.parameter.text.length + " characters");
   return app;
 }
 

Internally, UiApp widgets are built on top of the Google Web Toolkit, and it can sometimes be helpful to look at the GWT documentation directly. You can find the TextArea documentation here.

Methods

MethodReturn typeBrief description
addBlurHandler(handler)TextAreaAdd a handler for blur events (losing keyboard focus).
addChangeHandler(handler)TextAreaAdd a handler for change events.
addClickHandler(handler)TextAreaAdd a handler for click events.
addFocusHandler(handler)TextAreaAdd a handler for focus events (gaining keyboard focus).
addKeyDownHandler(handler)TextAreaAdd a handler for key down events.
addKeyPressHandler(handler)TextAreaAdd a handler for key press events.
addKeyUpHandler(handler)TextAreaAdd a handler for key up events.
addMouseDownHandler(handler)TextAreaAdd a handler for mouse down events.
addMouseMoveHandler(handler)TextAreaAdd a handler for mouse move events.
addMouseOutHandler(handler)TextAreaAdd a handler for mouse out events.
addMouseOverHandler(handler)TextAreaAdd a handler for mouse move events.
addMouseUpHandler(handler)TextAreaAdd a handler for mouse up events.
addMouseWheelHandler(handler)TextAreaAdd a handler for mouse wheel events.
addStyleDependentName(styleName)TextAreaSets the dependent style name of this TextArea.
addStyleName(styleName)TextAreaAdds a style name to this TextArea.
addValueChangeHandler(handler)TextAreaAdd a handler for value change events.
getId()StringReturns the id that has been assigned to this object.
getTag()StringGets the text tag of this TextArea.
getType()StringGets the type of this object.
setCharacterWidth(width)TextAreaSets the requested width of the text box.
setCursorPos(position)TextAreaSets the cursor position inside this TextArea.
setEnabled(enabled)TextAreaSets whether the TextArea is enabled.
setFocus(focus)TextAreaExplicitly focus/unfocus this TextArea.
setHeight(height)TextAreaSets the height of this TextArea.
setId(id)TextAreaSets the id of this TextArea.
setName(name)TextAreaSets the name of the TextArea, which is how it will be referred to when used in a FormPanel or as a callback element on an event handler.
setPixelSize(width, height)TextAreaSets the size of this TextArea in pixels.
setReadOnly(readOnly)TextAreaSets whether the text in this TextArea is read only and can't be edited.
setSelectionRange(position, length)TextAreaSets the range of text to be selected.
setSize(width, height)TextAreaSets the size of this TextArea.
setStyleAttribute(attribute, value)TextAreaSets one of this TextArea's style attributes to a new value.
setStyleAttributes(attributes)TextAreaSets this TextArea's style attributes.
setStyleName(styleName)TextAreaSets the style name of this TextArea.
setStylePrimaryName(styleName)TextAreaSets the primary style name of this TextArea.
setTabIndex(index)TextAreaSets the TextArea's position in the tab index.
setTag(tag)TextAreaSets the text tag of this TextArea.
setText(text)TextAreaSet the display text of this TextArea.
setTitle(title)TextAreaSets the hover title of this TextArea.
setValue(value)TextAreaSets this TextArea's value without firing any events.
setValue(value, fireEvents)TextAreaSets this TextArea's value and potentially fire events.
setVisible(visible)TextAreaSets whether this TextArea is visible.
setVisibleLines(lines)TextAreaSets the number of text lines that are visible.
setWidth(width)TextAreaSets the width of this TextArea.

Detailed documentation

addBlurHandler(handler)

Add a handler for blur events (losing keyboard focus).

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 
function doGet() {
   var app = UiApp.createApplication();
   var button = app.createButton("a button");
   var handler = app.createServerHandler("handlerFunction");
   button.addBlurHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "blur".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
 }
 
In addition, the values of certain widgets can be sent up with the event as well, as "callback elements." See the documentation of ServerHandler for more information.

Parameters

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

TextArea — the TextArea itself, useful for chaining.


addChangeHandler(handler)

Add a handler for change events.

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 
function doGet() {
   var app = UiApp.createApplication();
   var textBox = app.createTextBox();
   var handler = app.createServerHandler("handlerFunction");
   textBox.addChangeHandler(handler);
   app.add(textBox);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "change".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
 }
 
In addition, the values of certain widgets can be sent up with the event as well, as "callback elements." See the documentation of ServerHandler for more information.

Parameters

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

TextArea — the TextArea itself, useful for chaining.


addClickHandler(handler)

Add a handler for click events.

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 
function doGet() {
   var app = UiApp.createApplication();
   var button = app.createButton("a button");
   var handler = app.createServerHandler("handlerFunction");
   button.addClickHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "click".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // mouse x and y position relative to the widget that fired the event.
   var x = parameter.x;
   var y = parameter.y;
   // mouse x and y position within the browser window's client area.
   var clientX = parameter.clientX;
   var clientY = parameter.clientY;
   // mouse x and y position within the user's display.
   var screenX = parameter.screenX;
   var screenY = parameter.screenY;
   // the mouse button used. Left is 1, right is 2, and middle is 4.
   var button = parameter.button;
   // whether the various modifier keys were also pressed (true or false)
   var shift = parameter.shift;
   var alt = parameter.alt;
   var ctrl = parameter.ctrl;
   var meta = parameter.meta;
 }
 
In addition, the values of certain widgets can be sent up with the event as well, as "callback elements." See the documentation of ServerHandler for more information.

Parameters

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

TextArea — the TextArea itself, useful for chaining.


addFocusHandler(handler)

Add a handler for focus events (gaining keyboard focus).

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 
function doGet() {
   var app = UiApp.createApplication();
   var button = app.createButton("a button");
   var handler = app.createServerHandler("handlerFunction");
   button.addFocusHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "focus".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
 }
 
In addition, the values of certain widgets can be sent up with the event as well, as "callback elements." See the documentation of ServerHandler for more information.

Parameters

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

TextArea — the TextArea itself, useful for chaining.


addKeyDownHandler(handler)

Add a handler for key down events.

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 
function doGet() {
   var app = UiApp.createApplication();
   var button = app.createButton("a button");
   var handler = app.createServerHandler("handlerFunction");
   button.addKeyDownHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "keydown".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // what key was pressed. See below for a link explaining what these values mean.
   var charCode = parameter.charCode;
   var keyCode = parameter.keyCode;
   // whether the various modifier keys were also pressed (true or false)
   var shift = parameter.shift;
   var alt = parameter.alt;
   var ctrl = parameter.ctrl;
   var meta = parameter.meta;
 }
 
In addition, the values of certain widgets can be sent up with the event as well, as "callback elements." See the documentation of ServerHandler for more information. For an explanation of charCode and keyCode, including what to expect on different browsers, look here.

Parameters

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

TextArea — the TextArea itself, useful for chaining.


addKeyPressHandler(handler)

Add a handler for key press events.

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 
function doGet() {
   var app = UiApp.createApplication();
   var button = app.createButton("a button");
   var handler = app.createServerHandler("handlerFunction");
   button.addKeyPressHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "keypress".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // what key was pressed. See below for a link explaining what these values mean.
   var charCode = parameter.charCode;
   var keyCode = parameter.keyCode;
   // whether the various modifier keys were also pressed (true or false)
   var shift = parameter.shift;
   var alt = parameter.alt;
   var ctrl = parameter.ctrl;
   var meta = parameter.meta;
 }
 
In addition, the values of certain widgets can be sent up with the event as well, as "callback elements." See the documentation of ServerHandler for more information. For an explanation of charCode and keyCode, including what to expect on different browsers, look here.

Parameters

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

TextArea — the TextArea itself, useful for chaining.


addKeyUpHandler(handler)

Add a handler for key up events.

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 
function doGet() {
   var app = UiApp.createApplication();
   var button = app.createButton("a button");
   var handler = app.createServerHandler("handlerFunction");
   button.addKeyUpHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "keyup".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // what key was pressed. See below for a link explaining what these values mean.
   var charCode = parameter.charCode;
   var keyCode = parameter.keyCode;
   // whether the various modifier keys were also pressed (true or false)
   var shift = parameter.shift;
   var alt = parameter.alt;
   var ctrl = parameter.ctrl;
   var meta = parameter.meta;
 }
 
In addition, the values of certain widgets can be sent up with the event as well, as "callback elements." See the documentation of ServerHandler for more information. For an explanation of charCode and keyCode, including what to expect on different browsers, look here.

Parameters

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

TextArea — the TextArea itself, useful for chaining.


addMouseDownHandler(handler)

Add a handler for mouse down events.

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 
function doGet() {
   var app = UiApp.createApplication();
   var button = app.createButton("a button");
   var handler = app.createServerHandler("handlerFunction");
   button.addMouseDownHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "mousedown".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // mouse x and y position relative to the widget that fired the event.
   var x = parameter.x;
   var y = parameter.y;
   // mouse x and y position within the browser window's client area.
   var clientX = parameter.clientX;
   var clientY = parameter.clientY;
   // mouse x and y position within the user's display.
   var screenX = parameter.screenX;
   var screenY = parameter.screenY;
   // the mouse button used. Left is 1, right is 2, and middle is 4.
   var button = parameter.button;
   // whether the various modifier keys were also pressed (true or false)
   var shift = parameter.shift;
   var alt = parameter.alt;
   var ctrl = parameter.ctrl;
   var meta = parameter.meta;
 }
 
In addition, the values of certain widgets can be sent up with the event as well, as "callback elements." See the documentation of ServerHandler for more information.

Parameters

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

TextArea — the TextArea itself, useful for chaining.


addMouseMoveHandler(handler)

Add a handler for mouse move events.

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 
function doGet() {
   var app = UiApp.createApplication();
   var button = app.createButton("a button");
   var handler = app.createServerHandler("handlerFunction");
   button.addMouseMoveHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "mousemove".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // mouse x and y position relative to the widget that fired the event.
   var x = parameter.x;
   var y = parameter.y;
   // mouse x and y position within the browser window's client area.
   var clientX = parameter.clientX;
   var clientY = parameter.clientY;
   // mouse x and y position within the user's display.
   var screenX = parameter.screenX;
   var screenY = parameter.screenY;
   // the mouse button used. Left is 1, right is 2, and middle is 4.
   var button = parameter.button;
   // whether the various modifier keys were also pressed (true or false)
   var shift = parameter.shift;
   var alt = parameter.alt;
   var ctrl = parameter.ctrl;
   var meta = parameter.meta;
 }
 
In addition, the values of certain widgets can be sent up with the event as well, as "callback elements." See the documentation of ServerHandler for more information.

Parameters

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

TextArea — the TextArea itself, useful for chaining.


addMouseOutHandler(handler)

Add a handler for mouse out events.

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 
function doGet() {
   var app = UiApp.createApplication();
   var button = app.createButton("a button");
   var handler = app.createServerHandler("handlerFunction");
   button.addMouseOutHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "mouseout".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // mouse x and y position relative to the widget that fired the event.
   var x = parameter.x;
   var y = parameter.y;
   // mouse x and y position within the browser window's client area.
   var clientX = parameter.clientX;
   var clientY = parameter.clientY;
   // mouse x and y position within the user's display.
   var screenX = parameter.screenX;
   var screenY = parameter.screenY;
   // the mouse button used. Left is 1, right is 2, and middle is 4.
   var button = parameter.button;
   // whether the various modifier keys were also pressed (true or false)
   var shift = parameter.shift;
   var alt = parameter.alt;
   var ctrl = parameter.ctrl;
   var meta = parameter.meta;
 }
 
In addition, the values of certain widgets can be sent up with the event as well, as "callback elements." See the documentation of ServerHandler for more information.

Parameters

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

TextArea — the TextArea itself, useful for chaining.


addMouseOverHandler(handler)

Add a handler for mouse move events.

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 
function doGet() {
   var app = UiApp.createApplication();
   var button = app.createButton("a button");
   var handler = app.createServerHandler("handlerFunction");
   button.addMouseOverHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "mousover".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // mouse x and y position relative to the widget that fired the event.
   var x = parameter.x;
   var y = parameter.y;
   // mouse x and y position within the browser window's client area.
   var clientX = parameter.clientX;
   var clientY = parameter.clientY;
   // mouse x and y position within the user's display.
   var screenX = parameter.screenX;
   var screenY = parameter.screenY;
   // the mouse button used. Left is 1, right is 2, and middle is 4.
   var button = parameter.button;
   // whether the various modifier keys were also pressed (true or false)
   var shift = parameter.shift;
   var alt = parameter.alt;
   var ctrl = parameter.ctrl;
   var meta = parameter.meta;
 }
 
In addition, the values of certain widgets can be sent up with the event as well, as "callback elements." See the documentation of ServerHandler for more information.

Parameters

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

TextArea — the TextArea itself, useful for chaining.


addMouseUpHandler(handler)

Add a handler for mouse up events.

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 
function doGet() {
   var app = UiApp.createApplication();
   var button = app.createButton("a button");
   var handler = app.createServerHandler("handlerFunction");
   button.addMouseUpHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "mouseup".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // mouse x and y position relative to the widget that fired the event.
   var x = parameter.x;
   var y = parameter.y;
   // mouse x and y position within the browser window's client area.
   var clientX = parameter.clientX;
   var clientY = parameter.clientY;
   // mouse x and y position within the user's display.
   var screenX = parameter.screenX;
   var screenY = parameter.screenY;
   // the mouse button used. Left is 1, right is 2, and middle is 4.
   var button = parameter.button;
   // whether the various modifier keys were also pressed (true or false)
   var shift = parameter.shift;
   var alt = parameter.alt;
   var ctrl = parameter.ctrl;
   var meta = parameter.meta;
 }
 
In addition, the values of certain widgets can be sent up with the event as well, as "callback elements." See the documentation of ServerHandler for more information.

Parameters

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

TextArea — the TextArea itself, useful for chaining.


addMouseWheelHandler(handler)

Add a handler for mouse wheel events.

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 
function doGet() {
   var app = UiApp.createApplication();
   var button = app.createButton("a button");
   var handler = app.createServerHandler("handlerFunction");
   button.addMouseWheelHandler(handler);
   app.add(button);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "mousewheel".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
   // mouse x and y position relative to the widget that fired the event.
   var x = parameter.x;
   var y = parameter.y;
   // mouse x and y position within the browser window's client area.
   var clientX = parameter.clientX;
   var clientY = parameter.clientY;
   // mouse x and y position within the user's display.
   var screenX = parameter.screenX;
   var screenY = parameter.screenY;
   // the mouse button used. Left is 1, right is 2, and middle is 4.
   var button = parameter.button;
   // whether the various modifier keys were also pressed (true or false)
   var shift = parameter.shift;
   var alt = parameter.alt;
   var ctrl = parameter.ctrl;
   var meta = parameter.meta;
 }
 
In addition, the values of certain widgets can be sent up with the event as well, as "callback elements." See the documentation of ServerHandler for more information.

Parameters

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

TextArea — the TextArea itself, useful for chaining.


addStyleDependentName(styleName)

Sets the dependent style name of this TextArea.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

NameTypeDescription
styleNameStringthe new style name.

Return

TextArea — the TextArea itself, useful for chaining.


addStyleName(styleName)

Adds a style name to this TextArea.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

NameTypeDescription
styleNameStringthe new style name.

Return

TextArea — the TextArea itself, useful for chaining.


addValueChangeHandler(handler)

Add a handler for value change events.

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 
function doGet() {
   var app = UiApp.createApplication();
   var textBox = app.createTextBox();
   var handler = app.createServerHandler("handlerFunction");
   textBox.addValueChangeHandler(handler);
   app.add(textBox);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "valueChange".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
 }
 
In addition, the values of certain widgets can be sent up with the event as well as "callback elements." See the documentation of ServerHandler for more information.

Parameters

NameTypeDescription
handlerHandlerthe handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

TextArea — the TextArea itself, useful for chaining.


getId()

Returns the id that has been assigned to this object.

This can be used in conjunction with app.getElementById() to retrieve a reference to this object.

Return

String — the id that has been assigned to this object


getTag()

Gets the text tag of this TextArea.

Return

String — the text tag.


getType()

Gets the type of this object.

Return

String — the object type


setCharacterWidth(width)

Sets the requested width of the text box.

This is not an exact value, as not all characters are created equal.

Parameters

NameTypeDescription
widthIntegerthe width, in characters.

Return

TextArea — the TextArea itself, useful for chaining.


setCursorPos(position)

Sets the cursor position inside this TextArea.

This will only work when the TextArea is attached to the document and not hidden.

Parameters

NameTypeDescription
positionIntegerthe new cursor position, in characters from the start.

Return

TextArea — the TextArea itself, useful for chaining.


setEnabled(enabled)

Sets whether the TextArea is enabled.

Parameters

NameTypeDescription
enabledBooleanwhether the TextArea should be enabled or disabled.

Return

TextArea — the TextArea itself, useful for chaining.


setFocus(focus)

Explicitly focus/unfocus this TextArea.

Only one widget can have focus at a time, and the widget that does will receive all keyboard events.

Parameters

NameTypeDescription
focusBooleanwhether the TextArea should have the current focus.

Return

TextArea — the TextArea itself, useful for chaining.


setHeight(height)

Sets the height of this TextArea.

Parameters

NameTypeDescription
heightStringthe new height in any CSS unit such as "10px" or "50%".

Return

TextArea — the TextArea itself, useful for chaining.


setId(id)

Sets the id of this TextArea.

Parameters

NameTypeDescription
idStringthe new id, which can be used to retrieve the TextArea from app.getElementById(id).

Return

TextArea — the TextArea itself, useful for chaining.


setName(name)

Sets the name of the TextArea, which is how it will be referred to when used in a FormPanel or as a callback element on an event handler.

Parameters

NameTypeDescription
nameStringthe new name.

Return

TextArea — the TextArea itself, useful for chaining.


setPixelSize(width, height)

Sets the size of this TextArea in pixels.

Parameters

NameTypeDescription
widthIntegerthe new width in pixels.
heightIntegerthe new height in pixels.

Return

TextArea — the TextArea itself, useful for chaining.


setReadOnly(readOnly)

Sets whether the text in this TextArea is read only and can't be edited.

Parameters

NameTypeDescription
readOnlyBooleanwhether the text is read only.

Return

TextArea — the TextArea itself, useful for chaining.


setSelectionRange(position, length)

Sets the range of text to be selected.

This will only work when the TextArea is attached to the document and not hidden.

Parameters

NameTypeDescription
positionIntegerthe position of the first character to be selected
lengthIntegerthe number of characters to be selected

Return

TextArea — the TextArea itself, useful for chaining.


setSize(width, height)

Sets the size of this TextArea.

Parameters

NameTypeDescription
widthStringthe new width in any CSS unit such as "10px" or "50%".
heightStringthe new height in any CSS unit such as "10px" or "50%".

Return

TextArea — the TextArea itself, useful for chaining.


setStyleAttribute(attribute, value)

Sets one of this TextArea's style attributes to a new value. Valid attributes are listed here; the values for each attribute are the same as those available in CSS style sheets.

 
// Change the widget's background to black and text color to green.
 widget.setStyleAttribute("background", "black")
     .setStyleAttribute("color", "green");
 

Parameters

NameTypeDescription
attributeStringthe CSS attribute, in camel-case ("fontSize", not "font-size"), as listed here
valueStringthe CSS value

Return

TextArea — the TextArea itself, useful for chaining.


setStyleAttributes(attributes)

Sets this TextArea's style attributes. This is a convenience method that is equivalent to calling setStyleAttribute with every key/value pair in the attributes object. Valid attributes are listed here; the values for each attribute are the same as those available in CSS style sheets.

 
// Change the widget's background to black and text color to green.
 widget.setStyleAttributes({background: "black", color: "green"});
 

Parameters

NameTypeDescription
attributesObjectan object of key/value pairs for the CSS attributes and values to set; valid attributes are listed here

Return

TextArea — the TextArea itself, useful for chaining.


setStyleName(styleName)

Sets the style name of this TextArea.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

NameTypeDescription
styleNameStringthe new style name.

Return

TextArea — the TextArea itself, useful for chaining.


setStylePrimaryName(styleName)

Sets the primary style name of this TextArea.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

NameTypeDescription
styleNameStringthe new style name.

Return

TextArea — the TextArea itself, useful for chaining.


setTabIndex(index)

Sets the TextArea's position in the tab index.

If more than one widget has the same tab index, each such widget will receive focus in an arbitrary order. Setting the tab index to -1 will cause this widget to be removed from the tab order.

Parameters

NameTypeDescription
indexIntegerthe new tab index.

Return

TextArea — the TextArea itself, useful for chaining.


setTag(tag)

Sets the text tag of this TextArea.

Parameters

NameTypeDescription
tagStringthe new text tag, which can be anything you wish to store with the widget.

Return

TextArea — the TextArea itself, useful for chaining.


setText(text)

Set the display text of this TextArea.

Parameters

NameTypeDescription
textStringthe new text.

Return

TextArea — the TextArea itself, useful for chaining.


setTitle(title)

Sets the hover title of this TextArea.

Not all browsers will show this.

Parameters

NameTypeDescription
titleStringthe hover title.

Return

TextArea — the TextArea itself, useful for chaining.


setValue(value)

Sets this TextArea's value without firing any events.

Parameters

NameTypeDescription
valueStringthe new value.

Return

TextArea — the TextArea itself, useful for chaining.


setValue(value, fireEvents)

Sets this TextArea's value and potentially fire events.

Parameters

NameTypeDescription
valueStringthe new value.
fireEventsBooleanwhether to fire events.

Return

TextArea — the TextArea itself, useful for chaining.


setVisible(visible)

Sets whether this TextArea is visible.

Parameters

NameTypeDescription
visibleBooleanwhether this TextArea should be visible or not.

Return

TextArea — the TextArea itself, useful for chaining.


setVisibleLines(lines)

Sets the number of text lines that are visible.

Parameters

NameTypeDescription
linesIntegerthe number of visible lines.

Return

TextArea — the TextArea itself, useful for chaining.


setWidth(width)

Sets the width of this TextArea.

Parameters

NameTypeDescription
widthStringthe new width in any CSS unit such as "10px" or "50%".

Return

TextArea — the TextArea itself, useful for chaining.

Deprecated methods




Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.