Deprecated. This class is deprecated and should not be used in new scripts.
A widget that serves as an "internal" hyperlink. That is, it is a link to
another state of the running application. It should behave exactly like
, save that it lays out
as an inline element, not block.
Hyperlink
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 InlineHyperlink documentation here.
Methods
Detailed documentation
addStyleDependentName(styleName)
Sets the dependent style name of this
.
InlineHyperlink
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
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink
addStyleName(styleName)
Adds a style name to this
.
InlineHyperlink
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
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink
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
setHTML(html)
Sets the HTML content of this
.InlineHyperlink
Parameters
Name | Type | Description |
---|---|---|
html | String | the new HTML |
Return
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink
setHeight(height)
Sets the height of this
.InlineHyperlink
Parameters
Name | Type | Description |
---|---|---|
height | String | the new height in any CSS unit such as "10px" or "50%". |
Return
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink
setId(id)
Sets the id of this
.InlineHyperlink
Parameters
Name | Type | Description |
---|---|---|
id | String | the new id, which can be used to retrieve the from
app.getElementById(id). |
Return
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink
setPixelSize(width, height)
Sets the size of this
in pixels.InlineHyperlink
Parameters
Name | Type | Description |
---|---|---|
width | Integer | the new width in pixels. |
height | Integer | the new height in pixels. |
Return
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink
setSize(width, height)
Sets the size of this
.InlineHyperlink
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
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink
setStyleAttribute(attribute, value)
Sets one of this
's style attributes to a new value.
InlineHyperlink
Possible attributes are the same as those available in CSS style sheets. Since some CSS code may be malicious, attributes are whitelisted explicitly and therefore some CSS attributes may not be available.
// 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 camelCase. ("fontSize", not "font-size"). |
value | String | the CSS value |
Return
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink
setStyleAttributes(attributes)
Sets this
's style attributes. This is a convenience method that is equivalent
to calling setStyleAttribute with every key/value pair in the attributes object.
InlineHyperlink
// Change the widget's background to black and text color to green.
widget.setStyleAttributes({background: "black", color: "green"});
Parameters
Name | Type | Description |
---|---|---|
attributes | Object | the CSS attributes and values to set. |
Return
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink
setStyleName(styleName)
Sets the style name of this
.
InlineHyperlink
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
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink
setStylePrimaryName(styleName)
Sets the primary style name of this
.
InlineHyperlink
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
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink
setTag(tag)
Sets the text tag of this
.InlineHyperlink
Parameters
Name | Type | Description |
---|---|---|
tag | String | the new text tag, which can be anything you wish to store with the widget. |
Return
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink
setText(text)
Set the display text of this
.InlineHyperlink
Parameters
Name | Type | Description |
---|---|---|
text | String | the new text. |
Return
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink
setTitle(title)
Sets the hover title of this
.
InlineHyperlink
Not all browsers will show this.
Parameters
Name | Type | Description |
---|---|---|
title | String | the hover title. |
Return
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink
setVisible(visible)
Sets whether this
is visible.InlineHyperlink
Parameters
Name | Type | Description |
---|---|---|
visible | Boolean | whether this should be visible or not. |
Return
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink
setWidth(width)
Sets the width of this
.InlineHyperlink
Parameters
Name | Type | Description |
---|---|---|
width | String | the new width in any CSS unit such as "10px" or "50%". |
Return
— the InlineHyperlink
itself, useful for chaining.InlineHyperlink