A SimplePanel that wraps its contents in stylized boxes, which can be used to add rounded
corners to a Widget.
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.
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 DecoratorPanel documentation here.
Methods
Detailed documentation
add(widget)
Add a widget to the DecoratorPanel.
Parameters
| Name | Type | Description |
|---|---|---|
widget | Widget | the widget to add. |
Return
DecoratorPanel — the DecoratorPanel itself, useful for chaining.
addStyleDependentName(styleName)
Sets the dependent style name of this DecoratorPanel.
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
DecoratorPanel — the DecoratorPanel itself, useful for chaining.
addStyleName(styleName)
Adds a style name to this DecoratorPanel.
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
DecoratorPanel — the DecoratorPanel itself, useful for chaining.
clear()
Remove all widgets from the DecoratorPanel.
Return
DecoratorPanel — the DecoratorPanel 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
setHeight(height)
Sets the height of this DecoratorPanel.
Parameters
| Name | Type | Description |
|---|---|---|
height | String | the new height in any CSS unit such as "10px" or "50%". |
Return
DecoratorPanel — the DecoratorPanel itself, useful for chaining.
setId(id)
Sets the id of this DecoratorPanel.
Parameters
| Name | Type | Description |
|---|---|---|
id | String | the new id, which can be used to retrieve the DecoratorPanel from
app.getElementById(id). |
Return
DecoratorPanel — the DecoratorPanel itself, useful for chaining.
setPixelSize(width, height)
Sets the size of this DecoratorPanel in pixels.
Parameters
| Name | Type | Description |
|---|---|---|
width | Integer | the new width in pixels. |
height | Integer | the new height in pixels. |
Return
DecoratorPanel — the DecoratorPanel itself, useful for chaining.
setSize(width, height)
Sets the size of this DecoratorPanel.
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
DecoratorPanel — the DecoratorPanel itself, useful for chaining.
setStyleAttribute(attribute, value)
Sets one of this DecoratorPanel'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
DecoratorPanel — the DecoratorPanel itself, useful for chaining.
setStyleAttributes(attributes)
Sets this DecoratorPanel'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
DecoratorPanel — the DecoratorPanel itself, useful for chaining.
setStyleName(styleName)
Sets the style name of this DecoratorPanel.
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
DecoratorPanel — the DecoratorPanel itself, useful for chaining.
setStylePrimaryName(styleName)
Sets the primary style name of this DecoratorPanel.
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
DecoratorPanel — the DecoratorPanel itself, useful for chaining.
setTag(tag)
Sets the text tag of this DecoratorPanel.
Parameters
| Name | Type | Description |
|---|---|---|
tag | String | the new text tag, which can be anything you wish to store with the widget. |
Return
DecoratorPanel — the DecoratorPanel itself, useful for chaining.
setTitle(title)
Sets the hover title of this DecoratorPanel.
Not all browsers will show this.
Parameters
| Name | Type | Description |
|---|---|---|
title | String | the hover title. |
Return
DecoratorPanel — the DecoratorPanel itself, useful for chaining.
setVisible(visible)
Sets whether this DecoratorPanel is visible.
Parameters
| Name | Type | Description |
|---|---|---|
visible | Boolean | whether this DecoratorPanel should be visible or not. |
Return
DecoratorPanel — the DecoratorPanel itself, useful for chaining.
setWidget(widget)
Sets the widget inside this DecoratorPanel, removing anything previously there.
Parameters
| Name | Type | Description |
|---|---|---|
widget | Widget | the widget to put in this DecoratorPanel. |
Return
DecoratorPanel — the DecoratorPanel itself, useful for chaining.
setWidth(width)
Sets the width of this DecoratorPanel.
Parameters
| Name | Type | Description |
|---|---|---|
width | String | the new width in any CSS unit such as "10px" or "50%". |
Return
DecoratorPanel — the DecoratorPanel itself, useful for chaining.