com.threerings.opengl.gui
Class UserInterfaceWindow

java.lang.Object
  com.threerings.opengl.gui.Component
      com.threerings.opengl.gui.Container
          com.threerings.opengl.gui.Window
              com.threerings.opengl.gui.UserInterfaceWindow

All Implemented Interfaces:

ConfigUpdateListener<ManagedConfig>, Renderer.Observer, Comparable<Window>

public class UserInterfaceWindow
extends Window
implements Renderer.Observer

A window that contains a user interface.

Field Summary

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

DEFAULT, DISABLED, HOVER

Constructor Summary

UserInterfaceWindow(GlContext ctx, boolean stretch)
Creates a new user interface window.

UserInterfaceWindow(GlContext ctx, boolean stretch, ConfigReference<UserInterfaceConfig> ref)
Creates a new user interface window.

UserInterfaceWindow(GlContext ctx, boolean stretch, String name)
Creates a new interface window with the named configuration.

UserInterfaceWindow(GlContext ctx, boolean stretch, String name, String firstKey, Object firstValue, Object... otherArgs)
Creates a new interface with the named configuration and arguments.

Method Summary

Component	getComponent(String name) A shortcut method for retrieving a component registered by name from the interface.
UserInterface	getInterface() Returns a reference to the user interface component.
DynamicScope	getScope() Returns a reference to the window scope.
void	sizeChanged(int width, int height) Notes that the size of the renderer's drawable surface has changed.

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

center, compareTo, dismiss, getLayer, getParentWindow, getRoot, invalidate, isAdded, isModal, isOverlay, pack, pack, setBounds, setLayer, setModal, setParent, setParentWindow, shouldShadeBehind

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

add, add, add, add, getComponent, getComponentCount, getComponentIndex, getHitComponent, getLayoutManager, remove, remove, removeAll, replace, setAlpha, setEnabled, setHoverable, setLayoutManager, validate

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, getInsets, getParent, getPreferredSize, getProperty, getState, getStyleConfigs, getTooltipText, getTooltipTimeout, getTooltipWindowStyle, getTransferHandler, getWidth, getX, getY, hasFocus, isEnabled, isHoverable, isShowing, isTooltipRelativeToMouse, isValid, isVisible, removeAllListeners, removeAllListeners, removeListener, render, requestFocus, scrollRectToVisible, setBackground, setCursor, setLocation, setPreferredSize, setPreferredSize, setProperty, setSize, setStyleConfig, setStyleConfig, setStyleConfig, setStyleConfigs, setTooltipRelativeToMouse, setTooltipText, setTransferHandler, setVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

UserInterfaceWindow

public UserInterfaceWindow(GlContext ctx,
                           boolean stretch)

Creates a new user interface window.

Parameters:

stretch - whether or not to stretch the window across the entire screen.

UserInterfaceWindow

public UserInterfaceWindow(GlContext ctx,
                           boolean stretch,
                           String name)

Creates a new interface window with the named configuration.

Parameters:

stretch - whether or not to stretch the window across the entire screen.

UserInterfaceWindow

public UserInterfaceWindow(GlContext ctx,
                           boolean stretch,
                           String name,
                           String firstKey,
                           Object firstValue,
                           Object... otherArgs)

Creates a new interface with the named configuration and arguments.

Parameters:

stretch - whether or not to stretch the window across the entire screen.

UserInterfaceWindow

public UserInterfaceWindow(GlContext ctx,
                           boolean stretch,
                           ConfigReference<UserInterfaceConfig> ref)

Creates a new user interface window.

Parameters:

stretch - whether or not to stretch the window across the entire screen.

Method Detail

getScope

public DynamicScope getScope()

Returns a reference to the window scope.

getInterface

public UserInterface getInterface()

Returns a reference to the user interface component.

getComponent

public Component getComponent(String name)

A shortcut method for retrieving a component registered by name from the interface.

sizeChanged

public void sizeChanged(int width,
                        int height)

Description copied from interface: Renderer.Observer

Notes that the size of the renderer's drawable surface has changed.

Specified by:

sizeChanged in interface Renderer.Observer