Class ExtensionTree

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTree

VASSAL.configure.ConfigureTree

VASSAL.configure.ExtensionTree

All Implemented Interfaces:

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

public class ExtensionTree
extends ConfigureTree

The configuration tree for editing a module extension

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class VASSAL.configure.ConfigureTree

ConfigureTree.AddAction, ConfigureTree.AdditionalComponent, ConfigureTree.ImportAction, ConfigureTree.Mutable

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 inherited from class VASSAL.configure.ConfigureTree

additionalComponents, chatter, copyAction, copyCmd, copyData, copyKey, cutAction, cutCmd, cutData, cutKey, defaultExportExtension, deleteAction, deleteCmd, deleteKey, duplicateAction, duplicateCmd, duplicateKey, editorWindow, helpAction, helpCmd, helpKey, helpWindow, lastFoundNode, moveAction, moveCmd, moveKey, newNodeSelected, nodes, pasteAction, pasteCmd, pasteKey, POPUP_MENU_FONT, propertiesAction, propertiesCmd, propertiesKey, searchAction, searchAdvanced, searchCmd, searchDialog, searchField, searchFiltered, searchKey, selected, selectedNodeIndex, selectedRow, translateAction, translateCmd, 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
ExtensionTree(Configurable root, HelpWindow helpWindow, ModuleExtension extension, EditorWindow editorWindow)

Method Summary

Modifier and Type	Method	Description
protected void	addToExtension(Configurable parent, Configurable child)	If the parent we are adding an element to is non-editable, then it is part of the base module and we need to add a new ExtensionElement to the Extension to record the location of child
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 Action	buildCloneAction(Configurable target)
protected Action	buildCutAction(Configurable target)
protected Action	buildDeleteAction(Configurable target)
protected Action	buildEditAction(Configurable target)
protected Action	buildEditPiecesAction(Configurable target)
protected Action	buildImportAction(Configurable target)
protected Action	buildMoveAction(Configurable target)
protected Action	buildOpenPiecesAction(Configurable target)
protected Action	buildPasteAction(Configurable target)
int	checkMinimumIndex(DefaultMutableTreeNode targetNode, int index)	Allows ExtensionEditor to override and control what indexes are available during drag and drop
protected void	deleteFromExtension(Configurable parent, Configurable child)	Delete the corresponding ExtensionElement from the Extension if the parent is non-editable i.e.
void	externalInsert(Configurable parent, Configurable child)	Build an AddAction and execute it to request a new component from the user
Configurable[]	getPath(DefaultMutableTreeNode node)
boolean	isEditable(DefaultMutableTreeNode node)
protected boolean	isValidParent(Configurable parent, Configurable child)
protected boolean	isValidPasteTarget(Configurable target)
protected boolean	isValidPasteTarget(Configurable target, DefaultMutableTreeNode sourceNode)
protected void	postInsertProcessing(Configurable parent, Configurable child)
protected void	postRemoveProcessing(Configurable parent, Configurable child)
protected void	updateEditMenu()
void	updateGpIds(Configurable c)	Allocate new PieceSlot Id's to any PieceSlot sub-components

Methods inherited from class VASSAL.configure.ConfigureTree

addAction, addAdditionalComponent, addSubMenu, buildAddActionsFor, buildAddActionsFor, buildCopyAction, buildExportTreeAction, buildHelpAction, buildImportDeckAction, buildImportTreeAction, buildMassPieceLoaderAction, buildPopupMenu, buildRenderer, buildSearchAction, buildTranslateAction, buildTreeNode, canContainGamePiece, chat, convertChild, delete, doKeyAction, exportTreeBranch, getConfigureName, getConfigureName, getFrame, getHelpAction, getParent, getParent, getSearchAdvanced, getSearchCmd, getSearchDialog, getSearchField, getTarget, getTreeNode, hasChild, importConfigurable, importTreeBranch, insert, isAllowedChildClass, isDeleteAllowed, isDuplicateAllowed, isMoveAllowed, jumpToTarget, maybePopup, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, nodeEdited, nodeUpdated, noHTML, notifyStateChanged, populateEditMenu, postPasteFixups, propertyChange, remove, setSearchAdvanced, setSearchAdvanced, setSearchDialog, setSearchField, treeCollapsed, treeExpanded, valueChanged

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

