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, FlexUiElement, Hoverable, NodeStateListener

public class ImageButton
extends Button
implements NodeStateListener

Utility implementation of Button that contains an Image

Field Summary

Fields

Modifier and Type	Field and Description
protected Image	actionImage
protected Image	disabledImage
protected Image	hoverImage
protected Image	normalImage

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

asyncRemoveAll, children, renderNode

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

deferredLayout, deferredRender, deferredUpdate, effects, height, styleId, visibility, width, x, y, zIndex

Constructor Summary

Constructors

Constructor and Description
ImageButton() Constructor.
ImageButton(float x, float y, float width, float height) Constructor
ImageButton(java.lang.String id) Constructor
ImageButton(java.lang.String id, float x, float y, float width, float height) Constructor

Method Summary

Modifier and Type	Method and Description
Image	getActionImage() Returns the backing Image for the button in its action state
java.lang.String	getActionTexturePath() Returns the texture path when button is in action state
java.lang.String	getAtlas() Returns the atlas (if any) to look up the texture in
Image	getDisabledImage() Returns the backing Image for the button in its disabled state
java.lang.String	getDisabledTexturePath() Returns the texture path when button is in disabled state
Image	getHoverImage() Returns the backing Image for the button in its hover state
java.lang.String	getHoverTexturePath() Returns the texture path when button is in hover state
Image	getNormalImage() Returns the backing Image for the button in its default state
java.lang.String	getNormalTexturePath() Returns the texture path when button is in normal state
TextureRegion	getTextureRegion(AssetManager assetManager) Returns the current TextureRegion for this ImageButton
boolean	isResponsive() Returns if the image should scale to the size of the ImageButton
void	onNodeStateChanged(UiElement element, NodeState nodeState)
void	setActionTexture(Texture texture) Sets the Texture used by this ImageButton when in its action state
void	setActionTexturePath(java.lang.String texturePath) Sets the texture path to use in action state.
void	setActionTextureRegion(TextureRegion textureRegion) Sets the TextureRegion used by this ImageButton when in its action state
void	setAtlas(java.lang.String atlas) Sets the atlas to look up the texture in
void	setDisabledTexture(Texture texture) Sets the Texture used by this ImageButton when in its disabled state
void	setDisabledTexturePath(java.lang.String texturePath) Sets the texture path to use in disabled state.
void	setDisabledTextureRegion(TextureRegion textureRegion) Sets the TextureRegion used by this ImageButton when in its disabled state
void	setHoverTexture(Texture texture) Sets the Texture used by this ImageButton when in its hover state
void	setHoverTexturePath(java.lang.String texturePath) Sets the texture path to use in hover state.
void	setHoverTextureRegion(TextureRegion textureRegion) Sets the TextureRegion used by this ImageButton when in its hover state
void	setNormalTexture(Texture texture) Sets the Texture used by this ImageButton when in its normal state
void	setNormalTexturePath(java.lang.String texturePath) Sets the texture path to use in normal state.
void	setNormalTextureRegion(TextureRegion textureRegion) Sets the TextureRegion used by this ImageButton when in its normal state
void	setResponsive(boolean responsive) Sets if the image should scale to the size of the ImageButton

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

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

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

add, add, attach, detach, get, getChild, getElementById, getFlexLayout, getRenderHeight, getRenderWidth, getRenderX, getRenderY, getTotalChildren, invokeBeginHover, invokeEndHover, isFlexLayout, isInitialLayoutOccurred, isInitialUpdateOccurred, isOverflowClipped, isRenderNodeDirty, remove, remove, removeAll, removeAllAsync, setFlex, setFlexLayout, setHeightFlex, setOverflowClipped, setRenderNodeDirty, setStyleId, setVisibility, setWidthFlex, setXFlex, setXYFlex, setYFlex, setZIndex, shrinkToContents, shrinkToContents, syncWithUpdate

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

addEffectListener, addHoverListener, addNodeStateListener, alignAbove, alignBelow, alignEdgeToEdge, alignLeftOf, alignRightOf, applyEffect, deferUntilLayout, deferUntilLayout, deferUntilRender, deferUntilRender, deferUntilUpdate, deferUntilUpdate, deferUntilUpdate, deferUntilUpdate, equals, getContentHeight, getContentWidth, getHeight, getId, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getStyleId, getVisibility, getWidth, getX, getY, getZIndex, hashCode, isDebugEnabled, isInitialised, notifyEffectListenersOnFinished, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, notifyNodeStateListeners, removeEffectListener, removeHoverListener, removeNodeStateListener, set, setContentHeight, setContentWidth, setDebugEnabled, setHeight, setHeightToContentHeightOf, setHeightToHeightOf, setWidth, setWidthToContentWidthOf, setWidthToWidthOf, setX, setXY, setY, snapTo, snapTo, syncWithLayout, syncWithRender

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, invokeBeginHover, invokeEndHover, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, removeHoverListener

