Olympe SDK

Class: Button

olympe.ui.std. Button

A Button is a simple UI representation of a 'push button'. It contains a label, used to display text, and is typically associated a callback to execute when being pressed by using onClickOrTap().

Example:

const button = new olympe.ui.std.Button(new Vector2(100, 50), "Push Me")
   .setPosition(new Vector2(250, 130))
   .setBorder(3, olympe.df.Color.black())
   .setFontSize(20)
   .setTextColor(olympe.df.Color.blue())
   .setBackgroundColor(olympe.df.Color.gray())
   .onClickOrTap(() => { console.log("Button pressed!") } );
mainLayout.appendChild(button, 'button');

Will display a button looking like this: button and it will print 'Button pressed!' on the console when pressed.

new Button( [dimension] [, label] [, themeClass])

Creates an instance of Button.

Parameters:
Name Type Argument Description
dimension olympe.df.PVector2 <optional>

Width & height for the button.
label olympe.df.POString | string <optional>

Text to display in the button.
themeClass olympe.df.POString | string <optional>

UI Theme class of button.
Implements:

Extends

Methods

<protected> _appendChild(child, childId, options)

Append a child to a layer.

Parameters:
Name Type Argument Description
child olympe.df.Proxy.<olympe.ui.std.DockableElement> | olympe.ui.std.DockableElement
childId string

ID of the child (must be unique in this layer)
options * <repeatable>

Can be used if this method is overridden
Inherited From:
Overrides:

<protected> _removeAllChildren()

Inherited From:
Overrides:

<protected> _removeChild(childId)

Remove a child from this layer.

Parameters:
Name Type Description
childId string

ID of the child to remove
Inherited From:
Overrides:

<abstract> appendChild(child, id, options)

Parameters:
Name Type Argument Description
child olympe.df.Proxy.<olympe.ui.std.DockableElement> | olympe.ui.std.DockableElement
id string
options * <repeatable>
Inherited From:
Overrides:
Returns:
Type
olympe.ui.std.Layer

authorizeOverflow()

Authorize the children of this layer to overflow the layer's borders

Inherited From:
Overrides:
Returns:

this

Type
olympe.ui.std.Layer

getFocus()

Checks whether this Element has the focus.

Warning: Focus may not be applicable on some elements, depending on the platform.

Inherited From:
Overrides:
Returns:

true if Element has focus.

Type
olympe.df.POBoolean

<protected> getGestureEvent()

Gets the gesture event manager attached to this element

Inherited From:
Overrides:
Returns:
Type
olympe.ui.events.GestureEventManager

getHeight()

Gets the height of this element.

Inherited From:
Overrides:
See:
Returns:

the height of this element.

Type
olympe.df.PONumber

getHTMLElement()

Return the DOM HTMLElement if exists (may be null)

Inherited From:
Overrides:
Returns:
Type
Element

<protected> getMouseEvent()

Gets the mouse event manager attached to this element.

Inherited From:
Overrides:
Returns:

the mouse event manager.

Type
olympe.ui.events.MouseEventManager

getParent()

Gets the parent, or container, of this element.

Inherited From:
Overrides:
Returns:

the parent of this element.

Type
olympe.ui.std.Element | olympe.df.Proxy

getPosition()

Gets the position (x,y) for this element.

Inherited From:
Overrides:
Returns:

Position of this element.

Type
olympe.df.PVector2

getUIProxyDockableElement()

Note: needs to be public because it is called by RootElement !

Inherited From:
Overrides:
Returns:

The proxy element from the UI thread

Type
olympe.uiapi.std.DockableElement

<protected> getUIProxyElement()

Returns the native UI element associated with this Element.

Inherited From:
Overrides:
Returns:

The proxy element from the UI thread.

Type
olympe.uiapi.std.Element

<protected> getUIProxyLayer()

Inherited From:
Overrides:
Returns:

Proxified UI object Layer

Type
olympe.uiapi.std.Layer

getWidth()

Gets the width of this element.

Inherited From:
Overrides:
See:
Returns:

