|
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
public abstract class Widget
An Actor
that participates in layout and provides a minimum, preferred, and maximum size.
The default preferred size of a widget is 0 and this is almost always overridden by a subclass. The default minimum size returns the preferred size, so a subclass may choose to return 0 if it wants to allow itself to be sized smaller. The default maximum size is 0, which means no maximum size.
See Layout
for details on how a widget should participate in layout. A widget's mutator methods should call
invalidate()
or invalidateHierarchy()
as needed.
Field Summary |
---|
Fields inherited from class com.badlogic.gdx.scenes.scene2d.Actor |
---|
actions, color, height, name, originX, originY, parent, rotation, scaleX, scaleY, stage, touchable, visible, width, x, y |
Constructor Summary | |
---|---|
Widget()
Creates a new widget without a name. |
|
Widget(java.lang.String name)
|
Method Summary | |
---|---|
void |
draw(SpriteBatch batch,
float parentAlpha)
If this method is overridden, the super method or validate() should be called to ensure the widget is laid out. |
float |
getMaxHeight()
|
float |
getMaxWidth()
|
float |
getMinHeight()
|
float |
getMinWidth()
|
float |
getPrefHeight()
|
float |
getPrefWidth()
|
Actor |
hit(float x,
float y)
|
void |
invalidate()
Invalidates this actor's layout, causing Layout.layout() to be called the next time Layout.validate() is called. |
void |
invalidateHierarchy()
Invalidates this actor and all its parents, calling Layout.invalidate() on all involved actors. |
void |
layout()
Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child and calls Layout.invalidate() and then Layout.validate() on each one. |
boolean |
needsLayout()
Returns true if the widget's layout has been invalidated . |
void |
pack()
Sizes this actor to its preferred width and height and, if its size was changed, causes the actor to be laid out by calling Layout.invalidate() and then Layout.validate() . |
void |
setFillParent(boolean fillParent)
If true, this actor will be sized to the parent in Layout.validate() . |
static void |
toScreenCoordinates(Actor actor,
Vector2 point)
This modifies the specified point in the actor's coordinates to be in the stage's coordinates. |
boolean |
touchDown(float x,
float y,
int pointer)
|
void |
touchDragged(float x,
float y,
int pointer)
|
void |
touchUp(float x,
float y,
int pointer)
|
void |
validate()
Ensures the actor has been laid out. |
Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor |
---|
act, action, clearActions, getStage, 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 Widget()
public Widget(java.lang.String name)
Method Detail |
---|
public float getMinWidth()
getMinWidth
in interface Layout
public float getMinHeight()
getMinHeight
in interface Layout
public float getPrefWidth()
getPrefWidth
in interface Layout
public float getPrefHeight()
getPrefHeight
in interface Layout
public float getMaxWidth()
getMaxWidth
in interface Layout
public float getMaxHeight()
getMaxHeight
in interface Layout
public void invalidate()
Layout
Layout.layout()
to be called the next time Layout.validate()
is called. This
should be done when state changes in the actor that requires a layout but does not change the minimum, preferred, maximum,
or actual size of the actor (meaning it does not affect the parent actor's layout).
invalidate
in interface Layout
public void validate()
Layout
Layout.layout()
if Layout.invalidate()
has called since the last time
Layout.validate()
was called, or if the actor otherwise needs to be laid out. This method is usually called in
Actor.draw(SpriteBatch, float)
before drawing is performed.
validate
in interface Layout
public boolean needsLayout()
invalidated
.
public void invalidateHierarchy()
Layout
Layout.invalidate()
on all involved actors. This method should be
called when state changes in the actor that affects the minimum, preferred, maximum, or actual size of the actor (meaning it
potentially affects the parent actor's layout).
invalidateHierarchy
in interface Layout
public void pack()
Layout
Layout.invalidate()
and then Layout.validate()
.
Generally this method should not be called in a constructor because it calls Layout.layout()
, which means a subclass would
have layout() called before the subclass' constructor. Instead, in a constructor simply set the actors width and height to
Layout.getPrefWidth()
and Layout.getPrefHeight()
. This allows the actor to have a size at construction time for more
convenient use outside of a Table
.
pack
in interface Layout
public void setFillParent(boolean fillParent)
Layout
Layout.validate()
. If the parent is the stage, the actor will be sized
to the stage.
setFillParent
in interface Layout
public void draw(SpriteBatch batch, float parentAlpha)
validate()
should be called to ensure the widget is laid out.
draw
in class Actor
batch
- the spritebatch to render withparentAlpha
- the parent's alpha value.public Actor hit(float x, float y)
hit
in class Actor
public void layout()
Layout
Layout.invalidate()
and then Layout.validate()
on each one. Usually this should not be called directly, instead
Layout.validate()
should be used.
layout
in interface Layout
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 static void toScreenCoordinates(Actor actor, Vector2 point)
|
libgdx API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |