Deprecated. The UI service was deprecated on December 11, 2014. To create user interfaces, use the HTML service instead.
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.
Deprecated methods
Deprecated methods
addBlurHandler(handler)
addBlurHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
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
s may
appear to happen simultaneously.
ServerHandler
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
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a
or a
. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
addChangeHandler(handler)
addChangeHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
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
s may
appear to happen simultaneously.
ServerHandler
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
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a
or a
. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
addClickHandler(handler)
addClickHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
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
s may
appear to happen simultaneously.
ServerHandler
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
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a
or a
. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
addFocusHandler(handler)
addFocusHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
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
s may
appear to happen simultaneously.
ServerHandler
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
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a
or a
. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
addKeyDownHandler(handler)
addKeyDownHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
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
s may
appear to happen simultaneously.
ServerHandler
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
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a
or a
. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
addKeyPressHandler(handler)
addKeyPressHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
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
s may
appear to happen simultaneously.
ServerHandler
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
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a
or a
. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
addKeyUpHandler(handler)
addKeyUpHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
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
s may
appear to happen simultaneously.
ServerHandler
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
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a
or a
. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
addMouseDownHandler(handler)
addMouseDownHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
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
s may
appear to happen simultaneously.
ServerHandler
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
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a
or a
. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
addMouseMoveHandler(handler)
addMouseMoveHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
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
s may
appear to happen simultaneously.
ServerHandler
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
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a
or a
. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
addMouseOutHandler(handler)
addMouseOutHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
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
s may
appear to happen simultaneously.
ServerHandler
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
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a
or a
. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
addMouseOverHandler(handler)
addMouseOverHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
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
s may
appear to happen simultaneously.
ServerHandler
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
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a
or a
. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
addMouseUpHandler(handler)
addMouseUpHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
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
s may
appear to happen simultaneously.
ServerHandler
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
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a
or a
. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
addMouseWheelHandler(handler)
addMouseWheelHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
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
s may
appear to happen simultaneously.
ServerHandler
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
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a
or a
. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
addStyleDependentName(styleName)
addStyleDependentName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
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
Name | Type | Description |
---|---|---|
styleName | String | the new style name. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
addStyleName(styleName)
addStyleName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
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
Name | Type | Description |
---|---|---|
styleName | String | the new style name. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
addValueChangeHandler(handler)
addValueChangeHandler(handler)
Deprecated. This function is deprecated and should not be used in new scripts.
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
s may
appear to happen simultaneously.
ServerHandler
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
Name | Type | Description |
---|---|---|
handler |
| the handler to execute when the event occurs. This can be a
or a
. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
getId()
getId()
Deprecated. This function is deprecated and should not be used in new scripts.
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()
getTag()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the text tag of this
.PasswordTextBox
Return
String
— the text tag.
getType()
getType()
Deprecated. This function is deprecated and should not be used in new scripts.
Gets the type of this object.
Return
String
— the object type
setAccessKey(accessKey)
setAccessKey(accessKey)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the widget's 'access key'. This key is used (in conjunction with a browser-specific modifier key) to automatically focus the widget.
Parameters
Name | Type | Description |
---|---|---|
accessKey | Char | the character to use for focus |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setCursorPos(position)
setCursorPos(position)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the cursor position inside this
.
PasswordTextBox
This will only work when the
is attached to the document and not
hidden.PasswordTextBox
Parameters
Name | Type | Description |
---|---|---|
position | Integer | the new cursor position, in characters from the start. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setDirection(direction)
setDirection(direction)
Deprecated. This function is deprecated and should not be used in new scripts.
Set the text direction.
Parameters
Name | Type | Description |
---|---|---|
direction |
| the text direction |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setEnabled(enabled)
setEnabled(enabled)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets whether the
is enabled.PasswordTextBox
Parameters
Name | Type | Description |
---|---|---|
enabled | Boolean | whether the should be enabled or disabled. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setFocus(focus)
setFocus(focus)
Deprecated. This function is deprecated and should not be used in new scripts.
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
Name | Type | Description |
---|---|---|
focus | Boolean | whether the should have the current focus. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setHeight(height)
setHeight(height)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the height of this
.PasswordTextBox
Parameters
Name | Type | Description |
---|---|---|
height | String | the new height in any CSS unit such as "10px" or "50%". |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setId(id)
setId(id)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the id of this
.PasswordTextBox
Parameters
Name | Type | Description |
---|---|---|
id | String | the new id, which can be used to retrieve the from
app.getElementById(id). |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setLayoutData(layout)
setLayoutData(layout)
Deprecated. This function is deprecated and should not be used in new scripts.
Set the layout for this
.
PasswordTextBox
This is not currently functional.
Parameters
Name | Type | Description |
---|---|---|
layout | Object |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setMaxLength(length)
setMaxLength(length)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the maximum allowable length of the text box's contents.
Parameters
Name | Type | Description |
---|---|---|
length | Integer | the maximum length. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setName(name)
setName(name)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the name of the
, which is how it will be referred to when used in a
FormPanel or as a callback element on an event handler.PasswordTextBox
Parameters
Name | Type | Description |
---|---|---|
name | String | the new name. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setPixelSize(width, height)
setPixelSize(width, height)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the size of this
in pixels.PasswordTextBox
Parameters
Name | Type | Description |
---|---|---|
width | Integer | the new width in pixels. |
height | Integer | the new height in pixels. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setReadOnly(readOnly)
setReadOnly(readOnly)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets whether the text in this
is read only and can't be edited.PasswordTextBox
Parameters
Name | Type | Description |
---|---|---|
readOnly | Boolean | whether the text is read only. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setSelectionRange(position, length)
setSelectionRange(position, length)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the range of text to be selected.
This will only work when the
is attached to the document and not
hidden.PasswordTextBox
Parameters
Name | Type | Description |
---|---|---|
position | Integer | the position of the first character to be selected |
length | Integer | the number of characters to be selected |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setSize(width, height)
setSize(width, height)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the size of this
.PasswordTextBox
Parameters
Name | Type | Description |
---|---|---|
width | String | the new width in any CSS unit such as "10px" or "50%". |
height | String | the new height in any CSS unit such as "10px" or "50%". |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setStyleAttribute(attribute, value)
setStyleAttribute(attribute, value)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets one of this
'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.
PasswordTextBox
// Change the widget's background to black and text color to green.
widget.setStyleAttribute("background", "black")
.setStyleAttribute("color", "green");
Parameters
Name | Type | Description |
---|---|---|
attribute | String | the CSS attribute, in camel-case ("fontSize", not "font-size"), as listed here |
value | String | the CSS value |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setStyleAttributes(attributes)
setStyleAttributes(attributes)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets this
'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.
PasswordTextBox
// Change the widget's background to black and text color to green.
widget.setStyleAttributes({background: "black", color: "green"});
Parameters
Name | Type | Description |
---|---|---|
attributes | Object | an object of key/value pairs for the CSS attributes and values to set; valid attributes are listed here |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setStyleName(styleName)
setStyleName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
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
Name | Type | Description |
---|---|---|
styleName | String | the new style name. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setStylePrimaryName(styleName)
setStylePrimaryName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
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
Name | Type | Description |
---|---|---|
styleName | String | the new style name. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setTabIndex(index)
setTabIndex(index)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the
's position in the tab index.
PasswordTextBox
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
Name | Type | Description |
---|---|---|
index | Integer | the new tab index. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setTag(tag)
setTag(tag)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the text tag of this
.PasswordTextBox
Parameters
Name | Type | Description |
---|---|---|
tag | String | the new text tag, which can be anything you wish to store with the widget. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setText(text)
setText(text)
Deprecated. This function is deprecated and should not be used in new scripts.
Set the display text of this
.PasswordTextBox
Parameters
Name | Type | Description |
---|---|---|
text | String | the new text. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setTextAlignment(textAlign)
setTextAlignment(textAlign)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the text alignment of this
.
PasswordTextBox
This is not currently functional.
Parameters
Name | Type | Description |
---|---|---|
textAlign |
| the alignment |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setTitle(title)
setTitle(title)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the hover title of this
.
PasswordTextBox
Not all browsers will show this.
Parameters
Name | Type | Description |
---|---|---|
title | String | the hover title. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setValue(value)
setValue(value)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets this
's value without firing any events.PasswordTextBox
Parameters
Name | Type | Description |
---|---|---|
value | String | the new value. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setValue(value, fireEvents)
setValue(value, fireEvents)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets this
's value and potentially fire events.PasswordTextBox
Parameters
Name | Type | Description |
---|---|---|
value | String | the new value. |
fireEvents | Boolean | whether to fire events. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setVisible(visible)
setVisible(visible)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets whether this
is visible.PasswordTextBox
Parameters
Name | Type | Description |
---|---|---|
visible | Boolean | whether this should be visible or not. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setVisibleLength(length)
setVisibleLength(length)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the number of visible characters in the text box.
This is not an exact value, as not all characters are created equal.
Parameters
Name | Type | Description |
---|---|---|
length | Integer | the length, in characters. |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox
setWidth(width)
setWidth(width)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the width of this
.PasswordTextBox
Parameters
Name | Type | Description |
---|---|---|
width | String | the new width in any CSS unit such as "10px" or "50%". |
Return
— the PasswordTextBox
itself, useful for chaining.PasswordTextBox