the width of this element.

Type
olympe.df.PONumber

getX()

Gets the x coordinate of the position of this element.

Inherited From:
Overrides:
See:
Returns:

the x coordinate for this element.

Type
olympe.df.PONumber

getY()

Gets the y coordinate of the position of this element.

Inherited From:
Overrides:
See:
Returns:

the y coordinate for this element.

Type
olympe.df.PONumber

isDisabled()

Checks whether this button is disabled or not.

Returns:
Type
olympe.df.POBoolean

isHidden()

Checks whether this Element is hidden.

Inherited From:
Overrides:
Returns:

true is this element is hidden.

Type
olympe.df.POBoolean

refreshSize()

Refresh component internal size

Inherited From:
Overrides:

<abstract> removeChild(id)

Parameters:
Name Type Description
id string
Inherited From:
Overrides:
Returns:
Type
olympe.ui.std.Layer

removeTooltip()

Removes the tooltip from this element.

Inherited From:
Overrides:
Returns:

This element.

Type
olympe.ui.std.Element

setAccelerated(accelerated)

Sets whether this DockableElement movements should be calculated by the GPU.

Note: This function doesn't guarantee that the implementation will support GPU acceleration.

Parameters:
Name Type Description
accelerated olympe.df.POBoolean | olympe.df.Node | boolean

true if this DockableElement movements should be calculated by the GPU.
Inherited From:
Overrides:
Returns:

This DockableElement.

Type
olympe.ui.std.DockableElement

setAutoHeight(autoHeight [, padding])

Enables or disables the automatic height resizing of the button depending on the text of the label.

Parameters:
Name Type Argument Default Description
autoHeight olympe.df.POBoolean | olympe.df.Node | boolean

true to enable automatic resizing.
padding olympe.df.PONumber | olympe.df.Node | number <optional>
 0

Padding, in pixels, to use to the top and bottom when resizing.
Returns:

this Button.

Type
olympe.ui.std.Button

setAutoWidth(autoWidth [, sidePadding])

Enables or disables the automatic width resizing of the button depending on the text of the label.

Parameters:
Name Type Argument Default Description
autoWidth olympe.df.POBoolean | olympe.df.Node | boolean

true to enable automatic resizing.
sidePadding olympe.df.PONumber | olympe.df.Node | number <optional>
 0

Padding, in pixels, to use to the left and right when resizing.
Returns:

this Button.

Type
olympe.ui.std.Button

setBackgroundColor(color)

Sets the background color for this Element.

Parameters:
Name Type Description
color olympe.df.Proxy | olympe.df.Node | olympe.df.Color

The background color.
Inherited From:
Overrides:
Returns:

this Button.

Type
olympe.ui.std.Button

setBackgroundImage(url [, sizingMode] [, positioningMode] [, size] [, position])

Sets the background image for this Element.

Notes:

  • The size is ignored if the sizing mode is not set to MANUAL.
  • The position is ignored if the positioning mode is not set to MANUAL.
Parameters:
Name Type Argument Default Description
url olympe.df.POString | olympe.df.Node | string

URL for the image.
sizingMode olympe.ui.common.BackgroundImageSize | olympe.df.Proxy | olympe.df.Node <optional>
 AUTO

The sizing mode for the image.
positioningMode olympe.ui.common.BackgroundImagePosition | olympe.df.Proxy | olympe.df.Node <optional>
 TOPLEFT

The positioning mode for this image.
size olympe.df.Vector2 | olympe.df.Proxy | olympe.df.Node <optional>

Size, in pixel.
position olympe.df.Vector2 | olympe.df.Proxy | olympe.df.Node <optional>

Position of the image, in pixel. (0,0) if omitted.
Inherited From:
Overrides:
Returns:

this Element.

Type
olympe.ui.std.Element

setBackgroundImagePosition(position)

Sets the background image position for this Element.

Parameters:
Name Type Description
position olympe.df.Vector2 | olympe.df.Proxy | olympe.df.Node

The position.
Inherited From:
Overrides:
Returns:

