Google Apps Script

Class FlowPanel

A panel that formats its child widgets using the default HTML layout behavior.

Here is an example of how to use this widget:

 
function doGet() {
   var app = UiApp.createApplication();
   var panel = app.createFlowPanel();
   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 FlowPanel documentation here.

Methods

MethodReturn typeBrief description
add(widget)FlowPanelAdd a widget to the FlowPanel.
addStyleDependentName(styleName)FlowPanelSets the dependent style name of this FlowPanel.
addStyleName(styleName)FlowPanelAdds a style name to this FlowPanel.
clear()FlowPanelRemove all widgets from the FlowPanel.
getId()StringReturns the id that has been assigned to this object.
getTag()StringGets the text tag of this FlowPanel.
getType()StringGets the type of this object.
insert(widget, beforeIndex)FlowPanelAdd a widget to the FlowPanel at a specific index.
remove(index)FlowPanelRemove the widget with the given index from the FlowPanel.
remove(widget)FlowPanelRemove the given widget from the FlowPanel.
setHeight(height)FlowPanelSets the height of this FlowPanel.
setId(id)FlowPanelSets the id of this FlowPanel.
setPixelSize(width, height)FlowPanelSets the size of this FlowPanel in pixels.
setSize(width, height)FlowPanelSets the size of this FlowPanel.
setStyleAttribute(attribute, value)FlowPanelSets one of this FlowPanel's style attributes to a new value.
setStyleAttributes(attributes)FlowPanelSets this FlowPanel's style attributes.
setStyleName(styleName)FlowPanelSets the style name of this FlowPanel.
setStylePrimaryName(styleName)FlowPanelSets the primary style name of this FlowPanel.
setTag(tag)FlowPanelSets the text tag of this FlowPanel.
setTitle(title)FlowPanelSets the hover title of this FlowPanel.
setVisible(visible)FlowPanelSets whether this FlowPanel is visible.
setWidth(width)FlowPanelSets the width of this FlowPanel.

Detailed documentation

add(widget)

Add a widget to the FlowPanel.

Parameters

NameTypeDescription
widgetWidgetthe widget to add.

Return

FlowPanel — the FlowPanel itself, useful for chaining.


addStyleDependentName(styleName)

Sets the dependent style name of this FlowPanel.

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

FlowPanel — the FlowPanel itself, useful for chaining.


addStyleName(styleName)

Adds a style name to this FlowPanel.

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

FlowPanel — the FlowPanel itself, useful for chaining.


clear()

Remove all widgets from the FlowPanel.

Return

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

Return

String — the text tag.


getType()

Gets the type of this object.

Return

String — the object type


insert(widget, beforeIndex)

Add a widget to the FlowPanel at a specific index.

Parameters

NameTypeDescription
widgetWidgetthe widget to add.
beforeIndexIntegerthe index to insert the widget before.

Return

FlowPanel — the FlowPanel itself, useful for chaining.


remove(index)

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

Parameters

NameTypeDescription
indexIntegerthe index of the widget to remove.

Return

FlowPanel — the FlowPanel itself, useful for chaining.


remove(widget)

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

Parameters

NameTypeDescription
widgetWidgetthe widget to remove.

Return

FlowPanel — the FlowPanel itself, useful for chaining.


setHeight(height)

Sets the height of this FlowPanel.

Parameters

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

Return

FlowPanel — the FlowPanel itself, useful for chaining.


setId(id)

Sets the id of this FlowPanel.

Parameters

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

Return

FlowPanel — the FlowPanel itself, useful for chaining.


setPixelSize(width, height)

Sets the size of this FlowPanel in pixels.

Parameters

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

Return

FlowPanel — the FlowPanel itself, useful for chaining.


setSize(width, height)

Sets the size of this FlowPanel.

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

FlowPanel — the FlowPanel itself, useful for chaining.


setStyleAttribute(attribute, value)

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

FlowPanel — the FlowPanel itself, useful for chaining.


setStyleAttributes(attributes)

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

FlowPanel — the FlowPanel itself, useful for chaining.


setStyleName(styleName)

Sets the style name of this FlowPanel.

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

FlowPanel — the FlowPanel itself, useful for chaining.


setStylePrimaryName(styleName)

Sets the primary style name of this FlowPanel.

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

FlowPanel — the FlowPanel itself, useful for chaining.


setTag(tag)

Sets the text tag of this FlowPanel.

Parameters

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

Return

FlowPanel — the FlowPanel itself, useful for chaining.


setTitle(title)

Sets the hover title of this FlowPanel.

Not all browsers will show this.

Parameters

NameTypeDescription
titleStringthe hover title.

Return

FlowPanel — the FlowPanel itself, useful for chaining.


setVisible(visible)

Sets whether this FlowPanel is visible.

Parameters

NameTypeDescription
visibleBooleanwhether this FlowPanel should be visible or not.

Return

FlowPanel — the FlowPanel itself, useful for chaining.


setWidth(width)

Sets the width of this FlowPanel.

Parameters

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

Return

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