Package VASSAL.configure

Class ConfigureTree

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTree

VASSAL.configure.ConfigureTree

All Implemented Interfaces:

MouseListener, MouseMotionListener, ImageObserver, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible, TreeExpansionListener, TreeSelectionListener, Scrollable

Direct Known Subclasses:

ExtensionTree

public class ConfigureTree
extends JTree
implements PropertyChangeListener, MouseListener, MouseMotionListener, TreeSelectionListener, TreeExpansionListener

The beating heart of the Editor, this class handles the Configuration Tree that appears in the Configuration window when editing a VASSAL module. Each node in the tree structure is a Configurable object, whose child nodes are obtained via Configurable.getConfigureComponents(). When we're running as the Extension Editor, this is subclassed by ExtensionTree, which overrides some methods to handle extension-specific differences.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ConfigureTree.AddAction
protected static class	ConfigureTree.AdditionalComponent
protected class	ConfigureTree.ImportAction
static interface	ConfigureTree.Mutable	Configurers that add or remove their own children directly should implement the Mutable interface so that ConfigureTree can refresh the changed node.

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

JTree.AccessibleJTree, JTree.DropLocation, JTree.DynamicUtilTreeNode, JTree.EmptySelectionModel, JTree.TreeModelHandler, JTree.TreeSelectionRedirector

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

JComponent.AccessibleJComponent

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

Fields

Modifier and Type	Field	Description
protected static final List<ConfigureTree.AdditionalComponent>	additionalComponents
protected static Chatter	chatter
protected Action	copyAction
protected String	copyCmd
protected DefaultMutableTreeNode	copyData
protected KeyStroke	copyKey
protected Action	cutAction
protected String	cutCmd
protected DefaultMutableTreeNode	cutData
protected KeyStroke	cutKey
static final String	defaultExportExtension
protected Action	deleteAction
protected String	deleteCmd
protected KeyStroke	deleteKey
protected Action	duplicateAction
protected String	duplicateCmd
protected KeyStroke	duplicateKey
protected EditorWindow	editorWindow
protected Action	helpAction
protected String	helpCmd
protected KeyStroke	helpKey
protected HelpWindow	helpWindow
protected static DefaultMutableTreeNode	lastFoundNode
protected Action	moveAction
protected String	moveCmd
protected KeyStroke	moveKey
protected static boolean	newNodeSelected
protected Map<Configurable,DefaultMutableTreeNode>	nodes
protected Action	pasteAction
protected String	pasteCmd
protected KeyStroke	pasteKey
static final Font	POPUP_MENU_FONT	Deprecated, for removal: This API element is subject to removal in a future version.
protected Action	propertiesAction
protected String	propertiesCmd
protected KeyStroke	propertiesKey
protected Action	searchAction
protected JCheckBox	searchAdvanced	Deprecated, for removal: This API element is subject to removal in a future version.
protected String	searchCmd
protected JDialog	searchDialog
protected JTextField	searchField
protected JRadioButton	searchFiltered
protected KeyStroke	searchKey
protected Configurable	selected
protected static int	selectedNodeIndex
protected int	selectedRow
protected Action	translateAction
protected String	translateCmd
protected KeyStroke	translateKey

Fields inherited from class javax.swing.JTree

ANCHOR_SELECTION_PATH_PROPERTY, CELL_EDITOR_PROPERTY, CELL_RENDERER_PROPERTY, cellEditor, cellRenderer, editable, EDITABLE_PROPERTY, EXPANDS_SELECTED_PATHS_PROPERTY, INVOKES_STOP_CELL_EDITING_PROPERTY, invokesStopCellEditing, LARGE_MODEL_PROPERTY, largeModel, LEAD_SELECTION_PATH_PROPERTY, ROOT_VISIBLE_PROPERTY, rootVisible, ROW_HEIGHT_PROPERTY, rowHeight, SCROLLS_ON_EXPAND_PROPERTY, scrollsOnExpand, SELECTION_MODEL_PROPERTY, selectionModel, selectionRedirector, SHOWS_ROOT_HANDLES_PROPERTY, showsRootHandles, TOGGLE_CLICK_COUNT_PROPERTY, toggleClickCount, TREE_MODEL_PROPERTY, treeModel, treeModelListener, VISIBLE_ROW_COUNT_PROPERTY, visibleRowCount

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, 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