this Element.

Type
olympe.ui.std.Element

setBackgroundImagePositionMode(positionMode)

Sets the position mode for the background image of this Element.

Parameters:
Name Type Description
positionMode olympe.ui.common.BackgroundImagePosition | olympe.df.Proxy | olympe.df.Node

The positioning mode for this image.
Inherited From:
Overrides:
Returns:

this Element.

Type
olympe.ui.std.Element

setBackgroundImageSize(size)

Sets the background image size for the this Element.

Parameters:
Name Type Description
size olympe.df.Vector2 | olympe.df.Proxy | olympe.df.Node

The image size, in pixels.
Inherited From:
Overrides:
Returns:

this Element.

Type
olympe.ui.std.Element

setBackgroundImageSizeMode(sizeMode)

Sets the sizing mode for the background image of this Element.

Parameters:
Name Type Description
sizeMode olympe.ui.common.BackgroundImageSize | olympe.df.Proxy | olympe.df.Node

The sizing mode.
Inherited From:
Overrides:
Returns:

this Element.

Type
olympe.ui.std.Element

setBackgroundImageSrc(src)

Sets the URL (or source) for the background image.

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

URL for the image.
Inherited From:
Overrides:
Returns:

this Element.

Type
olympe.ui.std.Element

setBlur()

Removes focus from this Element.

Warnings:

  • Focus may not be applicable on some elements, depending on the platform.
  • Elements not inside a container (screen, etc.) can't get the focus.
Inherited From:
Overrides:
Returns:

this Element.

Type
olympe.ui.std.Element

setBorder(width, color)

Sets the border width & color for this element. a width of 0 means no visible border.

Parameters:
Name Type Description
width olympe.df.ONumber | number | olympe.df.Node | olympe.df.Proxy

the width, in pixels, for the border
color olympe.df.Color | olympe.df.Node | olympe.df.Proxy

the color for the border
Inherited From:
Overrides:
Returns:

this Button.

Type
olympe.ui.std.Button

setBorderColor(color)

Set the border color on this element.

Parameters:
Name Type Description
color olympe.df.Color | olympe.df.Proxy.<olympe.df.Color>
Inherited From:
Overrides:
Returns:
Type
olympe.ui.std.DockableElement

setBorderWidth(width)

Set the border width on this element. a width of 0 means no visible border.

Parameters:
Name Type Description
width number | olympe.df.PONumber
Inherited From:
Overrides:
Returns:
Type
olympe.ui.std.DockableElement

setContextMenuEnabled(enabled)

Enable/disable context menu on this element.

Parameters:
Name Type Description
enabled boolean

true to enable the context menu, false to disable it.
Inherited From:
Overrides:
Returns:

this Element.

Type
olympe.ui.std.Element

setCornerRadius(radius)

Sets the rounded corner radius (in pixels) for this element.

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

Radius in pixels.
Inherited From:
Overrides:
Returns:

this DockableElement.

Type
olympe.ui.std.DockableElement

setDefaultTextColor(color)

Sets the label text color to use for this button when it is in default (enabled, not pressed) state.

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

The text color.
Returns:

this Button.

Type
olympe.ui.std.Button

setDimension(dimension)

Sets the dimension (width, height) for this element.

Parameters:
Name Type Description
dimension olympe.df.Vector2 | olympe.df.Proxy | olympe.df.Node

Dimension of this element.
Inherited From:
Overrides:
Returns:
Type
olympe.ui.std.Button

setDisabled(disabled)

Enables or enables this button. A disabled button can not be interacted with but is still visible.

Parameters:
Name Type Description
disabled olympe.df.POBoolean | olympe.df.Node | boolean

true to disable this button, false to enable it
Returns:

this Button

Type
olympe.ui.std.Button

setDisabledBackgroundColor(color)

Sets the background color to use for this button when it is in disabled state.

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

The background color.
Returns:

this Button.

Type
olympe.ui.std.Button

setDisabledBorderColor(color)

Sets the border color to use for this button when it is in disabled state.

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

