Class ScrollPanel

Deprecated. The UI service was deprecated on December 11, 2014. To create user interfaces, use the HTML service instead.

A panel that wraps its contents in a scrollable element.

Note that this panel can contain at most one direct child widget. To add more children, make the child of this panel a different panel that can contain more than one child.

Here is an example of how to use this widget:

 

 function doGet() {
   var app = UiApp.createApplication();
   // Create some long content.
   var vertical = app.createVerticalPanel();
   for (var i = 0; i < 100; ++i) {
     vertical.add(app.createButton("button " + i));
   }
   var scroll = app.createScrollPanel().setPixelSize(100, 100);
   scroll.add(vertical);
   app.add(scroll);
   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 ScrollPanel documentation here.

Deprecated methods

Method	Return type	Brief description
`add(widget)`	`ScrollPanel`	Add a widget to the `ScrollPanel`.
`addScrollHandler(handler)`	`ScrollPanel`	Add a handler for scroll events.
`addStyleDependentName(styleName)`	`ScrollPanel`	Sets the dependent style name of this `ScrollPanel`.
`addStyleName(styleName)`	`ScrollPanel`	Adds a style name to this `ScrollPanel`.
`clear()`	`ScrollPanel`	Remove all widgets from the `ScrollPanel`.
`getId()`	`String`	Returns the id that has been assigned to this object.
`getTag()`	`String`	Gets the text tag of this `ScrollPanel`.
`getType()`	`String`	Gets the type of this object.
`setAlwaysShowScrollBars(alwaysShow)`	`ScrollPanel`	Sets whether to always show scrollbars even if they are not needed.
`setHeight(height)`	`ScrollPanel`	Sets the height of this `ScrollPanel`.
`setHorizontalScrollPosition(position)`	`ScrollPanel`	Sets the horizontal scroll position of this `ScrollPanel`.
`setId(id)`	`ScrollPanel`	Sets the id of this `ScrollPanel`.
`setLayoutData(layout)`	`ScrollPanel`	Set the layout for this `ScrollPanel`.
`setPixelSize(width, height)`	`ScrollPanel`	Sets the size of this `ScrollPanel` in pixels.
`setScrollPosition(position)`	`ScrollPanel`	Sets the vertical scroll position of this `ScrollPanel`.
`setSize(width, height)`	`ScrollPanel`	Sets the size of this `ScrollPanel`.
`setStyleAttribute(attribute, value)`	`ScrollPanel`	Sets one of this `ScrollPanel`'s style attributes to a new value.
`setStyleAttributes(attributes)`	`ScrollPanel`	Sets this `ScrollPanel`'s style attributes.
`setStyleName(styleName)`	`ScrollPanel`	Sets the style name of this `ScrollPanel`.
`setStylePrimaryName(styleName)`	`ScrollPanel`	Sets the primary style name of this `ScrollPanel`.
`setTag(tag)`	`ScrollPanel`	Sets the text tag of this `ScrollPanel`.
`setTitle(title)`	`ScrollPanel`	Sets the hover title of this `ScrollPanel`.
`setVisible(visible)`	`ScrollPanel`	Sets whether this `ScrollPanel` is visible.
`setWidget(widget)`	`ScrollPanel`	Sets the widget inside this `ScrollPanel`, removing anything previously there.
`setWidth(width)`	`ScrollPanel`	Sets the width of this `ScrollPanel`.

Deprecated methods

`add(widget)`

Deprecated. This function is deprecated and should not be used in new scripts.

Add a widget to the ScrollPanel.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to add.

Return

ScrollPanel — the ScrollPanel itself, useful for chaining.

`addScrollHandler(handler)`

Deprecated. This function is deprecated and should not be used in new scripts.

Add a handler for scroll events.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 

 function doGet() {
   var app = UiApp.createApplication();
   var label = app.createLabel("some label").setHeight("500px");
   var scroll = app.createScrollPanel(label).setHeight("200px");
   var handler = app.createServerHandler("handlerFunction");
   scroll.addScrollHandler(handler);
   app.add(scroll);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "scroll".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
 }

In addition, the values of certain widgets can be sent up with the event as well, as "callback elements." See the documentation of ServerHandler for more information. For an explanation of charCode and keyCode, including what to expect on different browsers, look here.

Parameters

Name	Type	Description
`handler`	`Handler`	the handler to execute when the event occurs. This can be a `ClientHandler` or a `ServerHandler`.

Return

ScrollPanel — the ScrollPanel itself, useful for chaining.

`addStyleDependentName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the dependent style name of this ScrollPanel.

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

ScrollPanel — the ScrollPanel itself, useful for chaining.

`addStyleName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Adds a style name to this ScrollPanel.

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

ScrollPanel — the ScrollPanel itself, useful for chaining.

`clear()`

Deprecated. This function is deprecated and should not be used in new scripts.

Remove all widgets from the ScrollPanel.

Return

ScrollPanel — the ScrollPanel itself, useful for chaining.

`getId()`

Deprecated. This function is deprecated and should not be used in new scripts.

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()`

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the text tag of this ScrollPanel.

Return

String — the text tag.

`getType()`

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the type of this object.

Return

String — the object type

`setAlwaysShowScrollBars(alwaysShow)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether to always show scrollbars even if they are not needed.

Parameters

Name	Type	Description
`alwaysShow`	`Boolean`	whether to always show scrollbars

Return

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setHeight(height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the height of this ScrollPanel.

Parameters

Name	Type	Description
`height`	`String`	the new height in any CSS unit such as "10px" or "50%".

Return

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setHorizontalScrollPosition(position)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the horizontal scroll position of this ScrollPanel.

Parameters

Name	Type	Description
`position`	`Integer`	the new horizontal scroll position, in pixels.

Return

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setId(id)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the id of this ScrollPanel.

Parameters

Name	Type	Description
`id`	`String`	the new id, which can be used to retrieve the `ScrollPanel` from app.getElementById(id).

Return

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setLayoutData(layout)`

Deprecated. This function is deprecated and should not be used in new scripts.

Set the layout for this ScrollPanel.

This is not currently functional.

Parameters

Name	Type	Description
`layout`	`Object`

Return

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setPixelSize(width, height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this ScrollPanel in pixels.

Parameters

Name	Type	Description
`width`	`Integer`	the new width in pixels.
`height`	`Integer`	the new height in pixels.

Return

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setScrollPosition(position)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the vertical scroll position of this ScrollPanel.

Parameters

Name	Type	Description
`position`	`Integer`	the new vertical scroll position, in pixels.

Return

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setSize(width, height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this ScrollPanel.

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

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setStyleAttribute(attribute, value)`

Deprecated. This function is deprecated and should not be used in new scripts.

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

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setStyleAttributes(attributes)`

Deprecated. This function is deprecated and should not be used in new scripts.

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

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setStyleName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the style name of this ScrollPanel.

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

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setStylePrimaryName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the primary style name of this ScrollPanel.

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

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setTag(tag)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the text tag of this ScrollPanel.

Parameters

Name	Type	Description
`tag`	`String`	the new text tag, which can be anything you wish to store with the widget.

Return

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setTitle(title)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the hover title of this ScrollPanel.

Not all browsers will show this.

Parameters

Name	Type	Description
`title`	`String`	the hover title.

Return

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setVisible(visible)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether this ScrollPanel is visible.

Parameters

Name	Type	Description
`visible`	`Boolean`	whether this `ScrollPanel` should be visible or not.

Return

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setWidget(widget)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the widget inside this ScrollPanel, removing anything previously there.

Parameters

Name	Type	Description
`widget`	`Widget`	the widget to put in this `ScrollPanel`.

Return

ScrollPanel — the ScrollPanel itself, useful for chaining.

`setWidth(width)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the width of this ScrollPanel.

Parameters

Name	Type	Description
`width`	`String`	the new width in any CSS unit such as "10px" or "50%".

Return

ScrollPanel — the ScrollPanel itself, useful for chaining.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.

Last updated February 26, 2015.