com.threerings.opengl.gui.config
Class ComponentConfig.Label

java.lang.Object
  com.threerings.util.DeepObject
      com.threerings.opengl.gui.config.ComponentConfig
          com.threerings.opengl.gui.config.ComponentConfig.Label

All Implemented Interfaces:

Exportable, Copyable, Cloneable

Direct Known Subclasses:

ComponentConfig.Button, ComponentConfig.StatusLabel

Enclosing class:

ComponentConfig

public static class ComponentConfig.Label
extends ComponentConfig

A label.

Nested Class Summary

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

ComponentConfig.Button, ComponentConfig.ChatOverlay, ComponentConfig.CheckBox, ComponentConfig.ColorPicker, ComponentConfig.ComboBox, ComponentConfig.Container, ComponentConfig.HTMLView, ComponentConfig.Label, ComponentConfig.List, ComponentConfig.Orientation, ComponentConfig.PasswordField, ComponentConfig.RenderableView, ComponentConfig.ScrollBar, ComponentConfig.ScrollPane, ComponentConfig.Slider, ComponentConfig.Spacer, ComponentConfig.Spinner, ComponentConfig.StatusLabel, ComponentConfig.TabbedPane, ComponentConfig.TextArea, ComponentConfig.TextComponent, ComponentConfig.TextEditor, ComponentConfig.TextField, ComponentConfig.ToggleButton, ComponentConfig.UserInterface, ComponentConfig.ViewModel

Field Summary

Label.Fit	fit Determines how to fit overlong text in the label.
IconConfig	icon The label's icon, if any.
int	iconTextGap The gap between icon and text.
ComponentConfig.Orientation	orientation The label orientation.
int	preferredWidth The label's preferred width, or zero for none.
String	text The label's text.
int	textRotation The rotation for the text.

Fields inherited from class com.threerings.opengl.gui.config.ComponentConfig

alpha, enabled, hoverable, preferredSize, style, tag, tooltipRelativeToMouse, tooltipText, visible

Constructor Summary

ComponentConfig.Label()

Method Summary

protected void	configure(GlContext ctx, Scope scope, MessageBundle msgs, Component comp) Configures the specified component.
void	invalidate() Invalidates any cached data.
protected Component	maybeRecreate(GlContext ctx, Scope scope, MessageBundle msgs, Component comp) Recreates the component if the supplied component doesn't match the configuration.
protected boolean	shouldSetIcon(GlContext ctx, Component comp) Determines whether we should configure the label's icon.

Methods inherited from class com.threerings.opengl.gui.config.ComponentConfig

getClass, getComponent, getMessage

Methods inherited from class com.threerings.util.DeepObject

clone, copy, copy, equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

icon

@Editable(nullable=true)
public IconConfig icon

The label's icon, if any.

text

@Editable(hgroup="t")
public String text

The label's text.

iconTextGap

@Editable(hgroup="t")
public int iconTextGap

The gap between icon and text.

textRotation

@Editable(hgroup="t")
public int textRotation

The rotation for the text.

orientation

@Editable(hgroup="o")
public ComponentConfig.Orientation orientation

The label orientation.

fit

@Editable(hgroup="o")
public Label.Fit fit

Determines how to fit overlong text in the label.

preferredWidth

@Editable(min=0.0,
          hgroup="o")
public int preferredWidth

The label's preferred width, or zero for none.

Constructor Detail

ComponentConfig.Label

public ComponentConfig.Label()

Method Detail

invalidate

public void invalidate()

Description copied from class: ComponentConfig

Invalidates any cached data.

Overrides:

invalidate in class ComponentConfig

maybeRecreate

protected Component maybeRecreate(GlContext ctx,
                                  Scope scope,
                                  MessageBundle msgs,
                                  Component comp)

Description copied from class: ComponentConfig

Recreates the component if the supplied component doesn't match the configuration.

Specified by:

maybeRecreate in class ComponentConfig

configure

protected void configure(GlContext ctx,
                         Scope scope,
                         MessageBundle msgs,
                         Component comp)

Description copied from class: ComponentConfig

Configures the specified component.

Overrides:

configure in class ComponentConfig

shouldSetIcon

protected boolean shouldSetIcon(GlContext ctx,
                                Component comp)

Determines whether we should configure the label's icon.