Class Grid

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

A rectangular grid that can contain text, html, or a child widget within its cells. It must be resized explicitly to the desired number of rows and columns.

Here is an example of how to use this widget:

 

 function doGet() {
   var app = UiApp.createApplication();
   app.add(app.createGrid(3, 3)
       .setBorderWidth(1)
       .setCellSpacing(10)
       .setCellPadding(10)
       .setText(0, 0, "X")
       .setText(1, 1, "X")
       .setText(2, 2, "X")
       .setText(0, 1, "O")
       .setText(0, 2, "O")
       .setStyleAttribute(0, 0, "color", "red")
       .setStyleAttribute(1, 1, "color", "red")
       .setStyleAttribute(2, 2, "color", "red")
       .setStyleAttribute(0, 1, "color", "blue")
       .setStyleAttribute(0, 2, "color", "blue"));
   return app;
 }

Internally, UiApp widgets are built on top of the Google Web Toolkit, and it can sometimes be helpful to look at the GWT documentation directly. You can find the Grid documentation here.

Deprecated methods

Method	Return type	Brief description
`addClickHandler(handler)`	`Grid`	Add a handler for click events.
`addStyleDependentName(styleName)`	`Grid`	Sets the dependent style name of this `Grid`.
`addStyleName(styleName)`	`Grid`	Adds a style name to this `Grid`.
`clear()`	`Grid`	Remove all widgets from the `Grid`.
`getId()`	`String`	Returns the id that has been assigned to this object.
`getTag()`	`String`	Gets the text tag of this `Grid`.
`getType()`	`String`	Gets the type of this object.
`resize(rows, columns)`	`Grid`	Resizes the `Grid`.
`setBorderWidth(width)`	`Grid`	Sets the border width.
`setCellPadding(padding)`	`Grid`	Sets the padding within cells.
`setCellSpacing(spacing)`	`Grid`	Sets the spacing between cells.
`setColumnStyleAttribute(column, attribute, value)`	`Grid`	Sets a CSS style on a column of this `Grid`.
`setColumnStyleAttributes(column, attributes)`	`Grid`	Sets a CSS style on a column of this `Grid`.
`setHeight(height)`	`Grid`	Sets the height of this `Grid`.
`setId(id)`	`Grid`	Sets the id of this `Grid`.
`setLayoutData(layout)`	`Grid`	Set the layout for this `Grid`.
`setPixelSize(width, height)`	`Grid`	Sets the size of this `Grid` in pixels.
`setRowStyleAttribute(row, attribute, value)`	`Grid`	Sets a CSS style on a row of this `Grid`.
`setRowStyleAttributes(row, attributes)`	`Grid`	Sets a CSS style on a row of this `Grid`.
`setSize(width, height)`	`Grid`	Sets the size of this `Grid`.
`setStyleAttribute(row, column, attribute, value)`	`Grid`	Sets a CSS style on a cell of this `Grid`.
`setStyleAttribute(attribute, value)`	`Grid`	Sets one of this `Grid`'s style attributes to a new value.
`setStyleAttributes(row, column, attributes)`	`Grid`	Sets a CSS style on a cell of this `Grid`.
`setStyleAttributes(attributes)`	`Grid`	Sets this `Grid`'s style attributes.
`setStyleName(styleName)`	`Grid`	Sets the style name of this `Grid`.
`setStylePrimaryName(styleName)`	`Grid`	Sets the primary style name of this `Grid`.
`setTag(tag)`	`Grid`	Sets the text tag of this `Grid`.
`setText(row, column, text)`	`Grid`	Sets the contents of a given cell to the given text.
`setTitle(title)`	`Grid`	Sets the hover title of this `Grid`.
`setVisible(visible)`	`Grid`	Sets whether this `Grid` is visible.
`setWidget(row, column, widget)`	`Grid`	Sets the widget in a given cell.
`setWidth(width)`	`Grid`	Sets the width of this `Grid`.

Deprecated methods

