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

Class ImageTextButton

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.ImageTextButton

All Implemented Interfaces:

Cullable, Disableable, Layout

public class ImageTextButton
extends Button

A button with a child Image and Label.

See Also:

ImageButton, TextButton, Button

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ImageTextButton.ImageTextButtonStyle	The style for an image text button, see ImageTextButton.

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
ImageTextButton(java.lang.String text, ImageTextButton.ImageTextButtonStyle style)
ImageTextButton(java.lang.String text, Skin skin)
ImageTextButton(java.lang.String text, Skin skin, java.lang.String styleName)

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.
protected Color	getFontColor()	Returns the appropriate label font color from the style based on the current button state.
Image	getImage()
Cell	getImageCell()
protected Drawable	getImageDrawable()	Returns the appropriate image drawable from the style based on the current button state.
Label	getLabel()
Cell	getLabelCell()
ImageTextButton.ImageTextButtonStyle	getStyle()	Returns the button's style.
java.lang.CharSequence	getText()
protected Image	newImage()
protected Label	newLabel(java.lang.String text, Label.LabelStyle style)
void	setLabel(Label label)
void	setStyle(Button.ButtonStyle style)
void	setText(java.lang.CharSequence text)
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

ImageTextButton

public ImageTextButton(@Null
                       java.lang.String text,
                       Skin skin)

ImageTextButton

public ImageTextButton(@Null
                       java.lang.String text,
                       Skin skin,
                       java.lang.String styleName)

ImageTextButton

public ImageTextButton(@Null
                       java.lang.String text,
                       ImageTextButton.ImageTextButtonStyle style)

Method Detail

newImage

protected Image newImage()

newLabel

protected Label newLabel(java.lang.String text,
                         Label.LabelStyle style)

setStyle

public void setStyle(Button.ButtonStyle style)

Overrides:

setStyle in class Button

getStyle

public ImageTextButton.ImageTextButtonStyle 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().

getFontColor

@Null
protected Color getFontColor()

Returns the appropriate label font color from the style based on the current button state.

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()

setLabel

public void setLabel(Label label)

getLabel

public Label getLabel()

getLabelCell

public Cell getLabelCell()

setText

public void setText(java.lang.CharSequence text)

getText

public java.lang.CharSequence getText()

toString

public java.lang.String toString()

Description copied from class: Group

Returns a description of the actor hierarchy, recursively.

Overrides:

toString in class Group