Constructor Details

ExtensionTree

public ExtensionTree(Configurable root,
 HelpWindow helpWindow,
 ModuleExtension extension,
 EditorWindow editorWindow)

Method Details

checkMinimumIndex

public int checkMinimumIndex(DefaultMutableTreeNode targetNode,
 int index)

Allows ExtensionEditor to override and control what indexes are available during drag and drop

Overrides:

checkMinimumIndex in class ConfigureTree

isEditable

public boolean isEditable(DefaultMutableTreeNode node)

getPath

public Configurable[] getPath(DefaultMutableTreeNode node)

externalInsert

public void externalInsert(Configurable parent,
 Configurable child)

Description copied from class: ConfigureTree

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

Overrides:

externalInsert in class ConfigureTree

Parameters:

parent - Target Parent

child - Type to add

buildAddAction

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

Overrides:

buildAddAction in class ConfigureTree

buildAddAction

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

Overrides:

buildAddAction in class ConfigureTree

buildImportAction

protected Action buildImportAction(Configurable target)

Overrides:

buildImportAction in class ConfigureTree

buildEditAction

protected Action buildEditAction(Configurable target)

Overrides:

buildEditAction in class ConfigureTree

buildCutAction

protected Action buildCutAction(Configurable target)

Overrides:

buildCutAction in class ConfigureTree

buildPasteAction

protected Action buildPasteAction(Configurable target)

Overrides:

buildPasteAction in class ConfigureTree

isValidPasteTarget

protected boolean isValidPasteTarget(Configurable target)

Overrides:

isValidPasteTarget in class ConfigureTree

isValidPasteTarget

protected boolean isValidPasteTarget(Configurable target,
 DefaultMutableTreeNode sourceNode)

Overrides:

isValidPasteTarget in class ConfigureTree

updateGpIds

public void updateGpIds(Configurable c)

Allocate new PieceSlot Id's to any PieceSlot sub-components

Overrides:

updateGpIds in class ConfigureTree

Parameters:

c - Configurable to update

buildMoveAction

protected Action buildMoveAction(Configurable target)

Overrides:

buildMoveAction in class ConfigureTree

buildDeleteAction

protected Action buildDeleteAction(Configurable target)

Overrides:

buildDeleteAction in class ConfigureTree

buildCloneAction

protected Action buildCloneAction(Configurable target)

Overrides:

buildCloneAction in class ConfigureTree

buildEditPiecesAction

protected Action buildEditPiecesAction(Configurable target)

Overrides:

buildEditPiecesAction in class ConfigureTree

buildOpenPiecesAction

protected Action buildOpenPiecesAction(Configurable target)

Overrides:

buildOpenPiecesAction in class ConfigureTree

isValidParent

protected boolean isValidParent(Configurable parent,
 Configurable child)

Overrides:

isValidParent in class ConfigureTree

updateEditMenu

protected void updateEditMenu()

Overrides:

updateEditMenu in class ConfigureTree

deleteFromExtension

protected void deleteFromExtension(Configurable parent,
 Configurable child)

Delete the corresponding ExtensionElement from the Extension if the parent is non-editable i.e. It is part of the base module

addToExtension

protected void addToExtension(Configurable parent,
 Configurable child)

If the parent we are adding an element to is non-editable, then it is part of the base module and we need to add a new ExtensionElement to the Extension to record the location of child

postInsertProcessing

protected void postInsertProcessing(Configurable parent,
 Configurable child)

Overrides:

postInsertProcessing in class ConfigureTree

postRemoveProcessing

protected void postRemoveProcessing(Configurable parent,
 Configurable child)

Overrides:

postRemoveProcessing in class ConfigureTree