The border color.
Returns:

this Button.

Type
olympe.ui.std.Button

setDisabledBorderWidth(width)

Sets the border width to use for this button when it is in disabled state.

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

The border width.
Returns:

this Button.

Type
olympe.ui.std.Button

setDisabledTextColor(color)

Sets the label text color to use for this button when it is in disabled state.

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

The text color.
Returns:

this Button.

Type
olympe.ui.std.Button

setFocus()

Gives the focus to this Element.

Warnings:

  • Focus may not be applicable on some elements, depending on the platform.
  • Elements not inside a container (screen, etc.) can't get the focus.
Inherited From:
Overrides:
Returns:

this Element.

Type
olympe.ui.std.Element

setFontColor(color)

Sets the label text color to use for this button when it is in default (enabled, not pressed) state.

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

The text color.
Deprecated:
Returns:

this Button.

Type
olympe.ui.std.Button

setFontFamily(fontFamily)

Sets the label font family for the bake of this Button.

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

the font family.
Implements:
Returns:

this Button.

Type
olympe.ui.std.Button

setFontSize(fontSize)

Sets the label font size for the text of this Button.

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

The font size, in pixels.
Implements:
Returns:

this Button.

Type
olympe.ui.std.Button

setFontStyle(fontStyle)

Sets the label font style (normal, italic, ...) for the text of this Button.

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

The style.
Implements:
Returns:

this Button.

Type
olympe.ui.std.Button

setFontWeight(fontWeight)

Sets the label font weight for the label of this Button.

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

The font weight.
Implements:
Returns:

this Button.

Type
olympe.ui.std.Button

setHidden(hidden)

Sets whether this Element is hidden or not. A hidden element will not appear on the screen.

Parameters:
Name Type Description
hidden olympe.df.POBoolean | boolean | olympe.df.Node

true if content must be hidden, false otherwise.
Inherited From:
Overrides:
Returns:

this Element.

Type
olympe.ui.std.Element

setHoverBackgroundColor(color)

Sets the background color to use for this button when it is in hover state.

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

The background color.
Returns:

this Button.

Type
olympe.ui.std.Button

setHoveredBorderColor(color)

Sets the border color to use for this button when it is in hovered state.

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

The border color.
Returns:

this Button.

Type
olympe.ui.std.Button

setHoveredBorderWidth(width)

Sets the border width to use for this button when it is in hovered state.

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

The border width.
Returns:

this Button.

Type
olympe.ui.std.Button

setIcon(code)

Sets the icon to display after the label of this Button.

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

The icon.
Returns:

this Button.

Type
olympe.ui.std.Button

setIconPadding( [padding])

Enables or disables the automatic height resizing of the button depending on the text of the label.

Parameters:
Name Type Argument Default Description
padding olympe.df.PONumber | olympe.df.Node | number <optional>
 0

Padding, in pixels, to use to the top and bottom when resizing.
Returns:

this Button.

Type
olympe.ui.std.Button

setIgnoreUserInteraction( [ignore])

Disables mouse events for this element. However, mouse events will target its descendants unless they are manually set to also ignore user interactions.

Parameters:
Name Type Argument Default Description
ignore boolean | olympe.df.POBoolean <optional>
 false

ignore true to make this element ignore mouse events and pass them to its children.
Inherited From:
Overrides:
Returns:

this Element.

Type
olympe.ui.std.Element

setLabel(label)

Parameters:
Name Type Description
label olympe.df.OString | string | olympe.df.Node | olympe.df.Proxy
Deprecated:
  • Should use setText function instead (for consistency and to cope with interface olympe.ui.std.DockableElementWithText)
Returns:

this Button

Type
olympe.ui.std.Button

setOpacity(opacity)

Sets the opacity, or alpha channel, for this Element. This is a float value between 0 and 1. 0 being transparent and 1 being opaque.

Parameters:
Name Type Description
opacity olympe.df.ONumber | number | olympe.df.Proxy | olympe.df.Node

the opacity (between 0 and 1).
Inherited From:
Overrides:
Returns:

