com.threerings.config.tools
Class BaseConfigEditor

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      com.threerings.config.tools.BaseConfigEditor

All Implemented Interfaces:

EditorContext, ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

ConfigEditor, ResourceEditor

public abstract class BaseConfigEditor
extends JFrame
implements EditorContext, ActionListener

The superclass of ConfigEditor and ResourceEditor.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFrame

JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected ConfigManager	_cfgmgr The config manager.
protected ColorPository	_colorpos The color pository.
protected ToolUtil.EditablePrefs	_eprefs The editable preferences object.
protected FindDialog	_fdialog The find dialog.
protected Action	_find The find menu actions.
protected Action	_findNext The find menu actions.
protected MessageManager	_msgmgr The message manager.
protected MessageBundle	_msgs The config message bundle.
protected JDialog	_pdialog The preferences dialog.
protected static Preferences	_prefs The package preferences.
protected ResourceManager	_rsrcmgr The resource manager.

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

BaseConfigEditor(MessageManager msgmgr, ConfigManager cfgmgr, ColorPository colorpos, String msgs)
Creates a new config editor.

Method Summary

void	actionPerformed(ActionEvent event)
protected void	addFindMenu(JMenu menu) Adds the find functionality to a menu.
void	addNotify()
protected Action	createAction(String command, int mnemonic, int accelerator) Creates an action with the specified command, mnemonic, and (optional) accelerator.
protected Action	createAction(String command, int mnemonic, int accelerator, int modifiers) Creates an action with the specified command, mnemonic, and (optional) accelerator key/modifiers.
protected JButton	createButton(String action) Creates a button with the specified action.
protected JButton	createButton(String action, String key) Creates a button with the specified action and translation key.
static BaseConfigEditor	createEditor(EditorContext ctx, Class<?> clazz, String name) Utility method to create an editor for the identified config.
protected JMenu	createMenu(String name, int mnemonic) Creates a menu with the specified name and mnemonic.
protected JMenuItem	createMenuItem(String action, int mnemonic, int accelerator) Creates a menu item with the specified action, mnemonic, and (optional) accelerator.
protected JMenuItem	createMenuItem(String action, int mnemonic, int accelerator, int modifiers) Creates a menu item with the specified action, mnemonic, and (optional) accelerator key/modifiers.
ColorPository	getColorPository() Returns a reference to the color pository.
ConfigManager	getConfigManager() Returns a reference to the configuration manager.
protected EditorPanel	getFindEditorPanel() Returns the editor panel we'll be finding on.
protected String	getLabel(Class<?> clazz, String type) Returns the label for the specified class.
protected String	getLabel(String name) Returns a translated label for the supplied one, if one exists; otherwise, simply returns the untranslated name.
MessageManager	getMessageManager() Returns a reference to the message manager.
ResourceManager	getResourceManager() Returns a reference to the resource manager.
void	removeNotify()
protected void	showFrame(JFrame frame) Shows a frame slightly offset from this one.

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

_rsrcmgr

protected ResourceManager _rsrcmgr

The resource manager.

_msgmgr

protected MessageManager _msgmgr

The message manager.

_cfgmgr

protected ConfigManager _cfgmgr

The config manager.

_colorpos

protected ColorPository _colorpos

The color pository.

_msgs

protected MessageBundle _msgs

The config message bundle.

_eprefs

protected ToolUtil.EditablePrefs _eprefs

The editable preferences object.

_pdialog

protected JDialog _pdialog

The preferences dialog.

_fdialog

protected FindDialog _fdialog

The find dialog.

_find

protected Action _find

The find menu actions.

_findNext

protected Action _findNext

The find menu actions.

_prefs

protected static Preferences _prefs

The package preferences.

Constructor Detail

BaseConfigEditor

public BaseConfigEditor(MessageManager msgmgr,
                        ConfigManager cfgmgr,
                        ColorPository colorpos,
                        String msgs)

Creates a new config editor.

Method Detail

createEditor

public static BaseConfigEditor createEditor(EditorContext ctx,
                                            Class<?> clazz,
                                            String name)

Utility method to create an editor for the identified config.

getResourceManager

public ResourceManager getResourceManager()

Description copied from interface: EditorContext

Returns a reference to the resource manager.

Specified by:

getResourceManager in interface EditorContext

getMessageManager

public MessageManager getMessageManager()

Description copied from interface: EditorContext

Returns a reference to the message manager.

Specified by:

getMessageManager in interface EditorContext

getConfigManager

public ConfigManager getConfigManager()

Description copied from interface: EditorContext

Returns a reference to the configuration manager.

Specified by:

getConfigManager in interface EditorContext

getColorPository

public ColorPository getColorPository()

Description copied from interface: EditorContext

Returns a reference to the color pository.

Specified by:

getColorPository in interface EditorContext

actionPerformed

public void actionPerformed(ActionEvent event)

Specified by:

actionPerformed in interface ActionListener

addNotify

public void addNotify()

Overrides:

addNotify in class Frame

removeNotify

public void removeNotify()

Overrides:

removeNotify in class Frame

createMenu

protected JMenu createMenu(String name,
                           int mnemonic)

Creates a menu with the specified name and mnemonic.

createMenuItem

protected JMenuItem createMenuItem(String action,
                                   int mnemonic,
                                   int accelerator)

Creates a menu item with the specified action, mnemonic, and (optional) accelerator.

createMenuItem

protected JMenuItem createMenuItem(String action,
                                   int mnemonic,
                                   int accelerator,
                                   int modifiers)

Creates a menu item with the specified action, mnemonic, and (optional) accelerator key/modifiers.

createAction

protected Action createAction(String command,
                              int mnemonic,
                              int accelerator)

Creates an action with the specified command, mnemonic, and (optional) accelerator.

createAction

protected Action createAction(String command,
                              int mnemonic,
                              int accelerator,
                              int modifiers)

Creates an action with the specified command, mnemonic, and (optional) accelerator key/modifiers.

createButton

protected JButton createButton(String action)

Creates a button with the specified action.

createButton

protected JButton createButton(String action,
                               String key)

Creates a button with the specified action and translation key.

getLabel

protected String getLabel(String name)

Returns a translated label for the supplied one, if one exists; otherwise, simply returns the untranslated name.

getLabel

protected String getLabel(Class<?> clazz,
                          String type)

Returns the label for the specified class.

showFrame

protected void showFrame(JFrame frame)

Shows a frame slightly offset from this one.

addFindMenu

protected void addFindMenu(JMenu menu)

Adds the find functionality to a menu.

getFindEditorPanel

protected EditorPanel getFindEditorPanel()

Returns the editor panel we'll be finding on.