Class ToggleButton

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

Parameters

Return

ToggleButton — the ToggleButton 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;
 }
 

Parameters

Return

ToggleButton — the ToggleButton 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;
 }
 

Parameters

Return

ToggleButton — the ToggleButton 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;
 }
 

Parameters

Return

ToggleButton — the ToggleButton 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;
 }
 

Parameters

Return

ToggleButton — the ToggleButton 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;
 }
 

Parameters

Return

ToggleButton — the ToggleButton 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;
 }
 

Parameters

Return

ToggleButton — the ToggleButton 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;
 }
 

Parameters

Return

ToggleButton — the ToggleButton 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;
 }
 

Parameters

Return

ToggleButton — the ToggleButton 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;
 }
 

Parameters

Return

ToggleButton — the ToggleButton 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;
 }
 

Parameters

Return

ToggleButton — the ToggleButton 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;
 }
 

Parameters

Return

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

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Return

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

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Return

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

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

Return

ToggleButton — the ToggleButton itself, useful for chaining.

setDown(down)

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

Sets whether the button is down.

Parameters

Return

ToggleButton — the ToggleButton itself, useful for chaining.

setEnabled(enabled)

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

Sets whether the ToggleButton is enabled.

Parameters

Return

ToggleButton — the ToggleButton itself, useful for chaining.

setFocus(focus)

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

Explicitly focus/unfocus this ToggleButton.

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

Parameters

Return

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

Parameters

Return

ToggleButton — the ToggleButton itself, useful for chaining.

setHeight(height)

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

Sets the height of this ToggleButton.

Parameters

Return

ToggleButton — the ToggleButton itself, useful for chaining.

setId(id)

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

Sets the id of this ToggleButton.

Parameters

Return

ToggleButton — the ToggleButton itself, useful for chaining.

setLayoutData(layout)

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

Set the layout for this ToggleButton.

This is not currently functional.

Parameters

Return

ToggleButton — the ToggleButton 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 ToggleButton in pixels.

Parameters

Return

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

Parameters

Return

ToggleButton — the ToggleButton itself, useful for chaining.

setStyleAttribute(attribute, value)

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

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

Return

ToggleButton — the ToggleButton itself, useful for chaining.

setStyleAttributes(attributes)

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

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

Return

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

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Return

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

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Return

ToggleButton — the ToggleButton itself, useful for chaining.

setTabIndex(index)

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

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

Return

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

Parameters

Return

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

Parameters

Return

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

Not all browsers will show this.

Parameters

Return

ToggleButton — the ToggleButton itself, useful for chaining.

setVisible(visible)

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

Sets whether this ToggleButton is visible.

Parameters

Return

ToggleButton — the ToggleButton itself, useful for chaining.

setWidth(width)

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

Sets the width of this ToggleButton.

Parameters

Return

ToggleButton — the ToggleButton itself, useful for chaining.