All Implemented Interfaces:

kotlin.Cloneable
```
public class Button
extends ContainingComponent
                    
```
A button, that supports two images and a text object.

Since:

0.17.3

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final ButtonProperties`	`properties`
`private final transient Image`	`leftImage`
`private final transient Image`	`rightImage`
`private final transient Text`	`text`
`private String`	`string`
`private final ArrayList<Component>`	`children`
`private transient PolyColor.Animated`	`color`
`private transient Drawable`	`parent`
`private transient Layout`	`layout`
`private transient Boolean`	`consumesHover`
`private Boolean`	`disabled`
`private Vec2<Unit>`	`size`
`private final transient HashMap<Event, Function2<Drawable, Event, Boolean>>`	`eventHandlers`
`private transient String`	`simpleName`
`private transient Renderer`	`renderer`
`private transient PolyUI`	`polyUI`
`private Boolean`	`acceptsInput`
`private final transient Byte`	`initStage`
`private final transient Boolean`	`mouseOver`
`private transient Boolean`	`renders`
`private Float`	`x`
`private Float`	`y`
`private Float`	`width`
`private Float`	`height`
`private Boolean`	`exists`
`private transient Float`	`trueX`
`private transient Float`	`trueY`
`private final Unit.Type`	`atType`
`private final Unit.Type`	`sizeType`
`private final Boolean`	`isDynamic`
`private Double`	`rotation`
`private Double`	`skewX`
`private Double`	`skewY`
`private Float`	`scaleX`
`private Float`	`scaleY`
`private Float`	`alpha`
`private transient Float`	`acx`
`private transient Float`	`acy`
`private final Vec2<Unit>`	`at`
`private final Boolean`	`rawResize`

Constructor Summary

Constructors
Constructor	Description
`Button(ButtonProperties properties, Vec2<Unit> at, Vec2<Unit> size, PolyImage left, Translator.Text text, Unit.Pixel fontSize, PolyImage right, Boolean acceptsInput, Function1<EventDSL<Button>, Unit> events)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`ButtonProperties`	`getProperties()`
`final Image`	`getLeftImage()`
`final Image`	`getRightImage()`
`final Text`	`getText()`
`final String`	`getString()`
`final Unit`	`setString(String string)`
`Boolean`	`recolorRecolorsAll()`	Set this to `true` for the recolor function to act as recolorAll.
`Unit`	`render()`	Render the children of this component.
`Unit`	`calculateBounds()`	Calculate the position and size of this drawable.

Methods inherited from class org.polyfrost.polyui.component.ContainingComponent
addComponents, calculateChildBounds, clipDrawables, debugRender, getChildren, isInside, onColorsChanged, onFontsChanged, onParentInitComplete, preRender, recolor, recolorAll, removeComponents, rescale, reset, setup, trueX, trueY
Methods inherited from class org.polyfrost.polyui.component.Component
accept, addKeyframes, addOperation, canBeRemoved, draggable, every, getColor, getConsumesHover, getDisabled, getLayout, getParent, getSize, setColor, setConsumesHover, setDisabled, setLayout, setParent, setProperties, setSize, toString, wantRedraw
Methods inherited from class org.polyfrost.polyui.component.Drawable
addEventHandler, addEventhandler, animateBy, animateTo, calculateSize, clone, debugPrint, doDynamicSize, events, fadeBy, fadeTo, getAcceptsInput, getAcx, getAcy, getAlpha, getAt, getAtType, getContainingLayout, getEventHandlers, getExists, getHeight, getInitStage, getMouseOver, getPolyUI, getRawResize, getRenderer, getRenders, getRotation, getScaleX, getScaleY, getSimpleName, getSizeType, getSkewX, getSkewY, getTrueX, getTrueY, getWidth, getX, getY, intersects, isDynamic, isInside, moveBy, moveTo, onInitComplete, postRender, removeOperation, resize, rotateBy, rotateTo, scaleBy, scaleTo, setAcceptsInput, setAcx, setAcy, setAlpha, setExists, setHeight, setPolyUI, setRenderer, setRenders, setRotation, setScaleX, setScaleY, setSimpleName, setSkewX, setSkewY, setTrueX, setTrueY, setWidth, setX, setY, skewBy, skewTo
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Button
```
Button(ButtonProperties properties, Vec2<Unit> at, Vec2<Unit> size, PolyImage left, Translator.Text text, Unit.Pixel fontSize, PolyImage right, Boolean acceptsInput, Function1<EventDSL<Button>, Unit> events)
```
    Parameters:
    
    properties - The properties of the button (inherits from Block).
    
    size - You can specify this if you want to have more control over the height of this component, as if it is null it is controlled by the largest item.
    
    left - The image to be displayed on the left side of the button
    
    text - The text to be displayed in the button
    
    fontSize - The font size of the text
- Method Detail
  - getProperties
```
 ButtonProperties getProperties()
```
  - getLeftImage
```
 final Image getLeftImage()
```
  - getRightImage
```
 final Image getRightImage()
```
  - getText
```
 final Text getText()
```
  - getString
```
 final String getString()
```
  - setString
```
 final Unit setString(String string)
```
  - recolorRecolorsAll
```
 Boolean recolorRecolorsAll()
```
    Set this to true for the recolor function to act as recolorAll.
    
    Since:
    
    0.21.4
  - render
```
 Unit render()
```
    Render the children of this component.
    you must call super.render()!
  - calculateBounds
```
 Unit calculateBounds()
```
    Calculate the position and size of this drawable. Make sure to call doDynamicSize in this method to avoid issues with sizing.
    This method is called once the layout is populated for children and component, and when a recalculation is requested.
    The value of layout's bounds will be updated after this method is called, so do not use layout's bounds as an updated value in this method.

Class Button

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class org.polyfrost.polyui.component.ContainingComponent

Methods inherited from class org.polyfrost.polyui.component.Component

Methods inherited from class org.polyfrost.polyui.component.Drawable

Methods inherited from class java.lang.Object

Constructor Detail

Button

Method Detail

getProperties

getLeftImage

getRightImage

getText

getString

setString

recolorRecolorsAll

render

calculateBounds