Constructors

Constructor	Description
ConfigureTree(Configurable root, HelpWindow helpWindow)	Creates new ConfigureTree
ConfigureTree(Configurable root, HelpWindow helpWindow, EditorWindow editorWindow)
ConfigureTree(Configurable root, HelpWindow helpWindow, EditorWindow editorWindow, boolean disableDragAndDrop)

Method Summary

Modifier and Type	Method	Description
protected void	addAction(JPopupMenu menu, Action a)
static void	addAdditionalComponent(Class<? extends Buildable> parent, Class<? extends Buildable> child)	Record additional available components to add to the popup menu.
protected void	addSubMenu(JPopupMenu menu, String name, List<Action> l)
protected Action	buildAddAction(Configurable target, Class<? extends Buildable> newConfig)
protected Action	buildAddAction(Configurable target, Class<? extends Buildable> newConfig, String key, int index, Configurable duplicate)
protected List<Action>	buildAddActionsFor(Configurable target)
protected List<Action>	buildAddActionsFor(Configurable target, List<Action> peerInserts)
protected Action	buildCloneAction(Configurable target)
protected Action	buildCopyAction(Configurable target)
protected Action	buildCutAction(Configurable target)
protected Action	buildDeleteAction(Configurable target)
protected Action	buildEditAction(Configurable target)
protected Action	buildEditPiecesAction(Configurable target)
protected Action	buildExportTreeAction(Configurable target)
protected Action	buildHelpAction(Configurable target)
protected Action	buildImportAction(Configurable target)
protected Action	buildImportDeckAction(Configurable target)
protected Action	buildImportTreeAction(Configurable target)
protected Action	buildMassPieceLoaderAction(Configurable target)
protected Action	buildMoveAction(Configurable target)
protected Action	buildOpenPiecesAction(Configurable target)
protected Action	buildPasteAction(Configurable target)
protected JPopupMenu	buildPopupMenu(Configurable target)
protected VASSAL.configure.ConfigureTree.Renderer	buildRenderer()
protected Action	buildSearchAction(Configurable target)
protected Action	buildTranslateAction(Configurable target)
protected DefaultMutableTreeNode	buildTreeNode(Configurable c)
boolean	canContainGamePiece(Configurable target)
protected static void	chat(String text)
int	checkMinimumIndex(DefaultMutableTreeNode targetNode, int index)	Allows ExtensionEditor to override and control what indexes are allowed
protected Configurable	convertChild(Configurable parent, Configurable child)	Some components need to be converted to a new type before insertion.
protected boolean	delete(Configurable target)	Delete removes an item from the tree but ALSO traverses the tree throwing all the children's children manually out the airlock, one by one.
protected void	doKeyAction(String action)	Handle main Edit menu selections/accelerators
protected boolean	exportTreeBranch(AbstractBuildable target)
void	externalInsert(Configurable parent, Configurable child)	Build an AddAction and execute it to request a new component from the user
static String	getConfigureName(Class<?> c)	Returns the name of the class for display purposes.
static String	getConfigureName(Configurable c)
JFrame	getFrame()
Action	getHelpAction()
protected Configurable	getParent(DefaultMutableTreeNode targetNode)
protected Configurable	getParent(Configurable target)	Find the parent Configurable of a specified Configurable
protected JCheckBox	getSearchAdvanced()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getSearchCmd()
protected JDialog	getSearchDialog()
protected JTextField	getSearchField()
protected Configurable	getTarget(int x, int y)
DefaultMutableTreeNode	getTreeNode(Configurable target)
protected boolean	hasChild(Configurable parent, Class<?> childClass)
protected Configurable	importConfigurable()
protected boolean	importTreeBranch(Configurable target)
protected boolean	insert(Configurable parent, Configurable child, int index)
protected boolean	isAllowedChildClass(Configurable parent, Class<?> childClass)
protected boolean	isDeleteAllowed(Configurable target)	Is the Component allowed to be deleted?
protected boolean	isDuplicateAllowed(Configurable target)	Is the Component allowed to be duplicated?
boolean	isMoveAllowed(Configurable target)	Is the Component allowed to be moved?
protected boolean	isValidParent(Configurable parent, Configurable child)
protected boolean	isValidPasteTarget(Configurable target)
protected boolean	isValidPasteTarget(Configurable target, DefaultMutableTreeNode sourceNode)
void	jumpToTarget(Configurable target)
protected void	maybePopup(MouseEvent e)
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent evt)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	nodeEdited(Configurable target)	Called when the Configurable held by a node has been edited.
void	nodeUpdated(Configurable target)
static String	noHTML(String text)
protected void	notifyStateChanged(boolean changed)	Tell our enclosing EditorWindow that we are now clean or dirty.
void	populateEditMenu(EditorWindow ew)
protected void	postInsertProcessing(Configurable parent, Configurable child)
protected void	postPasteFixups(Configurable target)	If there are items that need to be adjusted after being pasted (to make sure they don't contain illegal values that will be hard to debug later), we can make them here.
protected void	postRemoveProcessing(Configurable parent, Configurable child)
void	propertyChange(PropertyChangeEvent evt)
protected boolean	remove(Configurable parent, Configurable child)
protected void	setSearchAdvanced(JCheckBox searchAdvanced)	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	setSearchAdvanced(JRadioButton searchFiltered)
protected void	setSearchDialog(JDialog searchDialog)
protected void	setSearchField(JTextField searchField)
void	treeCollapsed(TreeExpansionEvent event)	A cell has been collapsed.
void	treeExpanded(TreeExpansionEvent event)
protected void	updateEditMenu()
void	updateGpIds(Configurable c)	Allocate new PieceSlot Ids to any PieceSlot subcomponents
void	valueChanged(TreeSelectionEvent e)	Tree selection changed, record info about the currently selected component

Methods inherited from class javax.swing.JTree

addSelectionInterval, addSelectionPath, addSelectionPaths, addSelectionRow, addSelectionRows, addTreeExpansionListener, addTreeSelectionListener, addTreeWillExpandListener, cancelEditing, clearSelection, clearToggledPaths, collapsePath, collapseRow, convertValueToText, createTreeModel, createTreeModelListener, expandPath, expandRow, fireTreeCollapsed, fireTreeExpanded, fireTreeWillCollapse, fireTreeWillExpand, fireValueChanged, getAccessibleContext, getAnchorSelectionPath, getCellEditor, getCellRenderer, getClosestPathForLocation, getClosestRowForLocation, getDefaultTreeModel, getDescendantToggledPaths, getDragEnabled, getDropLocation, getDropMode, getEditingPath, getExpandedDescendants, getExpandsSelectedPaths, getInvokesStopCellEditing, getLastSelectedPathComponent, getLeadSelectionPath, getLeadSelectionRow, getMaxSelectionRow, getMinSelectionRow, getModel, getNextMatch, getPathBetweenRows, getPathBounds, getPathForLocation, getPathForRow, getPreferredScrollableViewportSize, getRowBounds, getRowCount, getRowForLocation, getRowForPath, getRowHeight, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getScrollsOnExpand, getSelectionCount, getSelectionModel, getSelectionPath, getSelectionPaths, getSelectionRows, getShowsRootHandles, getToggleClickCount, getToolTipText, getTreeExpansionListeners, getTreeSelectionListeners, getTreeWillExpandListeners, getUI, getUIClassID, getVisibleRowCount, hasBeenExpanded, isCollapsed, isCollapsed, isEditable, isEditing, isExpanded, isExpanded, isFixedRowHeight, isLargeModel, isPathEditable, isPathSelected, isRootVisible, isRowSelected, isSelectionEmpty, isVisible, makeVisible, paramString, removeDescendantSelectedPaths, removeDescendantToggledPaths, removeSelectionInterval, removeSelectionPath, removeSelectionPaths, removeSelectionRow, removeSelectionRows, removeTreeExpansionListener, removeTreeSelectionListener, removeTreeWillExpandListener, scrollPathToVisible, scrollRowToVisible, setAnchorSelectionPath, setCellEditor, setCellRenderer, setDragEnabled, setDropMode, setEditable, setExpandedState, setExpandsSelectedPaths, setInvokesStopCellEditing, setLargeModel, setLeadSelectionPath, setModel, setRootVisible, setRowHeight, setScrollsOnExpand, setSelectionInterval, setSelectionModel, setSelectionPath, setSelectionPaths, setSelectionRow, setSelectionRows, setShowsRootHandles, setToggleClickCount, setUI, setVisibleRowCount, startEditingAtPath, stopEditing, treeDidChange, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, 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, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Details

nodes

protected Map<Configurable,DefaultMutableTreeNode> nodes

copyData

protected DefaultMutableTreeNode copyData

cutData

protected DefaultMutableTreeNode cutData

helpWindow

protected HelpWindow helpWindow

editorWindow

protected EditorWindow editorWindow

selected

protected Configurable selected

selectedRow

protected int selectedRow

searchCmd

protected String searchCmd

moveCmd

protected String moveCmd

deleteCmd

protected String deleteCmd

pasteCmd

protected String pasteCmd

copyCmd

protected String copyCmd

cutCmd

protected String cutCmd

helpCmd

protected String helpCmd

propertiesCmd

protected String propertiesCmd

translateCmd

protected String translateCmd

duplicateCmd

protected String duplicateCmd

cutKey

protected KeyStroke cutKey

copyKey

protected KeyStroke copyKey

pasteKey

protected KeyStroke pasteKey

deleteKey

protected KeyStroke deleteKey

moveKey

protected KeyStroke moveKey

searchKey

protected KeyStroke searchKey

helpKey

protected KeyStroke helpKey

propertiesKey

protected KeyStroke propertiesKey

translateKey

protected KeyStroke translateKey

duplicateKey

protected KeyStroke duplicateKey

cutAction

protected Action cutAction

copyAction

protected Action copyAction

pasteAction

protected Action pasteAction

deleteAction

protected Action deleteAction

moveAction

protected Action moveAction

searchAction

protected Action searchAction

propertiesAction

protected Action propertiesAction

translateAction

protected Action translateAction

helpAction

protected Action helpAction

duplicateAction

protected Action duplicateAction

searchDialog

protected JDialog searchDialog

searchField

protected JTextField searchField

searchFiltered

protected JRadioButton searchFiltered

searchAdvanced

@Deprecated(since="2023-10-17",
            forRemoval=true)
protected JCheckBox searchAdvanced

Deprecated, for removal: This API element is subject to removal in a future version.

chatter

protected static Chatter chatter

POPUP_MENU_FONT

@Deprecated(since="2022-08-08",
            forRemoval=true)
public static final Font POPUP_MENU_FONT

Deprecated, for removal: This API element is subject to removal in a future version.

additionalComponents

protected static final List<ConfigureTree.AdditionalComponent> additionalComponents

defaultExportExtension

public static final String defaultExportExtension

See Also:

• Constant Field Values

newNodeSelected

protected static boolean newNodeSelected

lastFoundNode

protected static DefaultMutableTreeNode lastFoundNode

selectedNodeIndex

protected static int selectedNodeIndex

Constructor Details

ConfigureTree

public ConfigureTree(Configurable root,
 HelpWindow helpWindow)

Creates new ConfigureTree

ConfigureTree

public ConfigureTree(Configurable root,
 HelpWindow helpWindow,
 EditorWindow editorWindow)

ConfigureTree

public ConfigureTree(Configurable root,
 HelpWindow helpWindow,
 EditorWindow editorWindow,
 boolean disableDragAndDrop)

Method Details

noHTML

public static String noHTML(String text)

chat

protected static void chat(String text)

getSearchDialog

protected JDialog getSearchDialog()

setSearchDialog

protected void setSearchDialog(JDialog searchDialog)

getSearchField

protected JTextField getSearchField()

setSearchField

protected void setSearchField(JTextField searchField)

setSearchAdvanced

protected void setSearchAdvanced(JRadioButton searchFiltered)

setSearchAdvanced

@Deprecated(since="2023-10-17",
            forRemoval=true)
protected void setSearchAdvanced(JCheckBox searchAdvanced)

Deprecated, for removal: This API element is subject to removal in a future version.

getSearchAdvanced

@Deprecated(since="2023-10-17",
            forRemoval=true)
protected JCheckBox getSearchAdvanced()

Deprecated, for removal: This API element is subject to removal in a future version.

getFrame

public JFrame getFrame()

treeExpanded

public void treeExpanded(TreeExpansionEvent event)

Specified by:

treeExpanded in interface TreeExpansionListener

treeCollapsed

public void treeCollapsed(TreeExpansionEvent event)

A cell has been collapsed. Reset the edit flag on all the children owned by this node

Specified by:

treeCollapsed in interface TreeExpansionListener

Parameters:

event - Expansion event

buildRenderer

protected VASSAL.configure.ConfigureTree.Renderer buildRenderer()

notifyStateChanged

protected void notifyStateChanged(boolean changed)

Tell our enclosing EditorWindow that we are now clean or dirty.

Parameters:

changed - true = state is not dirty

getTarget

protected Configurable getTarget(int x,
 int y)

buildTreeNode

protected DefaultMutableTreeNode buildTreeNode(Configurable c)

addAction

protected void addAction(JPopupMenu menu,
 Action a)

addSubMenu

protected void addSubMenu(JPopupMenu menu,
 String name,
 List<Action> l)

buildPopupMenu

protected JPopupMenu buildPopupMenu(Configurable target)

exportTreeBranch

protected boolean exportTreeBranch(AbstractBuildable target)

importTreeBranch

protected boolean importTreeBranch(Configurable target)

buildSearchAction

protected Action buildSearchAction(Configurable target)

Returns:

Search action - runs search dialog box, then searches

buildExportTreeAction

protected Action buildExportTreeAction(Configurable target)

buildImportTreeAction

protected Action buildImportTreeAction(Configurable target)

buildMoveAction

protected Action buildMoveAction(Configurable target)

buildCutAction

protected Action buildCutAction(Configurable target)

buildCopyAction

protected Action buildCopyAction(Configurable target)

postPasteFixups

protected void postPasteFixups(Configurable target)

If there are items that need to be adjusted after being pasted (to make sure they don't contain illegal values that will be hard to debug later), we can make them here.

Parameters:

target - Item we just pasted

buildPasteAction

protected Action buildPasteAction(Configurable target)

isValidPasteTarget

protected boolean isValidPasteTarget(Configurable target,
 DefaultMutableTreeNode sourceNode)

isValidPasteTarget

protected boolean isValidPasteTarget(Configurable target)

convertChild

protected Configurable convertChild(Configurable parent,
 Configurable child)

Some components need to be converted to a new type before insertion. Currently, this is used to allow cut and paste of CardSlots and PieceSlots between Decks and GamePiece Palette components.

Parameters:

parent - Parent Configurable

child - Child Configurable

Returns:

new Child

isAllowedChildClass

protected boolean isAllowedChildClass(Configurable parent,
 Class<?> childClass)

updateGpIds

public void updateGpIds(Configurable c)

Allocate new PieceSlot Ids to any PieceSlot subcomponents

Parameters:

c - Configurable to update

buildImportAction

protected Action buildImportAction(Configurable target)

buildImportDeckAction

protected Action buildImportDeckAction(Configurable target)

buildMassPieceLoaderAction

protected Action buildMassPieceLoaderAction(Configurable target)

hasChild

protected boolean hasChild(Configurable parent,
 Class<?> childClass)

buildAddActionsFor

protected List<Action> buildAddActionsFor(Configurable target)

buildAddActionsFor

protected List<Action> buildAddActionsFor(Configurable target,
 List<Action> peerInserts)

buildAddAction

protected Action buildAddAction(Configurable target,
 Class<? extends Buildable> newConfig)

buildAddAction

protected Action buildAddAction(Configurable target,
 Class<? extends Buildable> newConfig,
 String key,
 int index,
 Configurable duplicate)

buildHelpAction

protected Action buildHelpAction(Configurable target)

buildCloneAction

protected Action buildCloneAction(Configurable target)

getParent

protected Configurable getParent(DefaultMutableTreeNode targetNode)

buildDeleteAction

protected Action buildDeleteAction(Configurable target)

buildEditPiecesAction

protected Action buildEditPiecesAction(Configurable target)

buildOpenPiecesAction

protected Action buildOpenPiecesAction(Configurable target)

buildEditAction

protected Action buildEditAction(Configurable target)

buildTranslateAction

protected Action buildTranslateAction(Configurable target)

canContainGamePiece

public boolean canContainGamePiece(Configurable target)

delete

protected boolean delete(Configurable target)

Delete removes an item from the tree but ALSO traverses the tree throwing all the children's children manually out the airlock, one by one. Lest they return and live on as zombies...

remove

protected boolean remove(Configurable parent,
 Configurable child)

insert

protected boolean insert(Configurable parent,
 Configurable child,
 int index)

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

getConfigureName

public static String getConfigureName(Class<?> c)

Returns the name of the class for display purposes. Reflection is used to call getConfigureTypeName(), which should be a static method if it exists in the given class. (This is necessary because static methods are not permitted in interfaces.)

Parameters:

c - the class whose configure name will be returned

Returns:

the configure name of the class

getConfigureName

public static String getConfigureName(Configurable c)

importConfigurable

protected Configurable importConfigurable()

maybePopup

protected void maybePopup(MouseEvent e)

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

getTreeNode

public DefaultMutableTreeNode getTreeNode(Configurable target)

mouseDragged

public void mouseDragged(MouseEvent evt)

Specified by:

mouseDragged in interface MouseMotionListener

isMoveAllowed

public boolean isMoveAllowed(Configurable target)

Is the Component allowed to be moved?

isDeleteAllowed

protected boolean isDeleteAllowed(Configurable target)

Is the Component allowed to be deleted? A mandatory component can be deleted if there is more than one of them with the same parent

isDuplicateAllowed

protected boolean isDuplicateAllowed(Configurable target)

Is the Component allowed to be duplicated?

isValidParent

protected boolean isValidParent(Configurable parent,
 Configurable child)

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

nodeUpdated

public void nodeUpdated(Configurable target)

jumpToTarget

public void jumpToTarget(Configurable target)

externalInsert

public void externalInsert(Configurable parent,
 Configurable child)

Build an AddAction and execute it to request a new component from the user

Parameters:

parent - Target Parent

child - Type to add

getHelpAction

public Action getHelpAction()

populateEditMenu

public void populateEditMenu(EditorWindow ew)

doKeyAction

protected void doKeyAction(String action)

Handle main Edit menu selections/accelerators

Parameters:

action - Edit command name

valueChanged

public void valueChanged(TreeSelectionEvent e)

Tree selection changed, record info about the currently selected component

Specified by:

valueChanged in interface TreeSelectionListener

updateEditMenu

protected void updateEditMenu()

getParent

protected Configurable getParent(Configurable target)

Find the parent Configurable of a specified Configurable

Parameters:

target - target Configurable

Returns:

parent

getSearchCmd

public String getSearchCmd()

addAdditionalComponent

public static void addAdditionalComponent(Class<? extends Buildable> parent,
 Class<? extends Buildable> child)

Record additional available components to add to the popup menu.

Parameters:

parent - Parent Class

child - Child Class

nodeEdited

public void nodeEdited(Configurable target)

Called when the Configurable held by a node has been edited. Set the edit status and re-build the Jtree label

Parameters:

target - Edited Configurable

checkMinimumIndex

public int checkMinimumIndex(DefaultMutableTreeNode targetNode,
 int index)

Allows ExtensionEditor to override and control what indexes are allowed

postInsertProcessing

protected void postInsertProcessing(Configurable parent,
 Configurable child)

postRemoveProcessing

protected void postRemoveProcessing(Configurable parent,
 Configurable child)