com.threerings.opengl.gui
Class StatusLabel

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

All Implemented Interfaces:

ConfigUpdateListener<ManagedConfig>, UIConstants

public class StatusLabel
extends Label

Provides a convenient component for displaying feedback.

Nested Class Summary

Nested classes/interfaces inherited from class com.threerings.opengl.gui.Label

Label.Fit

Field Summary

protected Interval	_flashAlert The flash interval, if any.
protected Icon[]	_icons The icons for each state.
protected static long	FLASH_DELAY The delay between flashes.

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

_label

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

_effcols, _effsizes, _haligns, _lineSpacings, _teffects, _textfacts, _valigns

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

_alpha, _backgrounds, _borders, _colors, _ctx, _cursor, _enabled, _height, _hover, _hoverable, _insets, _listeners, _parent, _preferredSize, _properties, _rect, _styleConfigs, _tipmouse, _tiptext, _tooltipStyle, _transferHandler, _valid, _visible, _width, _x, _y, DEFAULT, DISABLED, HOVER, STATE_COUNT, STATE_PCLASSES

Fields inherited from interface com.threerings.opengl.gui.UIConstants

BOTTOM, CENTER, DEFAULT_SIZE, DEFAULT_SPACING, GLOW, HORIZONTAL, LEFT, NORMAL, OUTLINE, OVERLAPPING, PLAIN, RIGHT, SHADOW, TOP, VERTICAL

Constructor Summary

StatusLabel(GlContext ctx)
Creates a new status label.

Method Summary

protected String	getDefaultStyleConfig() Returns the name of the default config to be used for all instances of this component.
void	setStatus(String message, boolean flash) Displays an already translated status message.
void	setStatus(String bundle, String message, boolean flash) Translates and displays the specified status message.
void	setText(String text) Updates the text displayed by this component.
protected void	updateFromStyleConfig(int state, StyleConfig.Original config) Updates from the resolved style config.

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

computePreferredSize, getFit, getIcon, getIconTextGap, getLabelRenderer, getText, layout, renderComponent, setFit, setIcon, setIconTextGap, setOrientation, setPreferredWidth, setTextRotation

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

getEffectColor, getEffectSize, getHorizontalAlignment, getLabelRendererConfig, getLineSpacing, getTextEffect, getTextFactory, getTextFactory, getVerticalAlignment

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

acceptsFocus, addListener, boundsToString, changeCursor, configUpdated, contains, createDefaultTooltipComponent, createDefaultTooltipComponent, createTooltipComponent, dispatchEvent, emitEvent, getAbsoluteX, getAbsoluteY, getAlpha, getBackground, getBorder, getBounds, getColor, getContext, getCursor, getFallbackState, getFirstDescendantFocus, getFocusTarget, getHeight, getHitComponent, getInsets, getLastDescendantFocus, getNextFocus, getParent, getPreferredSize, getPreviousFocus, getProperty, getState, getStateCount, getStatePseudoClass, getStyleConfigs, getTooltipText, getTooltipTimeout, getTooltipWindowStyle, getTransferHandler, getWidth, getWindow, getX, getY, hasFocus, intersectScissor, invalidate, isAdded, isEnabled, isHoverable, isShowing, isTooltipRelativeToMouse, isValid, isVisible, removeAllListeners, removeAllListeners, removeListener, render, renderBackground, renderBorder, requestFocus, scrollRectToVisible, scrollRectToVisible, setAlpha, setBackground, setBounds, setCursor, setEnabled, setHoverable, setLocation, setParent, setPreferredSize, setPreferredSize, setProperty, setSize, setStyleConfig, setStyleConfig, setStyleConfig, setStyleConfigs, setTooltipRelativeToMouse, setTooltipText, setTransferHandler, setVisible, stateDidChange, updateCursor, updateFromStyleConfig, validate, wasAdded, wasRemoved

Methods inherited from class java.lang.Object

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

Field Detail

_icons

protected Icon[] _icons

The icons for each state.

_flashAlert

protected Interval _flashAlert

The flash interval, if any.

FLASH_DELAY

protected static final long FLASH_DELAY

The delay between flashes.

See Also:

Constant Field Values

Constructor Detail

StatusLabel

public StatusLabel(GlContext ctx)

Creates a new status label.

Method Detail

setStatus

public void setStatus(String bundle,
                      String message,
                      boolean flash)

Translates and displays the specified status message.

Parameters:

flash - if true, an icon will be flashed three times next to the status message to grab the users attention.

setStatus

public void setStatus(String message,
                      boolean flash)

Displays an already translated status message.

Parameters:

flash - if true, an icon will be flashed three times next to the status message to grab the users attention.

setText

public void setText(String text)

Description copied from class: TextComponent

Updates the text displayed by this component.

Overrides:

setText in class Label

getDefaultStyleConfig

protected String getDefaultStyleConfig()

Description copied from class: Component

Returns the name of the default config to be used for all instances of this component. Derived classes will likely want to override this method and set up a default config for their type of component.

Overrides:

getDefaultStyleConfig in class Label

updateFromStyleConfig

protected void updateFromStyleConfig(int state,
                                     StyleConfig.Original config)

Description copied from class: Component

Updates from the resolved style config.

Overrides:

updateFromStyleConfig in class TextComponent