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
Detailed documentation
add(widget)
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)
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)
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()
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
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
| Name | Type | Description |
|---|---|---|
index | Integer | the 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
| Name | Type | Description |
|---|---|---|
widget | Widget | the 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
| Name | Type | Description |
|---|---|---|
width | Integer | the 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
| 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)
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)
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)
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)
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)
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)
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.
setPixelSize(width, height)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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.