this Element.

Type
olympe.ui.std.Element

setParent(parent)

Sets the parent of this element.

Important: This method must be called when this element is added to a container or layout.

Parameters:
Name Type Description
parent olympe.df.Proxy.<olympe.ui.std.Element> | olympe.ui.std.Element

The parent for this element.
Inherited From:
Overrides:
Returns:

This DockableElement.

Type
olympe.ui.std.DockableElement

setPosition(position)

Sets the position (x,y) for this Element.

Parameters:
Name Type Description
position olympe.df.Vector2 | olympe.df.Proxy | olympe.df.Node

The position of this element.
Inherited From:
Overrides:
Returns:

this DockableElement.

Type
olympe.ui.std.DockableElement

setPressedBackgroundColor(color)

Sets the background color to use for this button when it is in pressed state.

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

The background color.
Returns:

this Button.

Type
olympe.ui.std.Button

setPressedBorderColor(color)

Sets the border color to use for this button when it is in pressed state.

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

The border color.
Returns:

this Button.

Type
olympe.ui.std.Button

setPressedBorderWidth(width)

Sets the border width to use for this button when it is in pressed state.

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

The border width.
Returns:

this Button.

Type
olympe.ui.std.Button

setPressedTextColor(color)

Sets the label text color to use for this button when it is in pressed state.

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

The text color.
Returns:

this Button.

Type
olympe.ui.std.Button

setRotationAngle(angle)

Sets the rotation angle (in degree) for this element.

Parameters:
Name Type Description
angle olympe.df.ONumber | number | olympe.df.Node | olympe.df.Proxy

the angle, in degree.
Inherited From:
Overrides:
Returns:

This DockableElement.

Type
olympe.ui.std.DockableElement

setScale(scale)

Sets the scaling factor for the width and height of this element.

Parameters:
Name Type Description
scale olympe.df.PVector2 | olympe.df.Node

scaling vector (w, h).
Inherited From:
Overrides:
Returns:

This DockableElement.

Type
olympe.ui.std.DockableElement

setShadow( [offset] [, radius] [, spread] [, color] [, inset])

Set shadow on this DockableElement. A shadow is defined by its offset, the blur radius, the spread radius (all in pixels) and a base color. A shadow is by default 'external, but can be made internal by setting the 'inset' parameter to true`.

Parameters:
Name Type Argument Default Description
offset olympe.df.Vector2 | olympe.df.Node | olympe.df.Proxy.<olympe.df.Vector2> <optional>
 0

Offset in pixels.
radius olympe.df.PONumber | olympe.df.Node | number <optional>
 0

Blur radius in pixels.
spread olympe.df.PONumber | olympe.df.Node | number <optional>
 0

Spread in pixels.
color olympe.df.Color | olympe.df.Node | olympe.df.Proxy.<olympe.df.Color> <optional>
 '#000000'

Shadow color.
inset olympe.df.POBoolean | olympe.df.Node | boolean <optional>
 false

true if the shadow is inset.
Inherited From:
Overrides:
Returns:

This DockableElement.

Type
olympe.ui.std.DockableElement

setShadowPSStyle(color, angle, distance, spread, size, inset)

Set shadow on this DockableElement as done in Photoshop.

Parameters:
Name Type Description
color olympe.df.Color | olympe.df.Node | olympe.df.Proxy.<olympe.df.Color>

Shadow Color.
angle olympe.df.PONumber | olympe.df.Node | number

Angle, in radians.
distance olympe.df.PONumber | olympe.df.Node | number

Distance, in pixels.
spread olympe.df.PONumber | olympe.df.Node | number

Spread in pixels.
size olympe.df.PONumber | olympe.df.Node | number

Size, in pixels.
inset olympe.df.POBoolean | olympe.df.Node | boolean

true if the shadow is inset.
Inherited From:
Overrides:
Returns:

This DockableElement.

Type
olympe.ui.std.DockableElement

setStyle(style, value)

Parameters:
Name Type Description
style string

CSS style name
value string | number

