com.threerings.opengl.gui
Class MenuItem

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

All Implemented Interfaces:

ConfigUpdateListener<ManagedConfig>, UIConstants

Direct Known Subclasses:

ComboBox.ComboMenuItem

public class MenuItem
extends Label

Displays a single menu item.

Nested Class Summary

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

Label.Fit

Field Summary

protected String	_action
protected Object	_argument
protected boolean	_armed
protected boolean	_pressed

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

MenuItem(GlContext ctx, Icon icon, String action)
Creates a menu item with the specified icon that will generate an ActionEvent with the specified action when selected.

MenuItem(GlContext ctx, String text, Icon icon, String action)
Creates a menu item with the specified text and icon that will generate an ActionEvent with the specified action when selected.

MenuItem(GlContext ctx, String text, Icon icon, String action, Object argument)
Creates a menu item with the specified text and icon that will generate an ActionEvent with the specified action and argument when selected.

MenuItem(GlContext ctx, String text, String action)
Creates a menu item with the specified text that will generate an ActionEvent with the specified action when selected.

Method Summary

boolean	dispatchEvent(Event event) Instructs this component to process the supplied event.
protected void	fireAction(long when, int modifiers) Called when the menu item is "clicked" which may due to the mouse being pressed and released while over the item or due to keyboard manipulation while the item has focus.
String	getAction() Returns the action configured for this menu item.
Object	getArgument() Returns the argument of the action for this menu item.
protected String	getDefaultStyleConfig() Returns the name of the default config to be used for all instances of this component.

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

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

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

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

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

acceptsFocus, addListener, boundsToString, changeCursor, configUpdated, contains, createDefaultTooltipComponent, createDefaultTooltipComponent, createTooltipComponent, 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

_action

protected String _action

_argument

protected Object _argument

_armed

protected boolean _armed

_pressed

protected boolean _pressed

Constructor Detail

MenuItem

public MenuItem(GlContext ctx,
                String text,
                String action)

Creates a menu item with the specified text that will generate an ActionEvent with the specified action when selected.

MenuItem

public MenuItem(GlContext ctx,
                Icon icon,
                String action)

Creates a menu item with the specified icon that will generate an ActionEvent with the specified action when selected.

MenuItem

public MenuItem(GlContext ctx,
                String text,
                Icon icon,
                String action)

Creates a menu item with the specified text and icon that will generate an ActionEvent with the specified action when selected.

MenuItem

public MenuItem(GlContext ctx,
                String text,
                Icon icon,
                String action,
                Object argument)

Creates a menu item with the specified text and icon that will generate an ActionEvent with the specified action and argument when selected.

Method Detail

getAction

public String getAction()

Returns the action configured for this menu item.

getArgument

public Object getArgument()

Returns the argument of the action for this menu item.

dispatchEvent

public boolean dispatchEvent(Event event)

Description copied from class: Component

Instructs this component to process the supplied event. If the event is not processed, it will be passed up to its parent component for processing. Derived classes should thus only call super.dispatchEvent for events that they did not "consume".

Overrides:

dispatchEvent in class Component

Returns:

true if this event was consumed, false if not.

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

fireAction

protected void fireAction(long when,
                          int modifiers)

Called when the menu item is "clicked" which may due to the mouse being pressed and released while over the item or due to keyboard manipulation while the item has focus.