Package com.badlogic.gdx.scenes.scene2d.ui

Class ImageButton

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Actor

com.badlogic.gdx.scenes.scene2d.Group

com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup

com.badlogic.gdx.scenes.scene2d.ui.Table

com.badlogic.gdx.scenes.scene2d.ui.Button

com.badlogic.gdx.scenes.scene2d.ui.ImageButton

All Implemented Interfaces:

Cullable, Disableable, Layout

public class ImageButton
extends Button

A button with a child Image to display an image. This is useful when the button must be larger than the image and the image centered on the button. If the image is the size of the button, a Button without any children can be used, where the Button.ButtonStyle.up, Button.ButtonStyle.down, and Button.ButtonStyle.checked nine patches define the image.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImageButton.ImageButtonStyle	The style for an image button, see ImageButton.

Nested classes/interfaces inherited from class com.badlogic.gdx.scenes.scene2d.ui.Button

Button.ButtonStyle

Nested classes/interfaces inherited from class com.badlogic.gdx.scenes.scene2d.ui.Table

Table.Debug, Table.DebugRect

Field Summary

Fields inherited from class com.badlogic.gdx.scenes.scene2d.ui.Table

backgroundBottom, backgroundLeft, backgroundRight, backgroundTop, debugActorColor, debugCellColor, debugTableColor

Constructor Summary

Constructors

Constructor	Description
ImageButton(ImageButton.ImageButtonStyle style)
ImageButton(Skin skin)
ImageButton(Skin skin, java.lang.String styleName)
ImageButton(Drawable imageUp)
ImageButton(Drawable imageUp, Drawable imageDown)
ImageButton(Drawable imageUp, Drawable imageDown, Drawable imageChecked)

Method Summary

Modifier and Type	Method	Description
void	draw(Batch batch, float parentAlpha)	If this method is overridden, the super method or WidgetGroup.validate() should be called to ensure the widget group is laid out.
Image	getImage()
Cell	getImageCell()
protected Drawable	getImageDrawable()	Returns the appropriate image drawable from the style based on the current button state.
ImageButton.ImageButtonStyle	getStyle()	Returns the button's style.
protected Image	newImage()
void	setStyle(Button.ButtonStyle style)
java.lang.String	toString()	Returns a description of the actor hierarchy, recursively.
protected void	updateImage()	Sets the image drawable based on the current button state.

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.Button

getBackgroundDrawable, getButtonGroup, getClickListener, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, isChecked, isDisabled, isOver, isPressed, setChecked, setDisabled, setProgrammaticChangeEvents, toggle

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.Table

add, add, add, add, add, add, add, align, background, background, bottom, center, clearChildren, clip, clip, columnDefaults, debug, debug, debugActor, debugAll, debugCell, debugTable, defaults, drawBackground, drawDebug, drawDebugBounds, getAlign, getBackground, getCell, getCells, getClip, getColumnMinWidth, getColumnPrefWidth, getColumns, getColumnWidth, getPadBottom, getPadBottomValue, getPadLeft, getPadLeftValue, getPadRight, getPadRightValue, getPadTop, getPadTopValue, getPadX, getPadY, getRow, getRowHeight, getRowMinHeight, getRowPrefHeight, getRows, getSkin, getTableDebug, hit, invalidate, layout, left, pad, pad, pad, pad, padBottom, padBottom, padLeft, padLeft, padRight, padRight, padTop, padTop, removeActor, removeActor, removeActorAt, reset, right, row, setBackground, setBackground, setClip, setDebug, setRound, setSkin, stack, top

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.WidgetGroup

childrenChanged, getMaxHeight, getMaxWidth, invalidateHierarchy, needsLayout, pack, setFillParent, setLayoutEnabled, sizeChanged, validate

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Group

act, addActor, addActorAfter, addActorAt, addActorBefore, applyTransform, applyTransform, clear, clear, clearChildren, computeTransform, drawChildren, drawDebugChildren, findActor, getChild, getChildren, getCullingArea, hasChildren, isTransform, localToDescendantCoordinates, resetTransform, resetTransform, setCullingArea, setDebug, setStage, setTransform, swapActor, swapActor

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor

addAction, addCaptureListener, addListener, ancestorsVisible, ascendantsVisible, clearActions, clearListeners, clipBegin, clipBegin, clipEnd, fire, firstAscendant, getActions, getCaptureListeners, getColor, getDebug, getHeight, getListeners, getName, getOriginX, getOriginY, getParent, getRight, getRotation, getScaleX, getScaleY, getStage, getTop, getTouchable, getUserObject, getWidth, getX, getX, getY, getY, getZIndex, hasActions, hasKeyboardFocus, hasParent, hasScrollFocus, isAscendantOf, isDescendantOf, isTouchable, isTouchFocusListener, isTouchFocusTarget, isVisible, localToActorCoordinates, localToAscendantCoordinates, localToParentCoordinates, localToScreenCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, positionChanged, remove, removeAction, removeCaptureListener, removeListener, rotateBy, rotationChanged, scaleBy, scaleBy, scaleChanged, screenToLocalCoordinates, setBounds, setColor, setColor, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, setParent, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setSize, setTouchable, setUserObject, setVisible, setWidth, setX, setX, setY, setY, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, toBack, toFront

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ImageButton

public ImageButton(Skin skin)

ImageButton

public ImageButton(Skin skin,
                   java.lang.String styleName)

ImageButton

public ImageButton(ImageButton.ImageButtonStyle style)

ImageButton

public ImageButton(@Null
                   Drawable imageUp)

ImageButton

public ImageButton(@Null
                   Drawable imageUp,
                   @Null
                   Drawable imageDown)

ImageButton

public ImageButton(@Null
                   Drawable imageUp,
                   @Null
                   Drawable imageDown,
                   @Null
                   Drawable imageChecked)

Method Detail

newImage

protected Image newImage()

setStyle

public void setStyle(Button.ButtonStyle style)

Overrides:

setStyle in class Button

getStyle

public ImageButton.ImageButtonStyle getStyle()

Description copied from class: Button

Returns the button's style. Modifying the returned style may not have an effect until Button.setStyle(ButtonStyle) is called.

Overrides:

getStyle in class Button

getImageDrawable

@Null
protected Drawable getImageDrawable()

Returns the appropriate image drawable from the style based on the current button state.

updateImage

protected void updateImage()

Sets the image drawable based on the current button state. The default implementation sets the image drawable using getImageDrawable().

draw

public void draw(Batch batch,
                 float parentAlpha)

Description copied from class: WidgetGroup

If this method is overridden, the super method or WidgetGroup.validate() should be called to ensure the widget group is laid out.

Overrides:

draw in class Button

parentAlpha - The parent alpha, to be multiplied with this actor's alpha, allowing the parent's alpha to affect all children.

getImage

public Image getImage()

getImageCell

public Cell getImageCell()

toString

public java.lang.String toString()

Description copied from class: Group

Returns a description of the actor hierarchy, recursively.

Overrides:

toString in class Group