CSS style value
Inherited From:
Overrides:
Returns:

this Element.

Type
olympe.ui.std.Element

setTabIndex(tabIndex)

Sets the tab index to this Element. Tab Index defines the tabulation or 'next' order while going through a form.

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

The tab index.
Inherited From:
Overrides:
Returns:

this Element.

Type
olympe.ui.std.Element

setText(label)

Sets the text to display as the label of this Button.

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

The text.
Implements:
Returns:

this Button.

Type
olympe.ui.std.Button

setTextColor(textColor)

Set the default color for the label of this Button.

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

The color.
Implements:
See:
Returns:

this Button.

Type
olympe.ui.std.Button

setTextHorizontalAlign(textAlign)

Sets the horizontal alignment for the label of this button.

Parameters:
Name Type Description
textAlign olympe.ui.common.HorizontalAlign | olympe.df.Proxy | olympe.df.Node

The horizontal alignment.
Implements:
Returns:

this Button.

Type
olympe.ui.std.Button

setTextOverflow(overflowStyle)

Sets the text overflow to the label of this Button. overflow styles are defined in olympe.ui.common.TextOverflow:

  • ELLIPSIS
  • CLIP
  • FADE with the default text overflow behaviour being "CLIP". N.B.: as of now, wrapping whitespaces will override the text overflow property (i.e. text clipped if too long)
Parameters:
Name Type Description
overflowStyle olympe.ui.common.TextOverflow | string | olympe.df.Node

Defaults to 'clip'
Returns:

this Button.

Type
olympe.ui.std.Button

setTextVerticalAlign(textAlign)

Sets the horizontal alignment for the label of this button.

Parameters:
Name Type Description
textAlign olympe.ui.common.VerticalAlign | olympe.df.Proxy | olympe.df.Node

The vertical alignment.
Implements:
Returns:

this Button.

Type
olympe.ui.std.Button

setThemeClass(themeClass)

Method to override if this dockable element supports themes.

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

The theme class.
Inherited From:
Overrides:
Returns:
Type
olympe.ui.std.Button

setTooltip(text [, options])

Assigns a tooltip to that element that will show up when the mouse hovers over it.

Parameters:
Name Type Argument Description
text olympe.df.POString

The text of the tooltip.
options Object <optional>

Various options for displaying the tooltip.

Properties
Name Type Argument Description
position olympe.df.PVector2 <optional>

The absolute position of the tooltip.
background olympe.df.PColor <optional>

The background color.
foreground olympe.df.PColor <optional>

The text color.
fontSize olympe.df.PONumber <optional>

The font size.
borderSize olympe.df.PONumber <optional>

The size of the border. Default is 1.
borderColor olympe.df.PColor <optional>

The color of the border. Default is black.
delay olympe.df.ONumber | number <optional>

The delay, in milliseconds, before showing the tooltip. Default is 500.
startingPos olympe.df.Vector2 <optional>

The starting position of the mouse. Default is (0,0).
theme olympe.df.POString <optional>

The theme class to apply to this tooltip.
Inherited From:
Overrides:
Returns:

This Element.

Type
olympe.ui.std.Element

setUniformScale(scale)

Sets the scaling factor for this element.

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

The scaling factor.
Inherited From:
Overrides:
Returns:

This DockableElement.

Type
olympe.ui.std.DockableElement

setWrapWhiteSpaces(doWrap)

Sets the text "wrap whitespaces" property, its default being "false". N.B.: as of now, wrapping whitespaces will override the text overflow property (i.e. text clipped if too long)

Parameters:
Name Type Description
doWrap olympe.df.POBoolean | boolean | olympe.df.Node
Returns:

this Button.

Type
olympe.ui.std.Button

setZIndex(zIndex)

Sets the z-index for this element. This determines how elements are layered when they overlap on the screen. Higher Z-index elements are placed on top of lower Z-index elements.

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

Index of element on z axis.
Inherited From:
Overrides:
Returns:

This DockableElement.

Type
olympe.ui.std.DockableElement