Class RadioButton

RadioButton

Deprecated. The UI service was deprecated on December 11, 2014. To create user interfaces, use the HTML service instead.

A mutually-exclusive selection radio button widget.

This widget fires click events when the radio button is clicked, and value change events when the button becomes checked. Note, however, that browser limitations prevent value change events from being sent when the radio button is cleared as a side effect of another in the group being clicked.

RadioButtons are grouped according to the following rules:

• In the absence of a FormPanel, RadioButtons with the same name are part of the same group.
• Within a FormPanel, all unnamed RadioButtons are part of the same group.
• Within a FormPanel, all RadioButtons with the same name are part of the same group - but not part of the same group as RadioButtons with the same name outside of the FormPanel.

Note that radio button selections within a group do not propagate to server handlers created with UiInstance#createServerHandler(). Instead, to capture values on the server, use doPost() or separate handlers for each RadioButton.

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 RadioButton documentation here.

Deprecated methods

Method	Return type	Brief description
addBlurHandler(handler)	RadioButton	Add a handler for blur events (losing keyboard focus).
addClickHandler(handler)	RadioButton	Add a handler for click events.
addFocusHandler(handler)	RadioButton	Add a handler for focus events (gaining keyboard focus).
addKeyDownHandler(handler)	RadioButton	Add a handler for key down events.
addKeyPressHandler(handler)	RadioButton	Add a handler for key press events.
addKeyUpHandler(handler)	RadioButton	Add a handler for key up events.
addMouseDownHandler(handler)	RadioButton	Add a handler for mouse down events.
addMouseMoveHandler(handler)	RadioButton	Add a handler for mouse move events.
addMouseOutHandler(handler)	RadioButton	Add a handler for mouse out events.
addMouseOverHandler(handler)	RadioButton	Add a handler for mouse move events.
addMouseUpHandler(handler)	RadioButton	Add a handler for mouse up events.
addMouseWheelHandler(handler)	RadioButton	Add a handler for mouse wheel events.
addStyleDependentName(styleName)	RadioButton	Sets the dependent style name of this RadioButton.
addStyleName(styleName)	RadioButton	Adds a style name to this RadioButton.
addValueChangeHandler(handler)	RadioButton	Add a handler for value change events.
getId()	String	Returns the id that has been assigned to this object.
getTag()	String	Gets the text tag of this RadioButton.
getType()	String	Gets the type of this object.
setAccessKey(accessKey)	RadioButton	Sets the widget's 'access key'.
setEnabled(enabled)	RadioButton	Sets whether the RadioButton is enabled.
setFocus(focus)	RadioButton	Explicitly focus/unfocus this RadioButton.
setFormValue(formValue)	RadioButton	Set the value property on the input element that backs this RadioButton.
setHTML(html)	RadioButton	Sets the HTML content of this RadioButton.
setHeight(height)	RadioButton	Sets the height of this RadioButton.
setId(id)	RadioButton	Sets the id of this RadioButton.
setLayoutData(layout)	RadioButton	Set the layout for this RadioButton.
setName(name)	RadioButton	Sets the name of the RadioButton, 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)	RadioButton	Sets the size of this RadioButton in pixels.
setSize(width, height)	RadioButton	Sets the size of this RadioButton.
setStyleAttribute(attribute, value)	RadioButton	Sets one of this RadioButton's style attributes to a new value.
setStyleAttributes(attributes)	RadioButton	Sets this RadioButton's style attributes.
setStyleName(styleName)	RadioButton	Sets the style name of this RadioButton.
setStylePrimaryName(styleName)	RadioButton	Sets the primary style name of this RadioButton.
setTabIndex(index)	RadioButton	Sets the RadioButton's position in the tab index.
setTag(tag)	RadioButton	Sets the text tag of this RadioButton.
setText(text)	RadioButton	Set the display text of this RadioButton.
setTitle(title)	RadioButton	Sets the hover title of this RadioButton.
setValue(value)	RadioButton	Sets whether the RadioButton should be checked.
setValue(value, fireEvents)	RadioButton	Sets whether the RadioButton should be checked and optionally fires an event if the value changes as a result of this call.
setVisible(visible)	RadioButton	Sets whether this RadioButton is visible.
setWidth(width)	RadioButton	Sets the width of this RadioButton.

Deprecated methods

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 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

Name	Type	Description
handler	Handler	the handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

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 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

Name	Type	Description
handler	Handler	the handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

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 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

Name	Type	Description
handler	Handler	the handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

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 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

Name	Type	Description
handler	Handler	the handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

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 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

Name	Type	Description
handler	Handler	the handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

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 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

Name	Type	Description
handler	Handler	the handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

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 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

Name	Type	Description
handler	Handler	the handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

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 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

Name	Type	Description
handler	Handler	the handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

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 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

Name	Type	Description
handler	Handler	the handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

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 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

