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
| Method | Return type | Brief description |
|---|---|---|
add(widget) | FlowPanel | Add a widget to the FlowPanel. |
addStyleDependentName(styleName) | FlowPanel | Sets the dependent style name of this FlowPanel. |
addStyleName(styleName) | FlowPanel | Adds a style name to this FlowPanel. |
clear() | FlowPanel | Remove all widgets from the FlowPanel. |
getId() | String | Returns the id that has been assigned to this object. |
getTag() | String | Gets the text tag of this FlowPanel. |
getType() | String | Gets the type of this object. |
insert(widget, beforeIndex) | FlowPanel | Add a widget to the FlowPanel at a specific index. |
remove(index) | FlowPanel | Remove the widget with the given index from the FlowPanel. |
remove(widget) | FlowPanel | Remove the given widget from the FlowPanel. |
setHeight(height) | FlowPanel | Sets the height of this FlowPanel. |
setId(id) | FlowPanel | Sets the id of this FlowPanel. |
setPixelSize(width, height) | FlowPanel | Sets the size of this FlowPanel in pixels. |
setSize(width, height) | FlowPanel | Sets the size of this FlowPanel. |
setStyleAttribute(attribute, value) | FlowPanel | Sets one of this FlowPanel's style attributes to a new value. |
setStyleAttributes(attributes) | FlowPanel | Sets this FlowPanel's style attributes. |
setStyleName(styleName) | FlowPanel | Sets the style name of this FlowPanel. |
setStylePrimaryName(styleName) | FlowPanel | Sets the primary style name of this FlowPanel. |
setTag(tag) | FlowPanel | Sets the text tag of this FlowPanel. |
setTitle(title) | FlowPanel | Sets the hover title of this FlowPanel. |
setVisible(visible) | FlowPanel | Sets whether this FlowPanel is visible. |
setWidth(width) | FlowPanel | Sets the width of this FlowPanel. |
Detailed documentation
add(widget)
Add a widget to the FlowPanel.
Parameters
| Name | Type | Description |
|---|---|---|
widget | Widget | the widget to add. |
Return
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
| Name | Type | Description |
|---|---|---|
styleName | String | the new style name. |
Return
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
| Name | Type | Description |
|---|---|---|
styleName | String | the new style name. |
Return
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
insert(widget, beforeIndex)
Add a widget to the FlowPanel at a specific index.
Parameters
| Name | Type | Description |
|---|---|---|
widget | Widget | the widget to add. |
beforeIndex | Integer | the index to insert the widget before. |
Return
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
| Name | Type | Description |
|---|---|---|
index | Integer | the index of the widget to remove. |
Return
remove(widget)
Remove the given widget from the FlowPanel. This will fail if the widget is not
actually a child of the FlowPanel.
Parameters
| Name | Type | Description |
|---|---|---|
widget | Widget | the widget to remove. |
Return
setHeight(height)
Sets the height of this FlowPanel.
Parameters
| Name | Type | Description |
|---|---|---|
height | String | the new height in any CSS unit such as "10px" or "50%". |
Return
setId(id)
Sets the id of this FlowPanel.
Parameters
| Name | Type | Description |
|---|---|---|
id | String | the new id, which can be used to retrieve the FlowPanel from
app.getElementById(id). |
Return
setPixelSize(width, height)
Sets the size of this FlowPanel in pixels.
Parameters
| Name | Type | Description |
|---|---|---|
width | Integer | the new width in pixels. |
height | Integer | the new height in pixels. |
Return
setSize(width, height)
Sets the size of this FlowPanel.
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
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
| Name | Type | Description |
|---|---|---|
attribute | String | the CSS attribute, in camel-case ("fontSize", not "font-size"), as listed here |
value | String | the CSS value |
Return
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
| 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
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
| Name | Type | Description |
|---|---|---|
styleName | String | the new style name. |
Return
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
| Name | Type | Description |
|---|---|---|
styleName | String | the new style name. |
Return
setTag(tag)
Sets the text tag of this FlowPanel.
Parameters
| Name | Type | Description |
|---|---|---|
tag | String | the new text tag, which can be anything you wish to store with the widget. |
Return
setTitle(title)
Sets the hover title of this FlowPanel.
Not all browsers will show this.
Parameters
| Name | Type | Description |
|---|---|---|
title | String | the hover title. |
Return
setVisible(visible)
Sets whether this FlowPanel is visible.
Parameters
| Name | Type | Description |
|---|---|---|
visible | Boolean | whether this FlowPanel should be visible or not. |
Return
setWidth(width)
Sets the width of this FlowPanel.
Parameters
| Name | Type | Description |
|---|---|---|
width | String | the new width in any CSS unit such as "10px" or "50%". |