org.mini2Dx.ui.element

Class ImageButton

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.Button

org.mini2Dx.ui.element.ImageButton

All Implemented Interfaces:

Actionable, Hoverable

public class ImageButton
extends Button

Implementation of Button that only contains an image

Field Summary

Fields

Modifier and Type	Field and Description
protected ImageButtonRenderNode	renderNode

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

layout

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

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
void	attach(ParentRenderNode<?,?> parentRenderNode) Attaches a RenderNode for this element to a parent RenderNode
void	detach(ParentRenderNode<?,?> parentRenderNode) Detaches this element's RenderNode from a parent RenderNode
java.lang.String	getAtlas() Returns the atlas (if any) to look up the texture in
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	setLayout(java.lang.String layout) Sets the current layout for this Button
void	setResponsive(boolean responsive) Sets if the image should scale to the size of the ImageButton
void	setStyleId(java.lang.String styleId) Sets the style if for this UiElement
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
void	setVisibility(Visibility visibility) Sets the current Visibility of this UiElement
void	setZIndex(int zIndex) Sets the Z index of this UiElement.
void	syncWithRenderNode() Syncs data between the UiElement and RenderNode

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

addActionListener, getLayout, isEnabled, notifyActionListenersOfBeginEvent, notifyActionListenersOfEndEvent, removeActionListener, setEnabled

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

addEffectListener, addHoverListener, applyEffect, equals, getElementById, getId, getStyleId, getVisibility, getZIndex, hashCode, isDebugEnabled, notifyEffectListenersOnFinished, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, 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

renderNode

protected ImageButtonRenderNode renderNode

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

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 -

attach

public void attach(ParentRenderNode<?,?> parentRenderNode)

Description copied from class: UiElement

Attaches a RenderNode for this element to a parent RenderNode

Specified by:

attach in class UiElement

Parameters:

parentRenderNode - The parent RenderNode to attach to

detach

public void detach(ParentRenderNode<?,?> parentRenderNode)

Description copied from class: UiElement

Detaches this element's RenderNode from a parent RenderNode

Specified by:

detach in class UiElement

Parameters:

parentRenderNode - The parent RenderNode to detach from

setVisibility

public void setVisibility(Visibility visibility)

Description copied from class: UiElement

Sets the current Visibility of this UiElement

Specified by:

setVisibility in class UiElement

Parameters:

visibility - The Visibility to set

setStyleId

public void setStyleId(java.lang.String styleId)

Description copied from class: UiElement

Sets the style if for this UiElement

Specified by:

setStyleId in class UiElement

Parameters:

styleId - The style id to set

syncWithRenderNode

public void syncWithRenderNode()

Description copied from class: UiElement

Syncs data between the UiElement and RenderNode

Specified by:

syncWithRenderNode in class UiElement

setZIndex

public void setZIndex(int zIndex)

Description copied from class: UiElement

Sets the Z index of this UiElement. Elements will be rendered on different Z layers in ascending Z order (negatives values first, positive values last)

Specified by:

setZIndex in class UiElement

Parameters:

zIndex - The Z index

setLayout

public void setLayout(java.lang.String layout)

Description copied from class: Button

Sets the current layout for this Button

Specified by:

setLayout in class Button