Name	Type	Description
handler	Handler	the handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

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 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

Name	Type	Description
handler	Handler	the handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

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 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

Name	Type	Description
handler	Handler	the handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

addStyleDependentName(styleName)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the dependent style name of this RadioButton.

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

RadioButton — the RadioButton itself, useful for chaining.

---

addStyleName(styleName)

Deprecated. This function is deprecated and should not be used in new scripts.

Adds a style name to this RadioButton.

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

RadioButton — the RadioButton itself, useful for chaining.

---

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 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

Name	Type	Description
handler	Handler	the handler to execute when the event occurs. This can be a ClientHandler or a ServerHandler.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

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()

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the text tag of this RadioButton.

Return

String — the text tag.

---

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)

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

RadioButton — the RadioButton itself, useful for chaining.

---

setEnabled(enabled)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether the RadioButton is enabled.

Parameters

Name	Type	Description
enabled	Boolean	whether the RadioButton should be enabled or disabled.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

setFocus(focus)

Deprecated. This function is deprecated and should not be used in new scripts.

Explicitly focus/unfocus this RadioButton.

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 RadioButton should have the current focus.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

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 RadioButton. 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.

Parameters

Name	Type	Description
formValue	String	the new form value.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

setHTML(html)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the HTML content of this RadioButton.

Parameters

Name	Type	Description
html	String	the new HTML

Return

RadioButton — the RadioButton itself, useful for chaining.

---

setHeight(height)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the height of this RadioButton. The specified height may not take effect unless the element's CSS display 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

RadioButton — the RadioButton itself, useful for chaining.

---

setId(id)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the id of this RadioButton.

Parameters

Name	Type	Description
id	String	the new id, which can be used to retrieve the RadioButton from app.getElementById(id).

Return

RadioButton — the RadioButton itself, useful for chaining.

---

setLayoutData(layout)

Deprecated. This function is deprecated and should not be used in new scripts.

Set the layout for this RadioButton.

This is not currently functional.

Parameters

Name	Type	Description
layout	Object

Return

RadioButton — the RadioButton itself, useful for chaining.

---

setName(name)

Deprecated. This function is deprecated and should not be used in new scripts.

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

Parameters

Name	Type	Description
name	String	the new name.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

setPixelSize(width, height)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this RadioButton in pixels. The specified size many not take effect unless the element's CSS display 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

RadioButton — the RadioButton itself, useful for chaining.

---

setSize(width, height)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this RadioButton. The specified size many not take effect unless the element's CSS display 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

RadioButton — the RadioButton itself, useful for chaining.

---

setStyleAttribute(attribute, value)

Deprecated. This function is deprecated and should not be used in new scripts.

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

Name	Type	Description
attribute	String	the CSS attribute, in camel-case ("fontSize", not "font-size"), as listed here
value	String	the CSS value

Return

RadioButton — the RadioButton itself, useful for chaining.

---

setStyleAttributes(attributes)

Deprecated. This function is deprecated and should not be used in new scripts.

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

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

RadioButton — the RadioButton itself, useful for chaining.

---

setStyleName(styleName)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the style name of this RadioButton.

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

RadioButton — the RadioButton itself, useful for chaining.

---

setStylePrimaryName(styleName)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the primary style name of this RadioButton.

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

RadioButton — the RadioButton itself, useful for chaining.

---

setTabIndex(index)

Deprecated. This function is deprecated and should not be used in new scripts.

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

Name	Type	Description
index	Integer	the new tab index.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

setTag(tag)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the text tag of this RadioButton.

Parameters

Name	Type	Description
tag	String	the new text tag, which can be anything you wish to store with the widget.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

setText(text)

Deprecated. This function is deprecated and should not be used in new scripts.

Set the display text of this RadioButton.

Parameters

Name	Type	Description
text	String	the new text.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

setTitle(title)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the hover title of this RadioButton.

Not all browsers will show this.

Parameters

Name	Type	Description
title	String	the hover title.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

setValue(value)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether the RadioButton should be checked. Does not fire any events if the value changes as a result of this call.

Parameters

Name	Type	Description
value	Boolean	the new checked/unchecked state.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

setValue(value, fireEvents)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether the RadioButton should be checked and optionally fires an event if the value changes as a result of this call.

Parameters

Name	Type	Description
value	Boolean	the new checked/unchecked state.
fireEvents	Boolean	whether to fire an event if this changed the state.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

setVisible(visible)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether this RadioButton is visible.

Parameters

Name	Type	Description
visible	Boolean	whether this RadioButton should be visible or not.

Return

RadioButton — the RadioButton itself, useful for chaining.

---

setWidth(width)

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the width of this RadioButton. The specified width may not take effect unless the element's CSS display property is set to inline-block.

Parameters

Name	Type	Description
width	String	the new width in any CSS unit such as "10px" or "50%".

Return

RadioButton — the RadioButton itself, useful for chaining.