org.mini2Dx.ui.element

Class ImageButton

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.ParentUiElement

org.mini2Dx.ui.element.Button

org.mini2Dx.ui.element.ImageButton

All Implemented Interfaces:

Actionable, Hoverable

public class ImageButton
extends Button

Utility implementation of Button that contains an Image

Field Summary

Fields

Modifier and Type	Field and Description
protected Image	image

Fields inherited from class org.mini2Dx.ui.element.ParentUiElement

asyncAddQueue, asyncRemoveAll, asyncRemoveQueue, children, renderNode

Fields inherited from class org.mini2Dx.ui.element.UiElement

deferred, effects, styleId, visibility, zIndex

Constructor Summary

Constructors

Constructor and Description
ImageButton() Constructor.
ImageButton(java.lang.String id) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAtlas() Returns the atlas (if any) to look up the texture in
Image	getImage() Returns the backing Image for the button
java.lang.String	getTexturePath() Returns the current texture path
TextureRegion	getTextureRegion(com.badlogic.gdx.assets.AssetManager assetManager) Returns the current TextureRegion for this ImageButton
boolean	isResponsive() Returns if the image should scale to the size of the ImageButton
void	setAtlas(java.lang.String atlas) Sets the atlas to look up the texture in
void	setResponsive(boolean responsive) Sets if the image should scale to the size of the ImageButton
void	setTexture(com.badlogic.gdx.graphics.Texture texture) Sets the current Texture used by this ImageButton
void	setTexturePath(java.lang.String texturePath) Sets the current texture path.
void	setTextureRegion(TextureRegion textureRegion) Sets the current TextureRegion used by this ImageButton

Methods inherited from class org.mini2Dx.ui.element.Button

addActionListener, createRenderNode, isEnabled, notifyActionListenersOfBeginEvent, notifyActionListenersOfEndEvent, removeActionListener, setEnabled

Methods inherited from class org.mini2Dx.ui.element.ParentUiElement

add, add, addAsync, attach, detach, get, getElementById, getFlexDirection, getHorizontalLayout, getTotalChildren, getVerticalLayout, isOverflowClipped, remove, remove, removeAll, removeAllAsync, removeAsync, setFlexDirection, setHorizontalLayout, setOverflowClipped, setStyleId, setVerticalLayout, setVisibility, setZIndex, syncWithRenderNode

Methods inherited from class org.mini2Dx.ui.element.UiElement

addEffectListener, addHoverListener, applyEffect, defer, defer, equals, getId, getStyleId, getVisibility, getZIndex, hashCode, isDebugEnabled, notifyEffectListenersOnFinished, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, processDeferred, removeEffectListener, removeHoverListener, setDebugEnabled

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.mini2Dx.ui.element.Hoverable

addHoverListener, getId, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, removeHoverListener

Field Detail

image

protected Image image

Constructor Detail

ImageButton

public ImageButton()

Constructor. Generates a unique ID for this ImageButton

ImageButton

public ImageButton(java.lang.String id)

Constructor

Parameters:

id - The unique ID for this ImageButton

Method Detail

getTextureRegion

public TextureRegion getTextureRegion(com.badlogic.gdx.assets.AssetManager assetManager)

Returns the current TextureRegion for this ImageButton

Parameters:

assetManager - The game's AssetManager

Returns:

Null if no TextureRegion has been set

setTextureRegion

public void setTextureRegion(TextureRegion textureRegion)

Sets the current TextureRegion used by this ImageButton

Parameters:

textureRegion - The TextureRegion to use

setTexture

public void setTexture(com.badlogic.gdx.graphics.Texture texture)

Sets the current Texture used by this ImageButton

Parameters:

texture - The Texture to use

getTexturePath

public java.lang.String getTexturePath()

Returns the current texture path

Returns:

Null if no path is used

setTexturePath

public void setTexturePath(java.lang.String texturePath)

Sets the current texture path. This will set the current TextureRegion by loading it via the AssetManager

Parameters:

texturePath - The path to the texture

getAtlas

public java.lang.String getAtlas()

Returns the atlas (if any) to look up the texture in

Returns:

Null by default

setAtlas

public void setAtlas(java.lang.String atlas)

Sets the atlas to look up the texture in

Parameters:

atlas - Null if the texture should not be looked up via an atlas

isResponsive

public boolean isResponsive()

Returns if the image should scale to the size of the ImageButton

Returns:

False by default

setResponsive

public void setResponsive(boolean responsive)

Sets if the image should scale to the size of the ImageButton

Parameters:

responsive -

getImage

public Image getImage()

Returns the backing Image for the button

Returns: