com.threerings.opengl.gui
Class TextComponent

java.lang.Object
  com.threerings.opengl.gui.Component
      com.threerings.opengl.gui.TextComponent

All Implemented Interfaces:

ConfigUpdateListener<ManagedConfig>

Direct Known Subclasses:

EditableTextComponent, Label

public abstract class TextComponent
extends Component

Defines methods and mechanisms common to components that render a string of text.

Field Summary

Fields inherited from class com.threerings.opengl.gui.Component

DEFAULT, DISABLED, HOVER

Constructor Summary

TextComponent(GlContext ctx)
Creates a new text component.

Method Summary

Color4f	getEffectColor() Returns the color to use for our text effect.
int	getEffectSize() Returns the effect size for this component's text.
int	getHorizontalAlignment() Returns the horizontal alignment for this component's text.
int	getLineSpacing() Returns the line spacing for our text.
abstract String	getText() Returns the text currently being displayed by this component.
int	getTextEffect() Returns the effect for this component's text.
TextFactory	getTextFactory() Returns a text factory suitable for creating text in the style defined by the component's current state.
int	getVerticalAlignment() Returns the vertical alignment for this component's text.
abstract void	setText(String text) Updates the text displayed by this component.

Methods inherited from class com.threerings.opengl.gui.Component

acceptsFocus, addListener, boundsToString, configUpdated, contains, createDefaultTooltipComponent, createDefaultTooltipComponent, dispatchEvent, getAbsoluteX, getAbsoluteY, getAlpha, getBackground, getBorder, getBounds, getColor, getContext, getCursor, getFocusTarget, getHeight, getHitComponent, getInsets, getParent, getPreferredSize, getProperty, getState, getStyleConfigs, getTooltipText, getTooltipTimeout, getTooltipWindowStyle, getTransferHandler, getWidth, getX, getY, hasFocus, invalidate, isAdded, isEnabled, isHoverable, isShowing, isTooltipRelativeToMouse, isValid, isVisible, removeAllListeners, removeAllListeners, removeListener, render, requestFocus, scrollRectToVisible, setAlpha, setBackground, setBounds, setCursor, setEnabled, setHoverable, setLocation, setParent, setPreferredSize, setPreferredSize, setProperty, setSize, setStyleConfig, setStyleConfig, setStyleConfig, setStyleConfigs, setTooltipRelativeToMouse, setTooltipText, setTransferHandler, setVisible, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextComponent

public TextComponent(GlContext ctx)

Creates a new text component.

Method Detail

setText

public abstract void setText(String text)

Updates the text displayed by this component.

getText

public abstract String getText()

Returns the text currently being displayed by this component.

getTextFactory

public TextFactory getTextFactory()

Returns a text factory suitable for creating text in the style defined by the component's current state.

getHorizontalAlignment

public int getHorizontalAlignment()

Returns the horizontal alignment for this component's text.

getVerticalAlignment

public int getVerticalAlignment()

Returns the vertical alignment for this component's text.

getTextEffect

public int getTextEffect()

Returns the effect for this component's text.

getEffectSize

public int getEffectSize()

Returns the effect size for this component's text.

getEffectColor

public Color4f getEffectColor()

Returns the color to use for our text effect.

getLineSpacing

public int getLineSpacing()

Returns the line spacing for our text.