Package VASSAL.i18n

Class TranslateWindow

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

VASSAL.i18n.TranslateWindow

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ListSelectionListener, TreeSelectionListener, RootPaneContainer, WindowConstants

Direct Known Subclasses:

TranslateVassalWindow

public class TranslateWindow
extends JDialog
implements ListSelectionListener, TreeSelectionListener

Window for editing translations of a Configurable object

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	TranslateWindow.JComponentCellEditor	Custom CellEditor to support CopyButtons in JTable cells
protected static class	TranslateWindow.JComponentCellRenderer	Custom Cell Renderer to support CopyButtons in JTable cells
protected static class	TranslateWindow.MyPropertiesWindow
protected static class	TranslateWindow.MyTreeNode	Custom Tree Node implementation

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

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

Window.AccessibleAWTWindow, Window.Type

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 ActionListener	boxListener
protected JButton	cancelButton
protected VASSAL.i18n.TranslateWindow.CopyButton[]	copyButtons
protected String	currentKey
protected Translation	currentTranslation
protected String[]	keys
protected JTable	keyTable
protected Translatable	keyTarget
protected JComboBox<String>	langBox
protected int	lastSelectedLangIndex
protected ConfigureTree	myConfigureTree
protected static final Color	NO_TRANSLATION_NEEDED_COLOR
protected JButton	okButton
protected Translatable	target
protected static final Color	TRANSLATION_DONE_COLOR
protected static final Color	TRANSLATION_NEEDED_COLOR
protected JTree	tree

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
TranslateWindow(Frame owner, boolean modal, Translatable target, ConfigureTree tree)

Method Summary

Modifier and Type	Method	Description
protected JPanel	buildKeyTablePanel()
protected Component	buildMainPanel()
protected void	cancel()	Cancel button clicked.
protected void	changeLanguage(String selectedTranslation)	New Language selected from the drop-down box
protected void	commitTableEdit()
protected void	createNodes(TranslateWindow.MyTreeNode top)	Create the nodes for the JTree display
protected Component	getButtonPanel()
static String	getDisplayName(Translatable t)
protected Component	getHeaderPanel()
protected void	getNewTranslation()	User has clicked on the Add Translation button.
protected void	initComponents()
protected boolean	querySave()
protected void	refreshTranslationList(Configurable target)	Called from MyPropertiesWindow when the user saves the new translation
protected void	reloadTranslation()	Reload the current translation from the archive
protected void	save()	Save button clicked
protected boolean	saveTranslation()	Save the current Translation
void	valueChanged(ListSelectionEvent e)	When a key is selected in the table, display the source and translated texts in the right hand panels
void	valueChanged(TreeSelectionEvent e)	When a new node is selected, display keys for the new component in the keys table

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, 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

TRANSLATION_NEEDED_COLOR

protected static final Color TRANSLATION_NEEDED_COLOR

TRANSLATION_DONE_COLOR

protected static final Color TRANSLATION_DONE_COLOR

NO_TRANSLATION_NEEDED_COLOR

protected static final Color NO_TRANSLATION_NEEDED_COLOR

target

protected Translatable target

keys

protected String[] keys

keyTable

protected JTable keyTable

keyTarget

protected Translatable keyTarget

tree

protected JTree tree

currentTranslation

protected Translation currentTranslation

langBox

protected JComboBox<String> langBox

boxListener

protected ActionListener boxListener

lastSelectedLangIndex

protected int lastSelectedLangIndex

currentKey

protected String currentKey

myConfigureTree

protected ConfigureTree myConfigureTree

copyButtons

protected VASSAL.i18n.TranslateWindow.CopyButton[] copyButtons

okButton

protected JButton okButton

cancelButton

protected JButton cancelButton

Constructor Details

TranslateWindow

public TranslateWindow(Frame owner,
 boolean modal,
 Translatable target,
 ConfigureTree tree)

Method Details

initComponents

protected void initComponents()

getHeaderPanel

protected Component getHeaderPanel()

getNewTranslation

protected void getNewTranslation()

User has clicked on the Add Translation button. Create a new PropertiesWindow for a translation and display it.

refreshTranslationList

protected void refreshTranslationList(Configurable target)

Called from MyPropertiesWindow when the user saves the new translation

Parameters:

target - new Translation

buildMainPanel

protected Component buildMainPanel()

buildKeyTablePanel

protected JPanel buildKeyTablePanel()

getButtonPanel

protected Component getButtonPanel()

commitTableEdit

protected void commitTableEdit()

changeLanguage

protected void changeLanguage(String selectedTranslation)

New Language selected from the drop-down box

valueChanged

public void valueChanged(TreeSelectionEvent e)

When a new node is selected, display keys for the new component in the keys table

Specified by:

valueChanged in interface TreeSelectionListener

valueChanged

public void valueChanged(ListSelectionEvent e)

When a key is selected in the table, display the source and translated texts in the right hand panels

Specified by:

valueChanged in interface ListSelectionListener

createNodes

protected void createNodes(TranslateWindow.MyTreeNode top)

Create the nodes for the JTree display

getDisplayName

public static String getDisplayName(Translatable t)

cancel

protected void cancel()

Cancel button clicked. Check for outstanding changes.

querySave

protected boolean querySave()
                     throws IOException

Throws:

IOException

save

protected void save()
             throws IOException

Save button clicked

Throws:

IOException - oops

saveTranslation

protected boolean saveTranslation()
                           throws IOException

Save the current Translation

Throws:

IOException - oops

reloadTranslation

protected void reloadTranslation()
                          throws IOException

Reload the current translation from the archive

Throws:

IOException - oops