|
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.Button
public class Button
A button with text on it.
Button.ClickListener
can be registered with
the Button which will be called in case the button was clicked/touched.
NinePatch
as well as the bounding box around the multi-line text displayed on the Button. 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 text you will see artifacts.
Widget
displaying a background NinePatch
as well as multi-line text with a
specific font and color. The style is defined via an instance of Button.ButtonStyle
, which can be either done programmatically
or via a Skin
.
A Button's style definition in a skin XML file should look like this:
<button name="styleName"
down="downNinePatch"
up="upNinePatch"
font="fontName"
fontColor="colorName"/>/>
name
attribute defines the name of the style which you can later use with
Skin#newButton(String, String, 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
pressedfont
attribute references a BitmapFont
by name, to be used to render the text on the buttonfontColor
attribute references a Color
by name, to be used to render the text on the button
Nested Class Summary | |
---|---|
static class |
Button.ButtonStyle
Defines a button style, see Button |
static interface |
Button.ClickListener
Interface for listening to click events of a button. |
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 | |
---|---|
Button(java.lang.String text,
Button.ButtonStyle style)
|
|
Button(java.lang.String text,
Skin skin)
|
|
Button(java.lang.String name,
java.lang.String text,
Button.ButtonStyle style)
|
Method Summary | |
---|---|
void |
draw(SpriteBatch batch,
float parentAlpha)
Draws the Actor. |
java.lang.String |
getText()
|
void |
layout()
Positions and sizes each child of this actor. |
Button |
setClickListener(Button.ClickListener listener)
Sets the Button.ClickListener of this button |
void |
setStyle(Button.ButtonStyle style)
Sets the style of this widget. |
void |
setText(java.lang.String text)
Sets the multi-line label text of this button. |
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 Button(java.lang.String text, Skin skin)
public Button(java.lang.String text, Button.ButtonStyle style)
public Button(java.lang.String name, java.lang.String text, Button.ButtonStyle style)
Method Detail |
---|
public void setStyle(Button.ButtonStyle 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 void setText(java.lang.String text)
text
- public java.lang.String getText()
public Button setClickListener(Button.ClickListener listener)
Button.ClickListener
of 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 |