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.
Methods
Detailed documentation
add(widget)
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)
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)
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)
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()
Remove all widgets from the ScrollPanel.
Return
ScrollPanel — the ScrollPanel 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
setAlwaysShowScrollBars(alwaysShow)
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)
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)
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)
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.
setPixelSize(width, height)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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)
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.