Google Apps Script

Class PasswordTextBox

A text box that visually masks its input to prevent eavesdropping.

Here is an example of how to use this widget:

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

 function test(eventInfo) {
   var app = UiApp.createApplication();
   // Because the text box was named "text" and added as a callback element to the
   // button's click event, we have its value available in eventInfo.parameter.text.
   var pass = eventInfo.parameter.text;
   var isStrong =
       pass.length >= 10 && /[A-Z]/.test(pass) && /[a-z]/.test(pass) && /[0-9]/.test(pass);
   var label = app.getElementById("label");
   if (isStrong) {
     label.setText("Strong! Well, not really, but this is just an example.")
         .setStyleAttribute("color", "green");
   } else {
     label.setText("Weak! Use at least 10 characters, with uppercase, lowercase, and digits")
         .setStyleAttribute("color", "red");
   }
   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 PasswordTextBox documentation here.

Methods

MethodReturn typeBrief description
addBlurHandler(handler)PasswordTextBoxAdd a handler for blur events (losing keyboard focus).
addChangeHandler(handler)PasswordTextBoxAdd a handler for change events.
addClickHandler(handler)PasswordTextBoxAdd a handler for click events.
addFocusHandler(handler)PasswordTextBoxAdd a handler for focus events (gaining keyboard focus).
addKeyDownHandler(handler)PasswordTextBoxAdd a handler for key down events.
addKeyPressHandler(handler)PasswordTextBoxAdd a handler for key press events.
addKeyUpHandler(handler)PasswordTextBoxAdd a handler for key up events.
addMouseDownHandler(handler)PasswordTextBoxAdd a handler for mouse down events.
addMouseMoveHandler(handler)PasswordTextBoxAdd a handler for mouse move events.
addMouseOutHandler(handler)PasswordTextBoxAdd a handler for mouse out events.
addMouseOverHandler(handler)PasswordTextBoxAdd a handler for mouse move events.
addMouseUpHandler(handler)PasswordTextBoxAdd a handler for mouse up events.
addMouseWheelHandler(handler)PasswordTextBoxAdd a handler for mouse wheel events.
addStyleDependentName(styleName)PasswordTextBoxSets the dependent style name of this PasswordTextBox.
addStyleName(styleName)PasswordTextBoxAdds a style name to this PasswordTextBox.
addValueChangeHandler(handler)PasswordTextBoxAdd a handler for value change events.
getId()StringReturns the id that has been assigned to this object.
getTag()StringGets the text tag of this PasswordTextBox.
getType()StringGets the type of this object.
setCursorPos(position)PasswordTextBoxSets the cursor position inside this PasswordTextBox.
setEnabled(enabled)PasswordTextBoxSets whether the PasswordTextBox is enabled.
setFocus(focus)PasswordTextBoxExplicitly focus/unfocus this PasswordTextBox.
setHeight(height)PasswordTextBoxSets the height of this PasswordTextBox.
setId(id)PasswordTextBoxSets the id of this PasswordTextBox.
setMaxLength(length)PasswordTextBoxSets the maximum allowable length of the text box's contents.
setName(name)PasswordTextBoxSets the name of the PasswordTextBox, 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)PasswordTextBoxSets the size of this PasswordTextBox in pixels.
setReadOnly(readOnly)PasswordTextBoxSets whether the text in this PasswordTextBox is read only and can't be edited.
setSelectionRange(position, length)PasswordTextBoxSets the range of text to be selected.
setSize(width, height)PasswordTextBoxSets the size of this PasswordTextBox.
setStyleAttribute(attribute, value)PasswordTextBoxSets one of this PasswordTextBox's style attributes to a new value.
setStyleAttributes(attributes)PasswordTextBoxSets this PasswordTextBox's style attributes.
setStyleName(styleName)PasswordTextBoxSets the style name of this PasswordTextBox.
setStylePrimaryName(styleName)PasswordTextBoxSets the primary style name of this PasswordTextBox.
setTabIndex(index)PasswordTextBoxSets the PasswordTextBox's position in the tab index.
setTag(tag)PasswordTextBoxSets the text tag of this PasswordTextBox.
setText(text)PasswordTextBoxSet the display text of this PasswordTextBox.
setTitle(title)PasswordTextBoxSets the hover title of this PasswordTextBox.
setValue(value)PasswordTextBoxSets this PasswordTextBox's value without firing any events.
setValue(value, fireEvents)PasswordTextBoxSets this PasswordTextBox's value and potentially fire events.
setVisible(visible)PasswordTextBoxSets whether this PasswordTextBox is visible.
setVisibleLength(length)PasswordTextBoxSets the number of visible characters in the text box.
setWidth(width)PasswordTextBoxSets the width of this PasswordTextBox.

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

