Class HorizontalPanel | Apps Script

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

A panel that lays all of its widgets out in a single horizontal column.

Here is an example of how to use this widget:

function doGet() {
  var app = UiApp.createApplication();
  var panel = app.createHorizontalPanel();
  panel.add(app.createButton("button 1"));
  panel.add(app.createButton("button 2"));
  app.add(panel);
  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 HorizontalPanel documentation here.

Deprecated methods

Method	Return type	Brief description
`add(widget)`	`HorizontalPanel`	Add a widget to the `HorizontalPanel`.
`addStyleDependentName(styleName)`	`HorizontalPanel`	Sets the dependent style name of this `HorizontalPanel`.
`addStyleName(styleName)`	`HorizontalPanel`	Adds a style name to this `HorizontalPanel`.
`clear()`	`HorizontalPanel`	Remove all widgets from the `HorizontalPanel`.
`getId()`	`String`	Returns the id that has been assigned to this object.
`getTag()`	`String`	Gets the text tag of this `HorizontalPanel`.
`getType()`	`String`	Gets the type of this object.
`remove(index)`	`HorizontalPanel`	Remove the widget with the given index from the `HorizontalPanel`.
`remove(widget)`	`HorizontalPanel`	Remove the given widget from the `HorizontalPanel`.
`setBorderWidth(width)`	`HorizontalPanel`	Sets the width of the border to be applied to all cells in this panel.
`setCellHeight(widget, height)`	`HorizontalPanel`	Sets the height of the cell associated with the given widget, related to the panel as a whole.
`setCellHorizontalAlignment(widget, horizontalAlignment)`	`HorizontalPanel`	Sets the horizontal alignment of the given widget within its cell.
`setCellVerticalAlignment(widget, verticalAlignment)`	`HorizontalPanel`	Sets the vertical alignment of the given widget within its cell.
`setCellWidth(widget, width)`	`HorizontalPanel`	Sets the width of the cell associated with the given widget, related to the panel as a whole.
`setHeight(height)`	`HorizontalPanel`	Sets the height of this `HorizontalPanel`.
`setHorizontalAlignment(horizontalAlignment)`	`HorizontalPanel`	Set the horizontal alignment of widgets added to this `HorizontalPanel`.
`setId(id)`	`HorizontalPanel`	Sets the id of this `HorizontalPanel`.
`setLayoutData(layout)`	`HorizontalPanel`	Set the layout for this `HorizontalPanel`.
`setPixelSize(width, height)`	`HorizontalPanel`	Sets the size of this `HorizontalPanel` in pixels.
`setSize(width, height)`	`HorizontalPanel`	Sets the size of this `HorizontalPanel`.
`setSpacing(spacing)`	`HorizontalPanel`	Sets the amount of spacing between this panel's cells.
`setStyleAttribute(attribute, value)`	`HorizontalPanel`	Sets one of this `HorizontalPanel`'s style attributes to a new value.
`setStyleAttributes(attributes)`	`HorizontalPanel`	Sets this `HorizontalPanel`'s style attributes.
`setStyleName(styleName)`	`HorizontalPanel`	Sets the style name of this `HorizontalPanel`.
`setStylePrimaryName(styleName)`	`HorizontalPanel`	Sets the primary style name of this `HorizontalPanel`.
`setTag(tag)`	`HorizontalPanel`	Sets the text tag of this `HorizontalPanel`.
`setTitle(title)`	`HorizontalPanel`	Sets the hover title of this `HorizontalPanel`.
`setVerticalAlignment(verticalAlignment)`	`HorizontalPanel`	Set the vertical alignment of widgets added to this `HorizontalPanel`.
`setVisible(visible)`	`HorizontalPanel`	Sets whether this `HorizontalPanel` is visible.
`setWidth(width)`	`HorizontalPanel`	Sets the width of this `HorizontalPanel`.

Deprecated methods

`add(widget)`

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

Add a widget to the HorizontalPanel.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to add.

Return

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

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

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

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

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`clear()`

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

Remove all widgets from the HorizontalPanel.

Return

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

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

`remove(index)`

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

Remove the widget with the given index from the HorizontalPanel. Indexes begin from 0. This will fail if the index is greater than or equal to the number of elements in the HorizontalPanel.

Parameters

Name	Type	Description
`index`	`Integer`	the index of the widget to remove.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`remove(widget)`

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

Remove the given widget from the HorizontalPanel. This will fail if the widget is not actually a child of the HorizontalPanel.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to remove.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`setBorderWidth(width)`

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

Sets the width of the border to be applied to all cells in this panel.

This is particularly useful when debugging layouts, in that it allows you to see explicitly the cells that contain this panel's children.

Parameters

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

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`setCellHeight(widget, height)`

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

Sets the height of the cell associated with the given widget, related to the panel as a whole.

This will cause an error if used with a widget that is not currently a child of the panel.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to use in identifying the cell.
`height`	`String`	the height in any valid CSS unit, such as "10px" or "15cm".

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`setCellHorizontalAlignment(widget, horizontalAlignment)`

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

Sets the horizontal alignment of the given widget within its cell.

This will cause an error if used with a widget that is not currently a child of the panel.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to align.
`horizontalAlignment`	`HorizontalAlignment`	the desired alignment, such as UiApp.HorizontalAlignment.CENTER.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`setCellVerticalAlignment(widget, verticalAlignment)`

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

Sets the vertical alignment of the given widget within its cell.

This will cause an error if used with a widget that is not currently a child of the panel.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to align.
`verticalAlignment`	`VerticalAlignment`	the desired alignment, such as UiApp.VerticalAlignment.MIDDLE.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`setCellWidth(widget, width)`

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

Sets the width of the cell associated with the given widget, related to the panel as a whole.

This will cause an error if used with a widget that is not currently a child of the panel.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to use in identifying the cell.
`width`	`String`	the width in any valid CSS unit, such as "10px" or "15cm".

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`setHeight(height)`

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

Sets the height of this HorizontalPanel.

Parameters

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

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`setHorizontalAlignment(horizontalAlignment)`

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

Set the horizontal alignment of widgets added to this HorizontalPanel.

Parameters

Name	Type	Description
`horizontalAlignment`	`HorizontalAlignment`	the desired alignment, such as UiApp.HorizontalAlignment.CENTER.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`setId(id)`

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

Sets the id of this HorizontalPanel.

Parameters

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

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`setLayoutData(layout)`

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

Set the layout for this HorizontalPanel.

This is not currently functional.

Parameters

Name	Type	Description
`layout`	`Object`

Return

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

Parameters

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

Return

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

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

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`setSpacing(spacing)`

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

Sets the amount of spacing between this panel's cells.

Parameters

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

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`setStyleAttribute(attribute, value)`

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

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

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`setStyleAttributes(attributes)`

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

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

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

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

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

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

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

Parameters

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

Return

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

Not all browsers will show this.

Parameters

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

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`setVerticalAlignment(verticalAlignment)`

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

Set the vertical alignment of widgets added to this HorizontalPanel.

Parameters

Name	Type	Description
`verticalAlignment`	`VerticalAlignment`	the desired alignment, such as UiApp.VerticalAlignment.MIDDLE.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`setVisible(visible)`

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

Sets whether this HorizontalPanel is visible.

Parameters

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

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.

`setWidth(width)`

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

Sets the width of this HorizontalPanel.

Parameters

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

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.