Package com.github.tommyettinger.textra

Class TextraButton

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.github.tommyettinger.textra.TextraButton
All Implemented Interfaces:
com.badlogic.gdx.scenes.scene2d.ui.Styleable<com.badlogic.gdx.scenes.scene2d.ui.Button.ButtonStyle>, com.badlogic.gdx.scenes.scene2d.utils.Cullable, com.badlogic.gdx.scenes.scene2d.utils.Disableable, com.badlogic.gdx.scenes.scene2d.utils.Layout
Direct Known Subclasses:
TextraCheckBox, TypingButton
public class TextraButton extends com.badlogic.gdx.scenes.scene2d.ui.Button
A button with a child TextraLabel to display text.

  • Nested Class Summary

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

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

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

    com.badlogic.gdx.scenes.scene2d.ui.Table.Debug, com.badlogic.gdx.scenes.scene2d.ui.Table.DebugRect

  • Field Summary

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

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

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

    POOLS

  • Constructor Summary

    Constructors
    Constructor
    Description
    TextraButton(String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin)
     
    TextraButton(String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, Font replacementFont)
     
    TextraButton(String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, String styleName)
     
    TextraButton(String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, String styleName, Font replacementFont)
     
    TextraButton(String text, Styles.TextButtonStyle style)
     
    TextraButton(String text, Styles.TextButtonStyle style, Font replacementFont)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    draw(com.badlogic.gdx.graphics.g2d.Batch batch, float parentAlpha)
     
    protected com.badlogic.gdx.graphics.Color
    getFontColor()
    Returns the appropriate label font color from the style based on the current button state.
    Styles.TextButtonStyle
    getStyle()
     
    String
    getText()
     
    TextraLabel
    getTextraLabel()
     
    com.badlogic.gdx.scenes.scene2d.ui.Cell<TextraLabel>
    getTextraLabelCell()
     
    protected TextraLabel
    newLabel(String text, Font font, com.badlogic.gdx.graphics.Color color)
     
    protected TextraLabel
    newLabel(String text, Styles.LabelStyle style)
     
    void
    setStyle(com.badlogic.gdx.scenes.scene2d.ui.Button.ButtonStyle style)
     
    void
    setStyle(com.badlogic.gdx.scenes.scene2d.ui.Button.ButtonStyle style, boolean makeGridGlyphs)
     
    void
    setStyle(com.badlogic.gdx.scenes.scene2d.ui.Button.ButtonStyle style, Font font)
     
    void
    setText(String text)
     
    void
    setTextraLabel(TextraLabel label)
     
    void
    skipToTheEnd()
    Does nothing unless the label used here is a TypingLabel; then, this will skip text progression ahead.
    String
    toString()
     
    TextraButton
    useIntegerPositions(boolean integer)
    A no-op unless label.getFont() is a subclass that overrides Font.handleIntegerPosition(float).

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

    getBackgroundDrawable, getButtonGroup, getClickListener, getMinHeight, getMinWidth, getPrefHeight, getPrefWidth, getProgrammaticChangeEvents, 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 Details

    • TextraButton

      public TextraButton(@Null String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin)

    • TextraButton

      public TextraButton(@Null String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, String styleName)

    • TextraButton

      public TextraButton(@Null String text, Styles.TextButtonStyle style)

    • TextraButton

      public TextraButton(@Null String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, Font replacementFont)

    • TextraButton

      public TextraButton(@Null String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, String styleName, Font replacementFont)

    • TextraButton

      public TextraButton(@Null String text, Styles.TextButtonStyle style, Font replacementFont)

  • Method Details

    • newLabel

      protected TextraLabel newLabel(String text, Styles.LabelStyle style)

    • newLabel

      protected TextraLabel newLabel(String text, Font font, com.badlogic.gdx.graphics.Color color)

    • setStyle

      public void setStyle(com.badlogic.gdx.scenes.scene2d.ui.Button.ButtonStyle style)
      Specified by:
      setStyle in interface com.badlogic.gdx.scenes.scene2d.ui.Styleable<com.badlogic.gdx.scenes.scene2d.ui.Button.ButtonStyle>
      Overrides:
      setStyle in class com.badlogic.gdx.scenes.scene2d.ui.Button

    • setStyle

      public void setStyle(com.badlogic.gdx.scenes.scene2d.ui.Button.ButtonStyle style, boolean makeGridGlyphs)

    • setStyle

      public void setStyle(com.badlogic.gdx.scenes.scene2d.ui.Button.ButtonStyle style, Font font)

    • getStyle

      public Styles.TextButtonStyle getStyle()
      Specified by:
      getStyle in interface com.badlogic.gdx.scenes.scene2d.ui.Styleable<com.badlogic.gdx.scenes.scene2d.ui.Button.ButtonStyle>
      Overrides:
      getStyle in class com.badlogic.gdx.scenes.scene2d.ui.Button

    • getFontColor

      @Null protected com.badlogic.gdx.graphics.Color getFontColor()
      Returns the appropriate label font color from the style based on the current button state.

    • draw

      public void draw(com.badlogic.gdx.graphics.g2d.Batch batch, float parentAlpha)
      Overrides:
      draw in class com.badlogic.gdx.scenes.scene2d.ui.Button

    • setTextraLabel

      public void setTextraLabel(TextraLabel label)

    • getTextraLabel

      public TextraLabel getTextraLabel()

    • getTextraLabelCell

      public com.badlogic.gdx.scenes.scene2d.ui.Cell<TextraLabel> getTextraLabelCell()

    • useIntegerPositions

      public TextraButton useIntegerPositions(boolean integer)
      A no-op unless label.getFont() is a subclass that overrides Font.handleIntegerPosition(float).
      Parameters:
      integer - usually ignored
      Returns:
      this for chaining

    • setText

      public void setText(@Null String text)

    • getText

      public String getText()

    • toString

      public String toString()
      Overrides:
      toString in class com.badlogic.gdx.scenes.scene2d.Group

    • skipToTheEnd

      public void skipToTheEnd()
      Does nothing unless the label used here is a TypingLabel; then, this will skip text progression ahead.