`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

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

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

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

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

Grid — the Grid itself, useful for chaining.

`clear()`

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

Remove all widgets from the Grid.

Return

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

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

`resize(rows, columns)`

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

Resizes the Grid.

Parameters

Name	Type	Description
`rows`	`Integer`	the new number of rows.
`columns`	`Integer`	the new number of columns.

Return

Grid — the Grid itself, useful for chaining.

`setBorderWidth(width)`

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

Sets the border width.

Parameters

Name	Type	Description
`width`	`Integer`	the border width, in pixels.

Return

Grid — the Grid itself, useful for chaining.

`setCellPadding(padding)`

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

Sets the padding within cells.

Parameters

Name	Type	Description
`padding`	`Integer`	the padding, in pixels.

Return

Grid — the Grid itself, useful for chaining.

`setCellSpacing(spacing)`

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

Sets the spacing between cells.

Parameters

Name	Type	Description
`spacing`	`Integer`	the spacing, in pixels.

Return

Grid — the Grid itself, useful for chaining.

`setColumnStyleAttribute(column, attribute, value)`

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

Sets a CSS style on a column of this Grid.

Parameters

Name	Type	Description
`column`	`Integer`	the column number.
`attribute`	`String`	the CSS attribute, in camelCase. ("fontSize", not "font-size").
`value`	`String`	the CSS value

Return

Grid — the Grid itself, useful for chaining.

`setColumnStyleAttributes(column, attributes)`

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

Sets a CSS style on a column of this Grid.

Parameters

Name	Type	Description
`column`	`Integer`	the column number.
`attributes`	`Object`	the CSS attributes and values to set.

Return

Grid — the Grid itself, useful for chaining.

`setHeight(height)`

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

Sets the height of this Grid.

Parameters

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

Return

Grid — the Grid itself, useful for chaining.

`setId(id)`

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

Sets the id of this Grid.

Parameters

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

Return

Grid — the Grid itself, useful for chaining.

`setLayoutData(layout)`

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

Set the layout for this Grid.

This is not currently functional.

Parameters

Name	Type	Description
`layout`	`Object`

Return

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

Parameters

Name	Type	Description
`width`	`Integer`	the new width in pixels.
`height`	`Integer`	the new height in pixels.

Return

Grid — the Grid itself, useful for chaining.

`setRowStyleAttribute(row, attribute, value)`

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

Sets a CSS style on a row of this Grid.

Parameters

Name	Type	Description
`row`	`Integer`	the row number.
`attribute`	`String`	the CSS attribute, in camelCase. ("fontSize", not "font-size").
`value`	`String`	the CSS value

Return

Grid — the Grid itself, useful for chaining.

`setRowStyleAttributes(row, attributes)`

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

Sets a CSS style on a row of this Grid.

Parameters

Name	Type	Description
`row`	`Integer`	the row number.
`attributes`	`Object`	the CSS attributes and values to set.

Return

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

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

Grid — the Grid itself, useful for chaining.

`setStyleAttribute(row, column, attribute, value)`

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

Sets a CSS style on a cell of this Grid.

Parameters

Name	Type	Description
`row`	`Integer`	the row of the cell.
`column`	`Integer`	the column of the cell.
`attribute`	`String`	the CSS attribute, in camelCase. ("fontSize", not "font-size").
`value`	`String`	the CSS value

Return

Grid — the Grid itself, useful for chaining.

`setStyleAttribute(attribute, value)`

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

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

Grid — the Grid itself, useful for chaining.

`setStyleAttributes(row, column, attributes)`

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

Sets a CSS style on a cell of this Grid.

Parameters

Name	Type	Description
`row`	`Integer`	the row of the cell.
`column`	`Integer`	the column of the cell.
`attributes`	`Object`	the CSS attributes and values to set.

Return

Grid — the Grid itself, useful for chaining.

`setStyleAttributes(attributes)`

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

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

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

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

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

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

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

Parameters

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

Return

Grid — the Grid itself, useful for chaining.

`setText(row, column, text)`

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

Sets the contents of a given cell to the given text. This will remove any widget in the cell if one was there.

Parameters

Name	Type	Description
`row`	`Integer`	the row of the cell.
`column`	`Integer`	the column of the cell.
`text`	`String`	the text to insert.

Return

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

Not all browsers will show this.

Parameters

Name	Type	Description
`title`	`String`	the hover title.

Return

Grid — the Grid itself, useful for chaining.

`setVisible(visible)`

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

Sets whether this Grid is visible.

Parameters

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

Return

Grid — the Grid itself, useful for chaining.

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

Sets the widget in a given cell. A cell can contain at most one widget.

Parameters

Name	Type	Description
`row`	`Integer`	the row of the cell.
`column`	`Integer`	the column of the cell.
`widget`	`Widget`	the widget to insert.

Return

Grid — the Grid itself, useful for chaining.

`setWidth(width)`

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

Sets the width of this Grid.

Parameters

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

Return

Grid — the Grid itself, useful for chaining.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.

Last updated February 26, 2015.