Olympe SDK

Interface: DockableElementWithText

olympe.ui.std. DockableElementWithText

A DockableElementWithText is a dockable element that contains text. This interface provides the various controls (set text, set font, etc...) common to all elements with text (Label, Button, ...)

Creates a DockableElementWithText.

Methods

<abstract> setFontFamily(fontFamily)

Sets the font family for this element.

Parameters:
Name Type Description
fontFamily olympe.df.POString | string | olympe.df.Node

The font family name.
Returns:

This element.

Type
olympe.ui.std.DockableElementWithText

<abstract> setFontSize(fontSize)

Sets the font size for this element.

Parameters:
Name Type Description
fontSize olympe.df.PONumber | number | olympe.df.Node

The font size.
Returns:

This element.

Type
olympe.ui.std.DockableElementWithText

<abstract> setFontStyle(fontStyle)

Sets the font style (normal, italic, ...) for this element.

Parameters:
Name Type Description
fontStyle olympe.ui.common.FontStyle | olympe.df.Proxy.<olympe.ui.common.FontStyle> | olympe.df.Node

the font style (normal, italic, ...)
Returns:

This element.

Type
olympe.ui.std.DockableElementWithText

<abstract> setFontWeight(fontWeight)

Sets the font weight for this element.

Parameters:
Name Type Description
fontWeight olympe.df.PONumber | number | olympe.df.Node

The weight of the font.
Returns:

This element.

Type
olympe.ui.std.DockableElementWithText

<abstract> setText(text)

Sets the text for this element.

Parameters:
Name Type Description
text olympe.df.POString | string | olympe.df.Node

Text of this label. Following HTML tags are supported: , ,
,
, , , , , , , , , ,

Returns:

This element.

Type
olympe.ui.std.DockableElementWithText

<abstract> setTextColor(textColor)

Sets the text color for this element.

Parameters:
Name Type Description
textColor olympe.df.PColor | olympe.df.Node

The color
Returns:

This element.

Type
olympe.ui.std.DockableElementWithText

<abstract> setTextHorizontalAlign(alignment)

Sets the text horizontal alignment (left, center, ...) for this element.

Parameters:
Name Type Description
alignment olympe.df.Proxy.<olympe.ui.common.HorizontalAlign> | olympe.df.Node | olympe.ui.common.HorizontalAlign

The horizontal alignment
Returns:

This element.

Type
olympe.ui.std.DockableElementWithText

<abstract> setTextVerticalAlign(alignment)

Sets the text vertical alignment (top, middle, ...) for this element.

Parameters:
Name Type Description
alignment olympe.df.Proxy.<olympe.ui.common.VerticalAlign> | olympe.df.Node | olympe.ui.common.VerticalAlign

the vertical alignment
Returns:

This element.

Type
olympe.ui.std.DockableElementWithText