A simple panel that makes its contents focusable, and adds the ability to catch mouse and keyboard events.
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();
var focus = app.createFocusPanel();
var flow = app.createFlowPanel();
flow.add(app.createButton("button 1"));
flow.add(app.createButton("button 2"));
focus.add(flow);
app.add(focus);
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 FocusPanel documentation here.
Methods
Method | Return type | Brief description |
---|---|---|
add(widget) | FocusPanel | Add a widget to the FocusPanel . |
addBlurHandler(handler) | FocusPanel | Add a handler for blur events (losing keyboard focus). |
addClickHandler(handler) | FocusPanel | Add a handler for click events. |
addFocusHandler(handler) | FocusPanel | Add a handler for focus events (gaining keyboard focus). |
addKeyDownHandler(handler) | FocusPanel | Add a handler for key down events. |
addKeyPressHandler(handler) | FocusPanel | Add a handler for key press events. |
addKeyUpHandler(handler) | FocusPanel | Add a handler for key up events. |
addMouseDownHandler(handler) | FocusPanel | Add a handler for mouse down events. |
addMouseMoveHandler(handler) | FocusPanel | Add a handler for mouse move events. |
addMouseOutHandler(handler) | FocusPanel | Add a handler for mouse out events. |
addMouseOverHandler(handler) | FocusPanel | Add a handler for mouse move events. |
addMouseUpHandler(handler) | FocusPanel | Add a handler for mouse up events. |
addMouseWheelHandler(handler) | FocusPanel | Add a handler for mouse wheel events. |
addStyleDependentName(styleName) | FocusPanel | Sets the dependent style name of this FocusPanel . |
addStyleName(styleName) | FocusPanel | Adds a style name to this FocusPanel . |
clear() | FocusPanel | Remove all widgets from the FocusPanel . |
getId() | String | Returns the id that has been assigned to this object. |
getTag() | String | Gets the text tag of this FocusPanel . |
getType() | String | Gets the type of this object. |
setFocus(focus) | FocusPanel | Explicitly focus/unfocus this FocusPanel . |
setHeight(height) | FocusPanel | Sets the height of this FocusPanel . |
setId(id) | FocusPanel | Sets the id of this FocusPanel . |
setPixelSize(width, height) | FocusPanel | Sets the size of this FocusPanel in pixels. |
setSize(width, height) | FocusPanel | Sets the size of this FocusPanel . |
setStyleAttribute(attribute, value) | FocusPanel | Sets one of this FocusPanel 's style attributes to a new value. |
setStyleAttributes(attributes) | FocusPanel | Sets this FocusPanel 's style attributes. |
setStyleName(styleName) | FocusPanel | Sets the style name of this FocusPanel . |
setStylePrimaryName(styleName) | FocusPanel | Sets the primary style name of this FocusPanel . |
setTabIndex(index) | FocusPanel | Sets the FocusPanel 's position in the tab index. |
setTag(tag) | FocusPanel | Sets the text tag of this FocusPanel . |
setTitle(title) | FocusPanel | Sets the hover title of this FocusPanel . |
setVisible(visible) | FocusPanel | Sets whether this FocusPanel is visible. |
setWidget(widget) | FocusPanel | Sets the widget inside this FocusPanel , removing anything previously there. |
setWidth(width) | FocusPanel | Sets the width of this FocusPanel . |
Detailed documentation
add(widget)
Add a widget to the FocusPanel
.
Parameters
Name | Type | Description |
---|---|---|
widget | Widget | the widget to add. |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
addBlurHandler(handler)
Add a handler for blur events (losing keyboard focus).
Note that you can have multiple handlers for the same event on the same widget. They will be
called in the order that they were added to the widget, although
ServerHandler
s may
appear to happen simultaneously.
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 button = app.createButton("a button");
var handler = app.createServerHandler("handlerFunction");
button.addBlurHandler(handler);
app.add(button);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "blur".
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.Parameters
Name | Type | Description |
---|---|---|
handler | Handler | the handler to execute when the event occurs. This can be a
ClientHandler or a
ServerHandler . |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
addClickHandler(handler)
Add a handler for click events.
Note that you can have multiple handlers for the same event on the same widget. They will be
called in the order that they were added to the widget, although
ServerHandler
s may
appear to happen simultaneously.
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 button = app.createButton("a button");
var handler = app.createServerHandler("handlerFunction");
button.addClickHandler(handler);
app.add(button);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "click".
var eventType = parameter.eventType;
// the id of the widget that fired this event.
var source = parameter.source;
// mouse x and y position relative to the widget that fired the event.
var x = parameter.x;
var y = parameter.y;
// mouse x and y position within the browser window's client area.
var clientX = parameter.clientX;
var clientY = parameter.clientY;
// mouse x and y position within the user's display.
var screenX = parameter.screenX;
var screenY = parameter.screenY;
// the mouse button used. Left is 1, right is 2, and middle is 4.
var button = parameter.button;
// whether the various modifier keys were also pressed (true or false)
var shift = parameter.shift;
var alt = parameter.alt;
var ctrl = parameter.ctrl;
var meta = parameter.meta;
}
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.Parameters
Name | Type | Description |
---|---|---|
handler | Handler | the handler to execute when the event occurs. This can be a
ClientHandler or a
ServerHandler . |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
addFocusHandler(handler)
Add a handler for focus events (gaining keyboard focus).
Note that you can have multiple handlers for the same event on the same widget. They will be
called in the order that they were added to the widget, although
ServerHandler
s may
appear to happen simultaneously.
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 button = app.createButton("a button");
var handler = app.createServerHandler("handlerFunction");
button.addFocusHandler(handler);
app.add(button);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "focus".
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.Parameters
Name | Type | Description |
---|---|---|
handler | Handler | the handler to execute when the event occurs. This can be a
ClientHandler or a
ServerHandler . |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
addKeyDownHandler(handler)
Add a handler for key down events.
Note that you can have multiple handlers for the same event on the same widget. They will be
called in the order that they were added to the widget, although
ServerHandler
s may
appear to happen simultaneously.
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 button = app.createButton("a button");
var handler = app.createServerHandler("handlerFunction");
button.addKeyDownHandler(handler);
app.add(button);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "keydown".
var eventType = parameter.eventType;
// the id of the widget that fired this event.
var source = parameter.source;
// what key was pressed. See below for a link explaining what these values mean.
var charCode = parameter.charCode;
var keyCode = parameter.keyCode;
// whether the various modifier keys were also pressed (true or false)
var shift = parameter.shift;
var alt = parameter.alt;
var ctrl = parameter.ctrl;
var meta = parameter.meta;
}
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
FocusPanel
— the FocusPanel
itself, useful for chaining.
addKeyPressHandler(handler)
Add a handler for key press events.
Note that you can have multiple handlers for the same event on the same widget. They will be
called in the order that they were added to the widget, although
ServerHandler
s may
appear to happen simultaneously.
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 button = app.createButton("a button");
var handler = app.createServerHandler("handlerFunction");
button.addKeyPressHandler(handler);
app.add(button);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "keypress".
var eventType = parameter.eventType;
// the id of the widget that fired this event.
var source = parameter.source;
// what key was pressed. See below for a link explaining what these values mean.
var charCode = parameter.charCode;
var keyCode = parameter.keyCode;
// whether the various modifier keys were also pressed (true or false)
var shift = parameter.shift;
var alt = parameter.alt;
var ctrl = parameter.ctrl;
var meta = parameter.meta;
}
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
FocusPanel
— the FocusPanel
itself, useful for chaining.
addKeyUpHandler(handler)
Add a handler for key up events.
Note that you can have multiple handlers for the same event on the same widget. They will be
called in the order that they were added to the widget, although
ServerHandler
s may
appear to happen simultaneously.
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 button = app.createButton("a button");
var handler = app.createServerHandler("handlerFunction");
button.addKeyUpHandler(handler);
app.add(button);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "keyup".
var eventType = parameter.eventType;
// the id of the widget that fired this event.
var source = parameter.source;
// what key was pressed. See below for a link explaining what these values mean.
var charCode = parameter.charCode;
var keyCode = parameter.keyCode;
// whether the various modifier keys were also pressed (true or false)
var shift = parameter.shift;
var alt = parameter.alt;
var ctrl = parameter.ctrl;
var meta = parameter.meta;
}
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
FocusPanel
— the FocusPanel
itself, useful for chaining.
addMouseDownHandler(handler)
Add a handler for mouse down events.
Note that you can have multiple handlers for the same event on the same widget. They will be
called in the order that they were added to the widget, although
ServerHandler
s may
appear to happen simultaneously.
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 button = app.createButton("a button");
var handler = app.createServerHandler("handlerFunction");
button.addMouseDownHandler(handler);
app.add(button);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "mousedown".
var eventType = parameter.eventType;
// the id of the widget that fired this event.
var source = parameter.source;
// mouse x and y position relative to the widget that fired the event.
var x = parameter.x;
var y = parameter.y;
// mouse x and y position within the browser window's client area.
var clientX = parameter.clientX;
var clientY = parameter.clientY;
// mouse x and y position within the user's display.
var screenX = parameter.screenX;
var screenY = parameter.screenY;
// the mouse button used. Left is 1, right is 2, and middle is 4.
var button = parameter.button;
// whether the various modifier keys were also pressed (true or false)
var shift = parameter.shift;
var alt = parameter.alt;
var ctrl = parameter.ctrl;
var meta = parameter.meta;
}
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.Parameters
Name | Type | Description |
---|---|---|
handler | Handler | the handler to execute when the event occurs. This can be a
ClientHandler or a
ServerHandler . |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
addMouseMoveHandler(handler)
Add a handler for mouse move events.
Note that you can have multiple handlers for the same event on the same widget. They will be
called in the order that they were added to the widget, although
ServerHandler
s may
appear to happen simultaneously.
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 button = app.createButton("a button");
var handler = app.createServerHandler("handlerFunction");
button.addMouseMoveHandler(handler);
app.add(button);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "mousemove".
var eventType = parameter.eventType;
// the id of the widget that fired this event.
var source = parameter.source;
// mouse x and y position relative to the widget that fired the event.
var x = parameter.x;
var y = parameter.y;
// mouse x and y position within the browser window's client area.
var clientX = parameter.clientX;
var clientY = parameter.clientY;
// mouse x and y position within the user's display.
var screenX = parameter.screenX;
var screenY = parameter.screenY;
// the mouse button used. Left is 1, right is 2, and middle is 4.
var button = parameter.button;
// whether the various modifier keys were also pressed (true or false)
var shift = parameter.shift;
var alt = parameter.alt;
var ctrl = parameter.ctrl;
var meta = parameter.meta;
}
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.Parameters
Name | Type | Description |
---|---|---|
handler | Handler | the handler to execute when the event occurs. This can be a
ClientHandler or a
ServerHandler . |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
addMouseOutHandler(handler)
Add a handler for mouse out events.
Note that you can have multiple handlers for the same event on the same widget. They will be
called in the order that they were added to the widget, although
ServerHandler
s may
appear to happen simultaneously.
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 button = app.createButton("a button");
var handler = app.createServerHandler("handlerFunction");
button.addMouseOutHandler(handler);
app.add(button);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "mouseout".
var eventType = parameter.eventType;
// the id of the widget that fired this event.
var source = parameter.source;
// mouse x and y position relative to the widget that fired the event.
var x = parameter.x;
var y = parameter.y;
// mouse x and y position within the browser window's client area.
var clientX = parameter.clientX;
var clientY = parameter.clientY;
// mouse x and y position within the user's display.
var screenX = parameter.screenX;
var screenY = parameter.screenY;
// the mouse button used. Left is 1, right is 2, and middle is 4.
var button = parameter.button;
// whether the various modifier keys were also pressed (true or false)
var shift = parameter.shift;
var alt = parameter.alt;
var ctrl = parameter.ctrl;
var meta = parameter.meta;
}
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.Parameters
Name | Type | Description |
---|---|---|
handler | Handler | the handler to execute when the event occurs. This can be a
ClientHandler or a
ServerHandler . |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
addMouseOverHandler(handler)
Add a handler for mouse move events.
Note that you can have multiple handlers for the same event on the same widget. They will be
called in the order that they were added to the widget, although
ServerHandler
s may
appear to happen simultaneously.
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 button = app.createButton("a button");
var handler = app.createServerHandler("handlerFunction");
button.addMouseOverHandler(handler);
app.add(button);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "mousover".
var eventType = parameter.eventType;
// the id of the widget that fired this event.
var source = parameter.source;
// mouse x and y position relative to the widget that fired the event.
var x = parameter.x;
var y = parameter.y;
// mouse x and y position within the browser window's client area.
var clientX = parameter.clientX;
var clientY = parameter.clientY;
// mouse x and y position within the user's display.
var screenX = parameter.screenX;
var screenY = parameter.screenY;
// the mouse button used. Left is 1, right is 2, and middle is 4.
var button = parameter.button;
// whether the various modifier keys were also pressed (true or false)
var shift = parameter.shift;
var alt = parameter.alt;
var ctrl = parameter.ctrl;
var meta = parameter.meta;
}
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.Parameters
Name | Type | Description |
---|---|---|
handler | Handler | the handler to execute when the event occurs. This can be a
ClientHandler or a
ServerHandler . |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
addMouseUpHandler(handler)
Add a handler for mouse up events.
Note that you can have multiple handlers for the same event on the same widget. They will be
called in the order that they were added to the widget, although
ServerHandler
s may
appear to happen simultaneously.
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 button = app.createButton("a button");
var handler = app.createServerHandler("handlerFunction");
button.addMouseUpHandler(handler);
app.add(button);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "mouseup".
var eventType = parameter.eventType;
// the id of the widget that fired this event.
var source = parameter.source;
// mouse x and y position relative to the widget that fired the event.
var x = parameter.x;
var y = parameter.y;
// mouse x and y position within the browser window's client area.
var clientX = parameter.clientX;
var clientY = parameter.clientY;
// mouse x and y position within the user's display.
var screenX = parameter.screenX;
var screenY = parameter.screenY;
// the mouse button used. Left is 1, right is 2, and middle is 4.
var button = parameter.button;
// whether the various modifier keys were also pressed (true or false)
var shift = parameter.shift;
var alt = parameter.alt;
var ctrl = parameter.ctrl;
var meta = parameter.meta;
}
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.Parameters
Name | Type | Description |
---|---|---|
handler | Handler | the handler to execute when the event occurs. This can be a
ClientHandler or a
ServerHandler . |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
addMouseWheelHandler(handler)
Add a handler for mouse wheel events.
Note that you can have multiple handlers for the same event on the same widget. They will be
called in the order that they were added to the widget, although
ServerHandler
s may
appear to happen simultaneously.
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 button = app.createButton("a button");
var handler = app.createServerHandler("handlerFunction");
button.addMouseWheelHandler(handler);
app.add(button);
return app;
}
function handlerFunction(eventInfo) {
var parameter = eventInfo.parameter;
// the type of event, in this case "mousewheel".
var eventType = parameter.eventType;
// the id of the widget that fired this event.
var source = parameter.source;
// mouse x and y position relative to the widget that fired the event.
var x = parameter.x;
var y = parameter.y;
// mouse x and y position within the browser window's client area.
var clientX = parameter.clientX;
var clientY = parameter.clientY;
// mouse x and y position within the user's display.
var screenX = parameter.screenX;
var screenY = parameter.screenY;
// the mouse button used. Left is 1, right is 2, and middle is 4.
var button = parameter.button;
// whether the various modifier keys were also pressed (true or false)
var shift = parameter.shift;
var alt = parameter.alt;
var ctrl = parameter.ctrl;
var meta = parameter.meta;
}
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.Parameters
Name | Type | Description |
---|---|---|
handler | Handler | the handler to execute when the event occurs. This can be a
ClientHandler or a
ServerHandler . |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
addStyleDependentName(styleName)
Sets the dependent style name of this FocusPanel
.
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
FocusPanel
— the FocusPanel
itself, useful for chaining.
addStyleName(styleName)
Adds a style name to this FocusPanel
.
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
FocusPanel
— the FocusPanel
itself, useful for chaining.
clear()
Remove all widgets from the FocusPanel
.
Return
FocusPanel
— the FocusPanel
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
setFocus(focus)
Explicitly focus/unfocus this FocusPanel
.
Only one widget can have focus at a time, and the widget that does will receive all keyboard events.
Parameters
Name | Type | Description |
---|---|---|
focus | Boolean | whether the FocusPanel should have the current focus. |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
setHeight(height)
Sets the height of this FocusPanel
.
Parameters
Name | Type | Description |
---|---|---|
height | String | the new height in any CSS unit such as "10px" or "50%". |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
setId(id)
Sets the id of this FocusPanel
.
Parameters
Name | Type | Description |
---|---|---|
id | String | the new id, which can be used to retrieve the FocusPanel from
app.getElementById(id). |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
setPixelSize(width, height)
Sets the size of this FocusPanel
in pixels.
Parameters
Name | Type | Description |
---|---|---|
width | Integer | the new width in pixels. |
height | Integer | the new height in pixels. |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
setSize(width, height)
Sets the size of this FocusPanel
.
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
FocusPanel
— the FocusPanel
itself, useful for chaining.
setStyleAttribute(attribute, value)
Sets one of this FocusPanel
'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
FocusPanel
— the FocusPanel
itself, useful for chaining.
setStyleAttributes(attributes)
Sets this FocusPanel
'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
FocusPanel
— the FocusPanel
itself, useful for chaining.
setStyleName(styleName)
Sets the style name of this FocusPanel
.
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
FocusPanel
— the FocusPanel
itself, useful for chaining.
setStylePrimaryName(styleName)
Sets the primary style name of this FocusPanel
.
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
FocusPanel
— the FocusPanel
itself, useful for chaining.
setTabIndex(index)
Sets the FocusPanel
's position in the tab index.
If more than one widget has the same tab index, each such widget will receive focus in an arbitrary order. Setting the tab index to -1 will cause this widget to be removed from the tab order.
Parameters
Name | Type | Description |
---|---|---|
index | Integer | the new tab index. |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
setTag(tag)
Sets the text tag of this FocusPanel
.
Parameters
Name | Type | Description |
---|---|---|
tag | String | the new text tag, which can be anything you wish to store with the widget. |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
setTitle(title)
Sets the hover title of this FocusPanel
.
Not all browsers will show this.
Parameters
Name | Type | Description |
---|---|---|
title | String | the hover title. |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
setVisible(visible)
Sets whether this FocusPanel
is visible.
Parameters
Name | Type | Description |
---|---|---|
visible | Boolean | whether this FocusPanel should be visible or not. |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
setWidget(widget)
Sets the widget inside this FocusPanel
, removing anything previously there.
Parameters
Name | Type | Description |
---|---|---|
widget | Widget | the widget to put in this FocusPanel . |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.
setWidth(width)
Sets the width of this FocusPanel
.
Parameters
Name | Type | Description |
---|---|---|
width | String | the new width in any CSS unit such as "10px" or "50%". |
Return
FocusPanel
— the FocusPanel
itself, useful for chaining.