Deprecated. The UI service was deprecated on December 11, 2014. To create user interfaces, use the HTML service instead.
A standard check box widget.
Here is an example of how to use this widget:
function doGet() {
var app = UiApp.createApplication();
var handler = app.createServerHandler("change");
var check = app.createCheckBox("click me").addValueChangeHandler(handler);
app.add(check);
return app;
}
function change() {
var app = UiApp.getActiveApplication();
app.add(app.createLabel("The value changed!"));
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 CheckBox documentation here.
Deprecated methods
Method | Return type | Brief description |
---|---|---|
|
| Add a handler for blur events (losing keyboard focus). |
|
| Add a handler for click events. |
|
| Add a handler for focus events (gaining keyboard focus). |
|
| Add a handler for key down events. |
|
| Add a handler for key press events. |
|
| Add a handler for key up events. |
|
| Add a handler for mouse down events. |
|
| Add a handler for mouse move events. |
|
| Add a handler for mouse out events. |
|
| Add a handler for mouse move events. |
|
| Add a handler for mouse up events. |
|
| Add a handler for mouse wheel events. |
|
| Sets the dependent style name of this . |
|
| Adds a style name to this . |
|
| Add a handler for value change events. |
| String | Returns the id that has been assigned to this object. |
| String | Gets the text tag of this . |
| String | Gets the type of this object. |
|
| Sets the widget's 'access key'. |
|
| Sets whether the is enabled. |
|
| Explicitly focus/unfocus this . |
|
| Set the value property on the input element that backs this . |
|
| Sets the HTML content of this . |
|
| Sets the height of this . |
|
| Sets the id of this . |
|
| Set the layout for this . |
|
| 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. |
|
| Sets the size of this in pixels. |
|
| Sets the size of this . |
|
| Sets one of this 's style attributes to a new value. |
|
| Sets this 's style attributes. |
|
| Sets the style name of this . |
|
| Sets the primary style name of this . |
|
| Sets the 's position in the tab index. |
|
| Sets the text tag of this . |
|
| Set the display text of this . |
|
| Sets the hover title of this . |
|
| Sets whether the should be checked. |
|
| Sets whether the should be checked and optionally fires an event if the
value changes as a result of this call. |
|
| Sets whether this is visible. |
|
| Sets the width of this . |
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
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
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
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
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
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
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
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
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
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
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
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
addStyleDependentName(styleName)
addStyleDependentName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the dependent style name of this
.
CheckBox
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
addStyleName(styleName)
addStyleName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
Adds a style name to this
.
CheckBox
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
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
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
.CheckBox
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
setEnabled(enabled)
setEnabled(enabled)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets whether the
is enabled.CheckBox
Parameters
Name | Type | Description |
---|---|---|
enabled | Boolean | whether the should be enabled or disabled. |
Return
setFocus(focus)
setFocus(focus)
Deprecated. This function is deprecated and should not be used in new scripts.
Explicitly focus/unfocus this
.
CheckBox
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
setFormValue(formValue)
setFormValue(formValue)
Deprecated. This function is deprecated and should not be used in new scripts.
Set the value property on the input element that backs this
. This is the
value that will be associated with the CheckBox's name and submitted to the server if a
FormPanel that holds it is submitted and the box is checked.CheckBox
Parameters
Name | Type | Description |
---|---|---|
formValue | String | the new form value. |
Return
setHTML(html)
setHTML(html)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the HTML content of this
.CheckBox
Parameters
Name | Type | Description |
---|---|---|
html | String | the new HTML |
Return
setHeight(height)
setHeight(height)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the height of this
. The specified height may not take effect unless
the element's CSS CheckBoxdisplay
property is set to inline-block
.
Parameters
Name | Type | Description |
---|---|---|
height | String | the new height in any CSS unit such as "10px" or "50%". |
Return
setId(id)
setId(id)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the id of this
.CheckBox
Parameters
Name | Type | Description |
---|---|---|
id | String | the new id, which can be used to retrieve the from
app.getElementById(id). |
Return
setLayoutData(layout)
setLayoutData(layout)
Deprecated. This function is deprecated and should not be used in new scripts.
Set the layout for this
.
CheckBox
This is not currently functional.
Parameters
Name | Type | Description |
---|---|---|
layout | Object |
Return
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.CheckBox
Parameters
Name | Type | Description |
---|---|---|
name | String | the new name. |
Return
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. The specified size many not take effect
unless the element's CSS CheckBoxdisplay property
is set to inline-block
.
Parameters
Name | Type | Description |
---|---|---|
width | Integer | the new width in pixels. |
height | Integer | the new height in pixels. |
Return
setSize(width, height)
setSize(width, height)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the size of this
. The specified size many not take effect unless the
element's CSS CheckBoxdisplay property
is set to inline-block
.
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
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.
CheckBox
// 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
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.
CheckBox
// 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
setStyleName(styleName)
setStyleName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the style name of this
.
CheckBox
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
setStylePrimaryName(styleName)
setStylePrimaryName(styleName)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the primary style name of this
.
CheckBox
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
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.
CheckBox
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
setTag(tag)
setTag(tag)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the text tag of this
.CheckBox
Parameters
Name | Type | Description |
---|---|---|
tag | String | the new text tag, which can be anything you wish to store with the widget. |
Return
setText(text)
setText(text)
Deprecated. This function is deprecated and should not be used in new scripts.
Set the display text of this
.CheckBox
Parameters
Name | Type | Description |
---|---|---|
text | String | the new text. |
Return
setTitle(title)
setTitle(title)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the hover title of this
.
CheckBox
Not all browsers will show this.
Parameters
Name | Type | Description |
---|---|---|
title | String | the hover title. |
Return
setValue(value)
setValue(value)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets whether the
should be checked. Does not fire any events if the value
changes as a result of this call.CheckBox
Parameters
Name | Type | Description |
---|---|---|
value | Boolean | the new checked/unchecked state. |
Return
setValue(value, fireEvents)
setValue(value, fireEvents)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets whether the
should be checked and optionally fires an event if the
value changes as a result of this call.CheckBox
Parameters
Name | Type | Description |
---|---|---|
value | Boolean | the new checked/unchecked state. |
fireEvents | Boolean | whether to fire an event if this changed the state. |
Return
setVisible(visible)
setVisible(visible)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets whether this
is visible.CheckBox
Parameters
Name | Type | Description |
---|---|---|
visible | Boolean | whether this should be visible or not. |
Return
setWidth(width)
setWidth(width)
Deprecated. This function is deprecated and should not be used in new scripts.
Sets the width of this
. The specified width may not take effect unless the
element's CSS CheckBoxdisplay
property is set to inline-block
.
Parameters
Name | Type | Description |
---|---|---|
width | String | the new width in any CSS unit such as "10px" or "50%". |