Package com.prineside.tdi2.ui.actors

Class Label

java.lang.Object
com.prineside.tdi2.scene2d.Actor
com.prineside.tdi2.scene2d.ui.Widget
com.prineside.tdi2.ui.actors.Label
All Implemented Interfaces:
Layout
Direct Known Subclasses:
LabelButton, LabelWithShadow, LimitedWidthLabel
public class Label extends Widget
A text label, with optional word wrapping.

The preferred size of the label is determined by the actual text bounds, unless word wrap is enabled.

Author:
Nathan Sweet

  • Constructor Details

  • Method Details

    • setStyle

      public void setStyle(Label.LabelStyle style)

    • getStyle

      public Label.LabelStyle getStyle()
      Returns the label's style. Modifying the returned style may not have an effect until setStyle(LabelStyle) is called.

    • setTextFromInt

      public boolean setTextFromInt(int value)
      Sets the text to the specified integer value. If the text is already equivalent to the specified value, a string is not allocated.
      Returns:
      true if the text was changed.

    • setText

      public void setText(@Null CharSequence newText)
      Parameters:
      newText - If null, "" will be used.

    • textEquals

      public boolean textEquals(CharSequence other)

    • getText

      public StringBuilder getText()

    • invalidate

      public void invalidate()
      Description copied from interface: Layout
      Invalidates this actor's layout, causing Layout.layout() to happen the next time Layout.validate() is called. This method should be called 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).
      Specified by:
      invalidate in interface Layout
      Overrides:
      invalidate in class Widget

    • layout

      public void layout()
      Description copied from interface: Layout
      Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls Layout.invalidate() on any each child whose width or height has changed, and calls Layout.validate() on each child. This method should almost never be called directly, instead Layout.validate() should be used.
      Specified by:
      layout in interface Layout
      Overrides:
      layout in class Widget

    • draw

      public void draw(Batch batch, float parentAlpha)
      Description copied from class: Widget
      If this method is overridden, the super method or Widget.validate() should be called to ensure the widget is laid out.
      Overrides:
      draw in class Widget
      parentAlpha - The parent alpha, to be multiplied with this actor's alpha, allowing the parent's alpha to affect all children.

    • getPrefWidth

      public float getPrefWidth()
      Specified by:
      getPrefWidth in interface Layout
      Overrides:
      getPrefWidth in class Widget

    • getPrefHeight

      public float getPrefHeight()
      Specified by:
      getPrefHeight in interface Layout
      Overrides:
      getPrefHeight in class Widget

    • getGlyphLayout

      public GlyphLayout getGlyphLayout()

    • setWrap

      public void setWrap(boolean wrap)
      If false, the text will only wrap where it contains newlines (\n). The preferred size of the label will be the text bounds. If true, the text will word wrap using the width of the label. The preferred width of the label will be 0, it is expected that something external will set the width of the label. Wrapping will not occur when ellipsis is enabled. Default is false.

      When wrap is enabled, the label's preferred height depends on the width of the label. In some cases the parent of the label will need to layout twice: once to set the width of the label and a second time to adjust to the label's new preferred height.

    • getWrap

      public boolean getWrap()

    • getLabelAlign

      public int getLabelAlign()

    • getLineAlign

      public int getLineAlign()

    • setAlignment

      public void setAlignment(int alignment)
      Parameters:
      alignment - Aligns all the text within the label (default left center) and each line of text horizontally (default left).
      See Also:

    • setAlignmentSeparate

      public void setAlignmentSeparate(int labelAlign, int lineAlign)
      Parameters:
      labelAlign - Aligns all the text within the label (default left center).
      lineAlign - Aligns each line of text horizontally (default left).
      See Also:

    • setFontScale

      public void setFontScale(float fontScale)

    • setFontScaleSeparate

      public void setFontScaleSeparate(float fontScaleX, float fontScaleY)

    • getFontScaleX

      public float getFontScaleX()

    • setFontScaleX

      public void setFontScaleX(float fontScaleX)

    • getFontScaleY

      public float getFontScaleY()

    • setFontScaleY

      public void setFontScaleY(float fontScaleY)

    • setEllipsisString

      public void setEllipsisString(@Null String ellipsis)
      When non-null the text will be truncated "..." if it does not fit within the width of the label. Wrapping will not occur when ellipsis is enabled. Default is false.

    • setEllipsis

      public void setEllipsis(boolean ellipsis)
      When true the text will be truncated "..." if it does not fit within the width of the label. Wrapping will not occur when ellipsis is true. Default is false.

    • toString

      public String toString()
      Overrides:
      toString in class Actor