Google Apps Script

Class AbsolutePanel

An absolute panel positions all of its children absolutely, allowing them to overlap.

Here is an example of how to use this widget:

 
function doGet() {
   var app = UiApp.createApplication();
   var button = app.createButton("a button");
   var panel = app.createAbsolutePanel();
   // add a widget at position (10, 20)
   panel.add(button, 10, 20);
   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 AbsolutePanel documentation here.

Methods

MethodReturn typeBrief description
add(widget)AbsolutePanelAdd a widget to the AbsolutePanel.
add(widget, left, top)AbsolutePanelAdd a widget to the AbsolutePanel.
addStyleDependentName(styleName)AbsolutePanelSets the dependent style name of this AbsolutePanel.
addStyleName(styleName)AbsolutePanelAdds a style name to this AbsolutePanel.
clear()AbsolutePanelRemove all widgets from the AbsolutePanel.
getId()StringReturns the id that has been assigned to this object.
getTag()StringGets the text tag of this AbsolutePanel.
getType()StringGets the type of this object.
remove(index)AbsolutePanelRemove the widget with the given index from the AbsolutePanel.
remove(widget)AbsolutePanelRemove the given widget from the AbsolutePanel.
setHeight(height)AbsolutePanelSets the height of this AbsolutePanel.
setId(id)AbsolutePanelSets the id of this AbsolutePanel.
setPixelSize(width, height)AbsolutePanelSets the size of this AbsolutePanel in pixels.
setSize(width, height)AbsolutePanelSets the size of this AbsolutePanel.
setStyleAttribute(attribute, value)AbsolutePanelSets one of this AbsolutePanel's style attributes to a new value.
setStyleAttributes(attributes)AbsolutePanelSets this AbsolutePanel's style attributes.
setStyleName(styleName)AbsolutePanelSets the style name of this AbsolutePanel.
setStylePrimaryName(styleName)AbsolutePanelSets the primary style name of this AbsolutePanel.
setTag(tag)AbsolutePanelSets the text tag of this AbsolutePanel.
setTitle(title)AbsolutePanelSets the hover title of this AbsolutePanel.
setVisible(visible)AbsolutePanelSets whether this AbsolutePanel is visible.
setWidgetPosition(widget, left, top)AbsolutePanelSet the position of a widget that is already a child of the AbsolutePanel.
setWidth(width)AbsolutePanelSets the width of this AbsolutePanel.

Detailed documentation

add(widget)

Add a widget to the AbsolutePanel.

Parameters

NameTypeDescription
widgetWidgetthe widget to add.

Return

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


add(widget, left, top)

Add a widget to the AbsolutePanel.

Parameters

NameTypeDescription
widgetWidgetthe widget to add.
leftIntegerthe widget's left position in pixels.
topIntegerthe widget's top position in pixels.

Return

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


addStyleDependentName(styleName)

Sets the dependent style name of this AbsolutePanel.

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

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


addStyleName(styleName)

Adds a style name to this AbsolutePanel.

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

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


clear()

Remove all widgets from the AbsolutePanel.

Return

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

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 AbsolutePanel. Indexes begin from 0. This will fail if the index is greater than or equal to the number of elements in the AbsolutePanel.

Parameters

NameTypeDescription
indexIntegerthe index of the widget to remove.

Return

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


remove(widget)

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

Parameters

NameTypeDescription
widgetWidgetthe widget to remove.

Return

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


setHeight(height)

Sets the height of this AbsolutePanel.

Parameters

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

Return

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


setId(id)

Sets the id of this AbsolutePanel.

Parameters

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

Return

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


setPixelSize(width, height)

Sets the size of this AbsolutePanel in pixels.

Parameters

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

Return

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


setSize(width, height)

Sets the size of this AbsolutePanel.

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

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


setStyleAttribute(attribute, value)

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

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


setStyleAttributes(attributes)

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

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


setStyleName(styleName)

Sets the style name of this AbsolutePanel.

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

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


setStylePrimaryName(styleName)

Sets the primary style name of this AbsolutePanel.

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

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


setTag(tag)

Sets the text tag of this AbsolutePanel.

Parameters

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

Return

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


setTitle(title)

Sets the hover title of this AbsolutePanel.

Not all browsers will show this.

Parameters

NameTypeDescription
titleStringthe hover title.

Return

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


setVisible(visible)

Sets whether this AbsolutePanel is visible.

Parameters

NameTypeDescription
visibleBooleanwhether this AbsolutePanel should be visible or not.

Return

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


setWidgetPosition(widget, left, top)

Set the position of a widget that is already a child of the AbsolutePanel. This will cause an error if the widget is not currently in the panel.

Parameters

NameTypeDescription
widgetWidgetthe widget to position.
leftIntegerthe widget's left position in pixels.
topIntegerthe widget's top position in pixels.

Return

AbsolutePanel — the AbsolutePanel itself, useful for chaining.


setWidth(width)

Sets the width of this AbsolutePanel.

Parameters

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

Return

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