com.threerings.editor.swing
Class EditorPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.samskivert.swing.CollapsiblePanel
                      com.threerings.editor.swing.BasePropertyEditor
                          com.threerings.editor.swing.EditorPanel

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ChangeListener

public class EditorPanel
extends BasePropertyEditor
implements ChangeListener

Allows editing properties of an object as determined through reflection.

See Also:

Serialized Form

Nested Class Summary

static class

EditorPanel.CategoryMode Determines how the different property categories are displayed (in sequential collapsible panels, in separate tabs, or in a card layout with a combo box at the top).

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

JComponent.AccessibleJComponent

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

Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

EditorPanel(EditorContext ctx)
Creates an empty editor panel.

EditorPanel(EditorContext ctx, EditorPanel.CategoryMode catmode)
Creates an empty editor panel.

EditorPanel(EditorContext ctx, EditorPanel.CategoryMode catmode, Property[] ancestors)
Creates an empty editor panel.

EditorPanel(EditorContext ctx, EditorPanel.CategoryMode catmode, Property[] ancestors, boolean omitColumns)
Creates an empty editor panel.

Method Summary

static JDialog	createDialog(Component parent, EditorContext ctx, EditorPanel.CategoryMode catmode, String title, Object object) Creates and returns a simple dialog for editing the supplied object.
static JDialog	createDialog(Component parent, EditorContext ctx, String title, Object object) Creates and returns a simple dialog for editing the supplied object.
Object	getObject() Returns the object being edited.
PropertyEditor	getPropertyEditor(String name) Returns the property editor for the property with the supplied name.
void	setObject(Object object) Sets the object being edited.
void	stateChanged(ChangeEvent event)
void	update() Updates the editor state in response to an external change in the object's state.

Methods inherited from class com.threerings.editor.swing.BasePropertyEditor

actionPerformed, addChangeListener, getLabel, getLabels, getLabels, getLabels, getMousePath, removeChangeListener

Methods inherited from class com.samskivert.swing.CollapsiblePanel

getContent, isCollapsed, setCollapsed, setGap, setTrigger, setTriggerContainer, setTriggerContainer, setTriggerContainer

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

EditorPanel

public EditorPanel(EditorContext ctx)

Creates an empty editor panel.

EditorPanel

public EditorPanel(EditorContext ctx,
                   EditorPanel.CategoryMode catmode)

Creates an empty editor panel.

Parameters:

catmode - determines how different property categories will be displayed.

EditorPanel

public EditorPanel(EditorContext ctx,
                   EditorPanel.CategoryMode catmode,
                   Property[] ancestors)

Creates an empty editor panel.

Parameters:

catmode - determines how different property categories will be displayed.

ancestors - the ancestor properties from which constraints are inherited. If this is non-null, the panel is assumed to be embedded within another.

EditorPanel

public EditorPanel(EditorContext ctx,
                   EditorPanel.CategoryMode catmode,
                   Property[] ancestors,
                   boolean omitColumns)

Creates an empty editor panel.

Parameters:

catmode - determines how different property categories will be displayed.

ancestors - the ancestor properties from which constraints are inherited. If this is non-null, the panel is assumed to be embedded within another.

omitColumns - if true, do not add editors for the properties flagged as columns.

Method Detail

createDialog

public static JDialog createDialog(Component parent,
                                   EditorContext ctx,
                                   String title,
                                   Object object)

Creates and returns a simple dialog for editing the supplied object.

Parameters:

title - the translated title of the dialog.

createDialog

public static JDialog createDialog(Component parent,
                                   EditorContext ctx,
                                   EditorPanel.CategoryMode catmode,
                                   String title,
                                   Object object)

Creates and returns a simple dialog for editing the supplied object.

Parameters:

title - the translated title of the dialog.

setObject

public void setObject(Object object)

Sets the object being edited.

getObject

public Object getObject()

Returns the object being edited.

getPropertyEditor

public PropertyEditor getPropertyEditor(String name)

Returns the property editor for the property with the supplied name.

update

public void update()

Updates the editor state in response to an external change in the object's state.

stateChanged

public void stateChanged(ChangeEvent event)

Specified by:

stateChanged in interface ChangeListener