Field Detail

normalImage

protected Image normalImage

hoverImage

protected Image hoverImage

actionImage

protected Image actionImage

disabledImage

protected Image disabledImage

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

ImageButton

public ImageButton(float x,
                   float y,
                   float width,
                   float height)

Constructor

Parameters:

x - The x coordinate of this element relative to its parent

y - The y coordinate of this element relative to its parent

width - The width of this element

height - The height of this element

ImageButton

public ImageButton(java.lang.String id,
                   float x,
                   float y,
                   float width,
                   float height)

Constructor

Parameters:

id - The unique ID for this element (if null an ID will be generated)

x - The x coordinate of this element relative to its parent

y - The y coordinate of this element relative to its parent

width - The width of this element

height - The height of this element

Method Detail

getTextureRegion

public TextureRegion getTextureRegion(AssetManager assetManager)

Returns the current TextureRegion for this ImageButton

Parameters:

assetManager - The game's AssetManager

Returns:

Null if no TextureRegion has been set

setNormalTextureRegion

public void setNormalTextureRegion(TextureRegion textureRegion)

Sets the TextureRegion used by this ImageButton when in its normal state

Parameters:

textureRegion - The TextureRegion to use

setNormalTexture

public void setNormalTexture(Texture texture)

Sets the Texture used by this ImageButton when in its normal state

Parameters:

texture - The Texture to use

getNormalTexturePath

public java.lang.String getNormalTexturePath()

Returns the texture path when button is in normal state

Returns:

Null if no path is used

setNormalTexturePath

public void setNormalTexturePath(java.lang.String texturePath)

Sets the texture path to use in normal state. This will set the TextureRegion by loading it via the AssetManager

Parameters:

texturePath - The path to the texture

setHoverTextureRegion

public void setHoverTextureRegion(TextureRegion textureRegion)

Sets the TextureRegion used by this ImageButton when in its hover state

Parameters:

textureRegion - The TextureRegion to use

setHoverTexture

public void setHoverTexture(Texture texture)

Sets the Texture used by this ImageButton when in its hover state

Parameters:

texture - The Texture to use

getHoverTexturePath

public java.lang.String getHoverTexturePath()

Returns the texture path when button is in hover state

Returns:

Null if no path is used

setHoverTexturePath

public void setHoverTexturePath(java.lang.String texturePath)

Sets the texture path to use in hover state. This will set the TextureRegion by loading it via the AssetManager

Parameters:

texturePath - The path to the texture

setActionTextureRegion

public void setActionTextureRegion(TextureRegion textureRegion)

Sets the TextureRegion used by this ImageButton when in its action state

Parameters:

textureRegion - The TextureRegion to use

setActionTexture

public void setActionTexture(Texture texture)

Sets the Texture used by this ImageButton when in its action state

Parameters:

texture - The Texture to use

getActionTexturePath

public java.lang.String getActionTexturePath()

Returns the texture path when button is in action state

Returns:

Null if no path is used

setActionTexturePath

public void setActionTexturePath(java.lang.String texturePath)

Sets the texture path to use in action state. This will set the TextureRegion by loading it via the AssetManager

Parameters:

texturePath - The path to the texture

setDisabledTextureRegion

public void setDisabledTextureRegion(TextureRegion textureRegion)

Sets the TextureRegion used by this ImageButton when in its disabled state

Parameters:

textureRegion - The TextureRegion to use

setDisabledTexture

public void setDisabledTexture(Texture texture)

Sets the Texture used by this ImageButton when in its disabled state

Parameters:

texture - The Texture to use

getDisabledTexturePath

public java.lang.String getDisabledTexturePath()

Returns the texture path when button is in disabled state

Returns:

Null if no path is used

setDisabledTexturePath

public void setDisabledTexturePath(java.lang.String texturePath)

Sets the texture path to use in disabled state. This will set the 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 -

getNormalImage

public Image getNormalImage()

Returns the backing Image for the button in its default state

Returns:

getHoverImage

public Image getHoverImage()

Returns the backing Image for the button in its hover state

Returns:

getActionImage

public Image getActionImage()

Returns the backing Image for the button in its action state

Returns:

getDisabledImage

public Image getDisabledImage()

Returns the backing Image for the button in its disabled state

Returns:

onNodeStateChanged

public void onNodeStateChanged(UiElement element,
                               NodeState nodeState)

Specified by:

onNodeStateChanged in interface NodeStateListener