PasswordTextBox — the PasswordTextBox 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

PasswordTextBox — the PasswordTextBox 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

PasswordTextBox — the PasswordTextBox 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

PasswordTextBox — the PasswordTextBox 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

PasswordTextBox — the PasswordTextBox 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

PasswordTextBox — the PasswordTextBox 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

PasswordTextBox — the PasswordTextBox 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

PasswordTextBox — the PasswordTextBox 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

PasswordTextBox — the PasswordTextBox 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

PasswordTextBox — the PasswordTextBox 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

PasswordTextBox — the PasswordTextBox 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

PasswordTextBox — the PasswordTextBox 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

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


addStyleDependentName(styleName)

Sets the dependent style name of this PasswordTextBox.

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

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


addStyleName(styleName)

Adds a style name to this PasswordTextBox.

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

PasswordTextBox — the PasswordTextBox 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

PasswordTextBox — the PasswordTextBox 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 PasswordTextBox.

Return

String — the text tag.


getType()

Gets the type of this object.

Return

String — the object type


setCursorPos(position)

Sets the cursor position inside this PasswordTextBox.

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

Parameters

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

Return

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setEnabled(enabled)

Sets whether the PasswordTextBox is enabled.

Parameters

NameTypeDescription
enabledBooleanwhether the PasswordTextBox should be enabled or disabled.

Return

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setFocus(focus)

Explicitly focus/unfocus this PasswordTextBox.

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

Parameters

NameTypeDescription
focusBooleanwhether the PasswordTextBox should have the current focus.

Return

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setHeight(height)

Sets the height of this PasswordTextBox.

Parameters

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

Return

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setId(id)

Sets the id of this PasswordTextBox.

Parameters

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

Return

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setMaxLength(length)

Sets the maximum allowable length of the text box's contents.

Parameters

NameTypeDescription
lengthIntegerthe maximum length.

Return

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setName(name)

Sets the name of the PasswordTextBox, 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

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setPixelSize(width, height)

Sets the size of this PasswordTextBox in pixels.

Parameters

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

Return

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setReadOnly(readOnly)

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

Parameters

NameTypeDescription
readOnlyBooleanwhether the text is read only.

Return

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setSelectionRange(position, length)

Sets the range of text to be selected.

This will only work when the PasswordTextBox 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

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setSize(width, height)

Sets the size of this PasswordTextBox.

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

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setStyleAttribute(attribute, value)

Sets one of this PasswordTextBox'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

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setStyleAttributes(attributes)

Sets this PasswordTextBox'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

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setStyleName(styleName)

Sets the style name of this PasswordTextBox.

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

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setStylePrimaryName(styleName)

Sets the primary style name of this PasswordTextBox.

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

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setTabIndex(index)

Sets the PasswordTextBox'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

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setTag(tag)

Sets the text tag of this PasswordTextBox.

Parameters

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

Return

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setText(text)

Set the display text of this PasswordTextBox.

Parameters

NameTypeDescription
textStringthe new text.

Return

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setTitle(title)

Sets the hover title of this PasswordTextBox.

Not all browsers will show this.

Parameters

NameTypeDescription
titleStringthe hover title.

Return

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setValue(value)

Sets this PasswordTextBox's value without firing any events.

Parameters

NameTypeDescription
valueStringthe new value.

Return

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setValue(value, fireEvents)

Sets this PasswordTextBox's value and potentially fire events.

Parameters

NameTypeDescription
valueStringthe new value.
fireEventsBooleanwhether to fire events.

Return

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setVisible(visible)

Sets whether this PasswordTextBox is visible.

Parameters

NameTypeDescription
visibleBooleanwhether this PasswordTextBox should be visible or not.

Return

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setVisibleLength(length)

Sets the number of visible characters in the text box.

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

Parameters

NameTypeDescription
lengthIntegerthe length, in characters.

Return

PasswordTextBox — the PasswordTextBox itself, useful for chaining.


setWidth(width)

Sets the width of this PasswordTextBox.

Parameters

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

Return

PasswordTextBox — the PasswordTextBox 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.