|
libgdx API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.badlogic.gdx.scenes.scene2d.Actor
com.badlogic.gdx.scenes.scene2d.ui.Widget
com.badlogic.gdx.scenes.scene2d.ui.ImageButton
public class ImageButton
A button with an image on it.
ImageButton.ClickListener
can be registered with
the ImageButton which will be called in case the button was clicked/touched.
NinePatch
as well as the width and height of the TextureRegion of the image displayed inside the Imagebutton. Use
Widget.setPrefSize(int, int)
to programmatically change the size to your liking. In case the width and height you set
are to small for the contained image you will see artifacts.
Widget
displaying a background NinePatch
as well as image in form of a
TextureRegion
. The style is defined via an instance of ImageButton.ImageButtonStyle
, which can be either done
programmatically or via a Skin
.
A Button's style definition in a skin XML file should look like this:
<imagebutton name="styleName"
down="downNinePatch"
up="upNinePatch"
/>
name
attribute defines the name of the style which you can later use with
Skin#newImageButton(String, TextureRegion, String)
.down
attribute references a NinePatch
by name, to be used as the button's background when it is
pressedup
attribute references a NinePatch
by name, to be used as the button's background when it is not
pressedsetImageSize(float, float)
Nested Class Summary | |
---|---|
static interface |
ImageButton.ClickListener
Interface for listening to clicked events. |
static class |
ImageButton.ImageButtonStyle
Defines an image button style, see ImageButton |
Field Summary |
---|
Fields inherited from class com.badlogic.gdx.scenes.scene2d.ui.Widget |
---|
invalidated, prefHeight, prefWidth |
Fields inherited from class com.badlogic.gdx.scenes.scene2d.Actor |
---|
actions, color, height, name, originX, originY, parent, rotation, scaleX, scaleY, touchable, visible, width, x, y |
Constructor Summary | |
---|---|
ImageButton(java.lang.String name,
TextureRegion image,
float imageWidth,
float imageHeight,
ImageButton.ImageButtonStyle style)
Creates a new image button. |
|
ImageButton(java.lang.String name,
TextureRegion image,
ImageButton.ImageButtonStyle style)
Creates a new image button. |
|
ImageButton(TextureRegion image,
ImageButton.ImageButtonStyle style)
|
|
ImageButton(TextureRegion image,
Skin skin)
|
Method Summary | |
---|---|
void |
draw(SpriteBatch batch,
float parentAlpha)
Draws the Actor. |
TextureRegion |
getImage()
|
void |
layout()
Positions and sizes each child of this actor. |
ImageButton |
setClickListener(ImageButton.ClickListener listener)
Sets the ImageButton.ClickListener for this button. |
void |
setImage(TextureRegion image)
Sets the image's TextureRegion to be used by this button. |
void |
setImageSize(float width,
float height)
Sets the image's size which is used irrespective of the image's TextureRegion's size. |
void |
setStyle(ImageButton.ImageButtonStyle style)
Sets the style of this widget. |
boolean |
touchDown(float x,
float y,
int pointer)
|
void |
touchDragged(float x,
float y,
int pointer)
|
void |
touchUp(float x,
float y,
int pointer)
|
Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.Widget |
---|
getPrefHeight, getPrefWidth, hit, invalidate, invalidateHierarchy, setPrefSize |
Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor |
---|
act, action, clearActions, isMarkedToRemove, keyDown, keyTyped, keyUp, markToRemove, remove, scrolled, toLocalCoordinates, toString, touchMoved |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ImageButton(TextureRegion image, Skin skin)
public ImageButton(TextureRegion image, ImageButton.ImageButtonStyle style)
public ImageButton(java.lang.String name, TextureRegion image, ImageButton.ImageButtonStyle style)
name
- the nameimage
- the image's TextureRegion
style
- the ImageButton.ImageButtonStyle
public ImageButton(java.lang.String name, TextureRegion image, float imageWidth, float imageHeight, ImageButton.ImageButtonStyle style)
name
- the nameimage
- the image's TextureRegion
imageWidth
- the image's widthimageHeight
- the image's heightstyle
- the ImageButton.ImageButtonStyle
Method Detail |
---|
public void setStyle(ImageButton.ImageButtonStyle style)
Widget.invalidateHierarchy()
internally.
style
- public void layout()
Layout
Layout.invalidate()
is
called.
public void draw(SpriteBatch batch, float parentAlpha)
Actor
FadeIn
and
other Actions to have an effect even if they are only set on the parent of the Actor.
draw
in class Actor
batch
- the spritebatch to render withparentAlpha
- the parent's alpha value.public boolean touchDown(float x, float y, int pointer)
touchDown
in class Actor
public void touchUp(float x, float y, int pointer)
touchUp
in class Actor
public void touchDragged(float x, float y, int pointer)
touchDragged
in class Actor
public TextureRegion getImage()
TextureRegion
of the image used by this buttonpublic void setImage(TextureRegion image)
TextureRegion
to be used by this button. Invalidates all parents.
image
- the image's TextureRegionpublic void setImageSize(float width, float height)
width
- the widthheight
- the heightpublic ImageButton setClickListener(ImageButton.ClickListener listener)
ImageButton.ClickListener
for this button.
listener
- the listener or null
|
libgdx API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |