Google Apps Script

Class HorizontalPanel

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.

Methods

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

Detailed documentation

add(widget)

Add a widget to the HorizontalPanel.

Parameters

NameTypeDescription
widgetWidgetthe widget to add.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


addStyleDependentName(styleName)

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

NameTypeDescription
styleNameStringthe new style name.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


addStyleName(styleName)

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

NameTypeDescription
styleNameStringthe new style name.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


clear()

Remove all widgets from the HorizontalPanel.

Return

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

Return

String — the text tag.


getType()

Gets the type of this object.

Return

String — the object type


remove(index)

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

NameTypeDescription
indexIntegerthe index of the widget to remove.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


remove(widget)

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

Parameters

NameTypeDescription
widgetWidgetthe widget to remove.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setBorderWidth(width)

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

NameTypeDescription
widthIntegerthe new border width, in pixels.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setCellHeight(widget, height)

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

NameTypeDescription
widgetWidgetthe widget to use in identifying the cell.
heightStringthe height in any valid CSS unit, such as "10px" or "15cm".

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setCellHorizontalAlignment(widget, horizontalAlignment)

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

NameTypeDescription
widgetWidgetthe widget to align.
horizontalAlignmentHorizontalAlignmentthe desired alignment, such as UiApp.HorizontalAlignment.CENTER.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setCellVerticalAlignment(widget, verticalAlignment)

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

NameTypeDescription
widgetWidgetthe widget to align.
verticalAlignmentVerticalAlignmentthe desired alignment, such as UiApp.VerticalAlignment.MIDDLE.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setCellWidth(widget, width)

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

NameTypeDescription
widgetWidgetthe widget to use in identifying the cell.
widthStringthe width in any valid CSS unit, such as "10px" or "15cm".

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setHeight(height)

Sets the height of this HorizontalPanel.

Parameters

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

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setHorizontalAlignment(horizontalAlignment)

Set the horizontal alignment of widgets added to this HorizontalPanel.

Parameters

NameTypeDescription
horizontalAlignmentHorizontalAlignmentthe desired alignment, such as UiApp.HorizontalAlignment.CENTER.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setId(id)

Sets the id of this HorizontalPanel.

Parameters

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

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setPixelSize(width, height)

Sets the size of this HorizontalPanel in pixels.

Parameters

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

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setSize(width, height)

Sets the size of this HorizontalPanel.

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

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setSpacing(spacing)

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

Parameters

NameTypeDescription
spacingIntegerthe spacing, in pixels.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setStyleAttribute(attribute, value)

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

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

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setStyleAttributes(attributes)

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

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

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

NameTypeDescription
styleNameStringthe new style name.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setStylePrimaryName(styleName)

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

NameTypeDescription
styleNameStringthe new style name.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setTag(tag)

Sets the text tag of this HorizontalPanel.

Parameters

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

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setTitle(title)

Sets the hover title of this HorizontalPanel.

Not all browsers will show this.

Parameters

NameTypeDescription
titleStringthe hover title.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setVerticalAlignment(verticalAlignment)

Set the vertical alignment of widgets added to this HorizontalPanel.

Parameters

NameTypeDescription
verticalAlignmentVerticalAlignmentthe desired alignment, such as UiApp.VerticalAlignment.MIDDLE.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setVisible(visible)

Sets whether this HorizontalPanel is visible.

Parameters

NameTypeDescription
visibleBooleanwhether this HorizontalPanel should be visible or not.

Return

HorizontalPanel — the HorizontalPanel itself, useful for chaining.


setWidth(width)

Sets the width of this HorizontalPanel.

Parameters

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

Return

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