Class PieceDefiner

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

VASSAL.counters.PieceDefiner

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

MassPieceDefiner, PrototypeDefinition.Config.Definer

public class PieceDefiner
extends JPanel

This is the GamePiece designer dialog. It appears when you edit the properties of a "Single Piece" in the Configuration window.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	PieceDefiner.Ed	A Dialog for editing an EditablePiece's properties
protected static class	PieceDefiner.TraitClipboard	Contents of the Copy/Paste buffer for traits in the editor

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

JPanel.AccessibleJPanel

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 JList<GamePiece>	availableList
protected static DefaultListModel<GamePiece>	availableModel
protected ListCellRenderer<? super GamePiece>	availableRenderer
protected boolean	changed
protected static PieceDefiner.TraitClipboard	clipBoard
protected JButton	copyButton
protected GpIdSupport	gpidSupport
protected DefaultListModel<GamePiece>	inUseModel
protected JButton	pasteButton
protected String	pieceId
protected JLabel	pieceIdLabel
protected ListCellRenderer<? super GamePiece>	r
protected VASSAL.counters.PieceDefiner.ScaleablePieceSlot	slot

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
PieceDefiner()	Creates new form test
PieceDefiner(String id, GpIdSupport s)
PieceDefiner(GpIdSupport s)

Method Summary

Modifier and Type	Method	Description
static void	addDefinition(GamePiece definition)	Plugins can add additional GamePiece definitions
protected static void	addElement(GamePiece piece)
protected void	addTrait(Decorator c)
protected void	addTrait(Decorator c, int insertIndex)
protected void	copy(int index)
protected boolean	edit(int index)
protected int	getInUseSelectedIndex()
GamePiece	getPiece()
static Boolean	getSorted()
List<GamePiece>	getTraitList()	Export a List of all the allowable traits
protected void	importPiece(String className)
void	initCustomControls(JDialog d, Configurable target)
protected static void	initDefinitions()
protected void	insertDecorator(int index, GamePiece piece)	Insert a Decorator into the list at a given position
boolean	isChanged()
boolean	isPrototype()
boolean	isSplitDragInProgress()
protected void	moveDecorator(int fromIndex, int toIndex)	Move a Decorator to a new position in the list
protected void	moveDecoratorBottom(int index)
protected void	moveDecoratorDown(int index)
protected void	moveDecoratorTop(int index)
protected void	moveDecoratorUp(int index)
protected void	paste()
protected void	refresh()	The piece defined has been changed.
protected GamePiece	removeDecorator(int index)	Remove the Decorator at a given position in the list
protected void	removeTrait(int index)
void	setChanged(boolean b)
void	setPiece(GamePiece piece)
void	setPrototypeName(String prototypeName)
static void	setSorted(Boolean sorted)
void	setSplitDragInProgress(boolean splitDragInProgress)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, 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

availableModel

protected static DefaultListModel<GamePiece> availableModel

inUseModel

protected DefaultListModel<GamePiece> inUseModel

r

protected ListCellRenderer<? super GamePiece> r

availableRenderer

protected ListCellRenderer<? super GamePiece> availableRenderer

slot

protected VASSAL.counters.PieceDefiner.ScaleablePieceSlot slot

clipBoard

protected static PieceDefiner.TraitClipboard clipBoard

pieceId

protected String pieceId

pieceIdLabel

protected JLabel pieceIdLabel

gpidSupport

protected GpIdSupport gpidSupport

changed

protected boolean changed

availableList

protected JList<GamePiece> availableList

copyButton

protected JButton copyButton

pasteButton

protected JButton pasteButton

Constructor Details

PieceDefiner

public PieceDefiner()

Creates new form test

PieceDefiner

public PieceDefiner(String id,
 GpIdSupport s)

PieceDefiner

public PieceDefiner(GpIdSupport s)

Method Details

isPrototype

public boolean isPrototype()

setPrototypeName

public void setPrototypeName(String prototypeName)

getInUseSelectedIndex

protected int getInUseSelectedIndex()

addElement

protected static void addElement(GamePiece piece)

initDefinitions

protected static void initDefinitions()

addDefinition

public static void addDefinition(GamePiece definition)

Plugins can add additional GamePiece definitions

Parameters:

definition - GamePiece definition to add

getSorted

public static Boolean getSorted()

setSorted

public static void setSorted(Boolean sorted)

setPiece

public void setPiece(GamePiece piece)

refresh

protected void refresh()

The piece defined has been changed. It may have changed size, or image

getPiece

public GamePiece getPiece()

setChanged

public void setChanged(boolean b)

isChanged

public boolean isChanged()

initCustomControls

public void initCustomControls(JDialog d,
 Configurable target)

isSplitDragInProgress

public boolean isSplitDragInProgress()

setSplitDragInProgress

public void setSplitDragInProgress(boolean splitDragInProgress)

copy

protected void copy(int index)

paste

protected void paste()

moveDecoratorDown

protected void moveDecoratorDown(int index)

moveDecoratorUp

protected void moveDecoratorUp(int index)

moveDecoratorTop

protected void moveDecoratorTop(int index)

moveDecoratorBottom

protected void moveDecoratorBottom(int index)

moveDecorator

protected void moveDecorator(int fromIndex,
 int toIndex)

Move a Decorator to a new position in the list

Parameters:

fromIndex - Old Position

toIndex - New Position

removeDecorator

protected GamePiece removeDecorator(int index)

Remove the Decorator at a given position in the list

Parameters:

index - Position of Decorator to remove

Returns:

Removed Decorator

insertDecorator

protected void insertDecorator(int index,
 GamePiece piece)

Insert a Decorator into the list at a given position

Parameters:

index - Position to insert Decorator

piece - Decorator to insert

importPiece

protected void importPiece(String className)

edit

protected boolean edit(int index)

removeTrait

protected void removeTrait(int index)

addTrait

protected void addTrait(Decorator c)

addTrait

protected void addTrait(Decorator c,
 int insertIndex)

getTraitList

public List<GamePiece> getTraitList()

Export a List of all the allowable traits

Returns: