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
The configuration tree for editing a module extension
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class ConfigureTree
ConfigureTree.AddAction, ConfigureTree.AdditionalComponent, ConfigureTree.ImportAction, ConfigureTree.MutableModifier and TypeClassDescriptionprotected classprotected static classprotected classstatic interfaceConfigurers 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 JTree
JTree.AccessibleJTree, JTree.DropLocation, JTree.DynamicUtilTreeNode, JTree.EmptySelectionModel, JTree.TreeModelHandler, JTree.TreeSelectionRedirectorNested classes/interfaces inherited from class JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
Fields inherited from class 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, translateKeyModifier and TypeFieldDescriptionprotected static final List<ConfigureTree.AdditionalComponent> protected static Chatterprotected Actionprotected Stringprotected DefaultMutableTreeNodeprotected KeyStrokeprotected Actionprotected Stringprotected DefaultMutableTreeNodeprotected KeyStrokestatic final Stringprotected Actionprotected Stringprotected KeyStrokeprotected Actionprotected Stringprotected KeyStrokeprotected EditorWindowprotected Actionprotected Stringprotected KeyStrokeprotected HelpWindowprotected static DefaultMutableTreeNodeprotected Actionprotected Stringprotected KeyStrokeprotected static booleanprotected Map<Configurable, DefaultMutableTreeNode> protected Actionprotected Stringprotected KeyStrokestatic final FontDeprecated, for removal: This API element is subject to removal in a future version.protected Actionprotected Stringprotected KeyStrokeprotected Actionprotected JCheckBoxprotected Stringprotected JDialogprotected JTextFieldprotected JRadioButtonprotected KeyStrokeprotected Configurableprotected static intprotected intprotected Actionprotected Stringprotected KeyStrokeFields inherited from class 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, visibleRowCountFields inherited from class JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH -
Constructor Summary
ConstructorsConstructorDescriptionExtensionTree(Configurable root, HelpWindow helpWindow, ModuleExtension extension, EditorWindow editorWindow) -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddToExtension(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 childprotected ActionbuildAddAction(Configurable target, Class<? extends Buildable> newConfig) protected ActionbuildAddAction(Configurable target, Class<? extends Buildable> newConfig, String key, int index, Configurable duplicate) protected ActionbuildCloneAction(Configurable target) protected ActionbuildCutAction(Configurable target) protected ActionbuildDeleteAction(Configurable target) protected ActionbuildEditAction(Configurable target) protected ActionbuildEditPiecesAction(Configurable target) protected ActionbuildImportAction(Configurable target) protected ActionbuildMoveAction(Configurable target) protected ActionbuildOpenPiecesAction(Configurable target) protected ActionbuildPasteAction(Configurable target) intcheckMinimumIndex(DefaultMutableTreeNode targetNode, int index) Allows ExtensionEditor to override and control what indexes are available during drag and dropprotected voiddeleteFromExtension(Configurable parent, Configurable child) Delete the corresponding ExtensionElement from the Extension if the parent is non-editable i.e.voidexternalInsert(Configurable parent, Configurable child) Build an AddAction and execute it to request a new component from the userbooleanprotected booleanisValidParent(Configurable parent, Configurable child) protected booleanisValidPasteTarget(Configurable target) protected booleanisValidPasteTarget(Configurable target, DefaultMutableTreeNode sourceNode) protected voidpostInsertProcessing(Configurable parent, Configurable child) protected voidpostRemoveProcessing(Configurable parent, Configurable child) protected voidvoidAllocate new PieceSlot Id's to any PieceSlot sub-componentsMethods inherited from class 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, valueChangedModifier and TypeMethodDescriptionprotected voidaddAction(JPopupMenu menu, Action a) static voidaddAdditionalComponent(Class<? extends Buildable> parent, Class<? extends Buildable> child) Record additional available components to add to the popup menu.protected voidaddSubMenu(JPopupMenu menu, String name, List<Action> l) buildAddActionsFor(Configurable target) buildAddActionsFor(Configurable target, List<Action> peerInserts) protected ActionbuildCopyAction(Configurable target) protected ActionbuildExportTreeAction(Configurable target) protected ActionbuildHelpAction(Configurable target) protected ActionbuildImportDeckAction(Configurable target) protected ActionbuildImportTreeAction(Configurable target) protected Actionprotected JPopupMenubuildPopupMenu(Configurable target) protected VASSAL.configure.ConfigureTree.Rendererprotected ActionbuildSearchAction(Configurable target) protected ActionbuildTranslateAction(Configurable target) protected DefaultMutableTreeNodebooleancanContainGamePiece(Configurable target) protected static voidprotected ConfigurableconvertChild(Configurable parent, Configurable child) Some components need to be converted to a new type before insertion.protected booleandelete(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 voiddoKeyAction(String action) Handle main Edit menu selections/acceleratorsprotected booleanexportTreeBranch(AbstractBuildable target) static StringgetConfigureName(Class<?> c) Returns the name of the class for display purposes.static StringgetFrame()protected ConfigurablegetParent(DefaultMutableTreeNode targetNode) protected ConfigurablegetParent(Configurable target) Find the parent Configurable of a specified Configurableprotected JCheckBoxprotected JDialogprotected JTextFieldprotected ConfigurablegetTarget(int x, int y) getTreeNode(Configurable target) protected booleanhasChild(Configurable parent, Class<?> childClass) protected Configurableprotected booleanimportTreeBranch(Configurable target) protected booleaninsert(Configurable parent, Configurable child, int index) protected booleanisAllowedChildClass(Configurable parent, Class<?> childClass) protected booleanisDeleteAllowed(Configurable target) Is the Component allowed to be deleted?protected booleanisDuplicateAllowed(Configurable target) Is the Component allowed to be duplicated?booleanisMoveAllowed(Configurable target) Is the Component allowed to be moved?voidjumpToTarget(Configurable target) protected voidvoidvoidmouseDragged(MouseEvent evt) voidvoidvoidvoidvoidvoidnodeEdited(Configurable target) Called when the Configurable held by a node has been edited.voidnodeUpdated(Configurable target) static Stringprotected voidnotifyStateChanged(boolean changed) Tell our enclosing EditorWindow that we are now clean or dirty.voidprotected voidpostPasteFixups(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.voidprotected booleanremove(Configurable parent, Configurable child) protected voidsetSearchAdvanced(JCheckBox searchAdvanced) protected voidsetSearchAdvanced(JRadioButton searchFiltered) protected voidsetSearchDialog(JDialog searchDialog) protected voidsetSearchField(JTextField searchField) voidtreeCollapsed(TreeExpansionEvent event) A cell has been collapsed.voidtreeExpanded(TreeExpansionEvent event) voidTree selection changed, record info about the currently selected componentMethods inherited from class 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, updateUIMethods inherited from class 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, updateMethods inherited from class 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, validateTreeMethods inherited from class 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
-
Constructor Details
-
ExtensionTree
public ExtensionTree(Configurable root, HelpWindow helpWindow, ModuleExtension extension, EditorWindow editorWindow)
-
-
Method Details
-
checkMinimumIndex
Allows ExtensionEditor to override and control what indexes are available during drag and drop- Overrides:
checkMinimumIndexin classConfigureTree
-
isEditable
-
getPath
-
externalInsert
Description copied from class:ConfigureTreeBuild an AddAction and execute it to request a new component from the user- Overrides:
externalInsertin classConfigureTree- Parameters:
parent- Target Parentchild- Type to add
-
buildAddAction
- Overrides:
buildAddActionin classConfigureTree
-
buildAddAction
protected Action buildAddAction(Configurable target, Class<? extends Buildable> newConfig, String key, int index, Configurable duplicate) - Overrides:
buildAddActionin classConfigureTree
-
buildImportAction
- Overrides:
buildImportActionin classConfigureTree
-
buildEditAction
- Overrides:
buildEditActionin classConfigureTree
-
buildCutAction
- Overrides:
buildCutActionin classConfigureTree
-
buildPasteAction
- Overrides:
buildPasteActionin classConfigureTree
-
isValidPasteTarget
- Overrides:
isValidPasteTargetin classConfigureTree
-
isValidPasteTarget
- Overrides:
isValidPasteTargetin classConfigureTree
-
updateGpIds
Allocate new PieceSlot Id's to any PieceSlot sub-components- Overrides:
updateGpIdsin classConfigureTree- Parameters:
c- Configurable to update
-
buildMoveAction
- Overrides:
buildMoveActionin classConfigureTree
-
buildDeleteAction
- Overrides:
buildDeleteActionin classConfigureTree
-
buildCloneAction
- Overrides:
buildCloneActionin classConfigureTree
-
buildEditPiecesAction
- Overrides:
buildEditPiecesActionin classConfigureTree
-
buildOpenPiecesAction
- Overrides:
buildOpenPiecesActionin classConfigureTree
-
isValidParent
- Overrides:
isValidParentin classConfigureTree
-
updateEditMenu
protected void updateEditMenu()- Overrides:
updateEditMenuin classConfigureTree
-
deleteFromExtension
Delete the corresponding ExtensionElement from the Extension if the parent is non-editable i.e. It is part of the base module -
addToExtension
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
- Overrides:
postInsertProcessingin classConfigureTree
-
postRemoveProcessing
- Overrides:
postRemoveProcessingin classConfigureTree
-