Google Apps Script

Class RadioButton

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 named RadioButtons are part of the same group - but not part of the same group as RadioButtons with the same name outside of the FormPanel.

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.

Methods

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

Detailed documentation

addBlurHandler(handler)

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

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

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

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

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

Parameters

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

Return

RadioButton — the RadioButton itself, useful for chaining.


addClickHandler(handler)

Add a handler for click events.

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

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

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

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

Parameters

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

Return

RadioButton — the RadioButton itself, useful for chaining.


addFocusHandler(handler)

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

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

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

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

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

Parameters

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

Return

RadioButton — the RadioButton itself, useful for chaining.


addKeyDownHandler(handler)

Add a handler for key down events.

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

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

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

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

Parameters

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

Return

RadioButton — the RadioButton itself, useful for chaining.


addKeyPressHandler(handler)

Add a handler for key press events.

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

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

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

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

Parameters

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

Return

RadioButton — the RadioButton itself, useful for chaining.


addKeyUpHandler(handler)

Add a handler for key up events.

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

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

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

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

Parameters

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

Return

RadioButton — the RadioButton itself, useful for chaining.


addMouseDownHandler(handler)

Add a handler for mouse down events.

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

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

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

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

Parameters

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

Return

RadioButton — the RadioButton itself, useful for chaining.


addMouseMoveHandler(handler)

Add a handler for mouse move events.

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

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

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

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

Parameters

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

Return

RadioButton — the RadioButton itself, useful for chaining.


addMouseOutHandler(handler)

Add a handler for mouse out events.

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

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

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

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

Parameters

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

Return

RadioButton — the RadioButton itself, useful for chaining.


addMouseOverHandler(handler)

Add a handler for mouse move events.

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

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

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

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

Parameters

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

Return

RadioButton — the RadioButton itself, useful for chaining.


addMouseUpHandler(handler)

Add a handler for mouse up events.

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

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

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

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

Parameters

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

Return

RadioButton — the RadioButton itself, useful for chaining.


addMouseWheelHandler(handler)

Add a handler for mouse wheel events.

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

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

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

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

Parameters

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

Return

RadioButton — the RadioButton itself, useful for chaining.


addStyleDependentName(styleName)

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

NameTypeDescription
styleNameStringthe new style name.

Return

RadioButton — the RadioButton itself, useful for chaining.


addStyleName(styleName)

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

NameTypeDescription
styleNameStringthe new style name.

Return

RadioButton — the RadioButton itself, useful for chaining.


addValueChangeHandler(handler)

Add a handler for value change events.

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

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

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

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

Parameters

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

Return

RadioButton — the RadioButton itself, useful for chaining.


getId()

Returns the id that has been assigned to this object.

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

Return

String — the id that has been assigned to this object


getTag()

Gets the text tag of this RadioButton.

Return

String — the text tag.


getType()

Gets the type of this object.

Return

String — the object type


setEnabled(enabled)

Sets whether the RadioButton is enabled.

Parameters

NameTypeDescription
enabledBooleanwhether the RadioButton should be enabled or disabled.

Return

RadioButton — the RadioButton itself, useful for chaining.


setFocus(focus)

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

NameTypeDescription
focusBooleanwhether the RadioButton should have the current focus.

Return

RadioButton — the RadioButton itself, useful for chaining.


setFormValue(formValue)

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

NameTypeDescription
formValueStringthe new form value.

Return

RadioButton — the RadioButton itself, useful for chaining.


setHTML(html)

Sets the HTML content of this RadioButton.

Parameters

NameTypeDescription
htmlStringthe new HTML

Return

RadioButton — the RadioButton itself, useful for chaining.


setHeight(height)

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

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

Return

RadioButton — the RadioButton itself, useful for chaining.


setId(id)

Sets the id of this RadioButton.

Parameters

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

Return

RadioButton — the RadioButton itself, useful for chaining.


setName(name)

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

NameTypeDescription
nameStringthe new name.

Return

RadioButton — the RadioButton itself, useful for chaining.


setPixelSize(width, height)

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

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

Return

RadioButton — the RadioButton itself, useful for chaining.


setSize(width, height)

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

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

Return

RadioButton — the RadioButton itself, useful for chaining.


setStyleAttribute(attribute, value)

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

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

Return

RadioButton — the RadioButton itself, useful for chaining.


setStyleAttributes(attributes)

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

NameTypeDescription
attributesObjectan 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)

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

NameTypeDescription
styleNameStringthe new style name.

Return

RadioButton — the RadioButton itself, useful for chaining.


setStylePrimaryName(styleName)

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

NameTypeDescription
styleNameStringthe new style name.

Return

RadioButton — the RadioButton itself, useful for chaining.


setTabIndex(index)

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

NameTypeDescription
indexIntegerthe new tab index.

Return

RadioButton — the RadioButton itself, useful for chaining.


setTag(tag)

Sets the text tag of this RadioButton.

Parameters

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

Return

RadioButton — the RadioButton itself, useful for chaining.


setText(text)

Set the display text of this RadioButton.

Parameters

NameTypeDescription
textStringthe new text.

Return

RadioButton — the RadioButton itself, useful for chaining.


setTitle(title)

Sets the hover title of this RadioButton.

Not all browsers will show this.

Parameters

NameTypeDescription
titleStringthe hover title.

Return

RadioButton — the RadioButton itself, useful for chaining.


setValue(value)

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

Parameters

NameTypeDescription
valueBooleanthe new checked/unchecked state.

Return

RadioButton — the RadioButton itself, useful for chaining.


setValue(value, fireEvents)

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

Parameters

NameTypeDescription
valueBooleanthe new checked/unchecked state.
fireEventsBooleanwhether to fire an event if this changed the state.

Return

RadioButton — the RadioButton itself, useful for chaining.


setVisible(visible)

Sets whether this RadioButton is visible.

Parameters

NameTypeDescription
visibleBooleanwhether this RadioButton should be visible or not.

Return

RadioButton — the RadioButton itself, useful for chaining.


setWidth(width)

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

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

Return

RadioButton — the RadioButton itself, useful for chaining.

Deprecated methods


Authentication required

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

Signing you in...

Google Developers needs your permission to do that.