com.threerings.opengl.gui.config
Class UserInterfaceConfig.Original

java.lang.Object
  com.threerings.util.DeepObject
      com.threerings.opengl.gui.config.UserInterfaceConfig.Implementation
          com.threerings.opengl.gui.config.UserInterfaceConfig.Original

All Implemented Interfaces:

Exportable, Copyable, Cloneable

Enclosing class:

UserInterfaceConfig

public static class UserInterfaceConfig.Original
extends UserInterfaceConfig.Implementation

An original implementation.

Field Summary

String	addSound The sound to play on addition, if any.
String	bundle The message bundle to use for translations (or the empty string for the default).
String	removeSound The sound to play on removal, if any.
ComponentConfig	root The root of the interface.

Constructor Summary

UserInterfaceConfig.Original()

Method Summary

Component	getComponent(GlContext ctx, Scope scope, Component comp) Creates or updates a component for this configuration.
ConfigManager	getConfigManager(ConfigManager cfgmgr) Returns a reference to the config manager to use when resolving references.
UserInterfaceConfig.Original	getOriginal(ConfigManager cfgmgr) Returns a reference to the config's underlying original implementation.
void	invalidate() Invalidates any cached data.

Methods inherited from class com.threerings.opengl.gui.config.UserInterfaceConfig.Implementation

getUpdateReferences

Methods inherited from class com.threerings.util.DeepObject

clone, copy, copy, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

bundle

@Editable
public String bundle

The message bundle to use for translations (or the empty string for the default).

root

@Editable
public ComponentConfig root

The root of the interface.

addSound

@Editable(editor="resource",
          nullable=true)
@FileConstraints(description="m.sound_files_desc",
                 extensions=".ogg",
                 directory="sound_dir")
public String addSound

The sound to play on addition, if any.

removeSound

@Editable(editor="resource",
          nullable=true)
@FileConstraints(description="m.sound_files_desc",
                 extensions=".ogg",
                 directory="sound_dir")
public String removeSound

The sound to play on removal, if any.

Constructor Detail

UserInterfaceConfig.Original

public UserInterfaceConfig.Original()

Method Detail

getConfigManager

public ConfigManager getConfigManager(ConfigManager cfgmgr)

Description copied from class: UserInterfaceConfig.Implementation

Returns a reference to the config manager to use when resolving references.

Specified by:

getConfigManager in class UserInterfaceConfig.Implementation

Parameters:

cfgmgr - the config manager of the config containing the implementation.

getOriginal

public UserInterfaceConfig.Original getOriginal(ConfigManager cfgmgr)

Description copied from class: UserInterfaceConfig.Implementation

Returns a reference to the config's underlying original implementation.

Specified by:

getOriginal in class UserInterfaceConfig.Implementation

getComponent

public Component getComponent(GlContext ctx,
                              Scope scope,
                              Component comp)

Description copied from class: UserInterfaceConfig.Implementation

Creates or updates a component for this configuration.

Specified by:

getComponent in class UserInterfaceConfig.Implementation

scope - the component's expression scope.

comp - an existing component to reuse, if possible.

Returns:

either a reference to the existing component (if reused) a new component, or null if no component could be created.

invalidate

public void invalidate()

Description copied from class: UserInterfaceConfig.Implementation

Invalidates any cached data.

Overrides:

invalidate in class UserInterfaceConfig.Implementation