org.opensourcephysics.tools
Class TranslatorTool

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      org.opensourcephysics.display.OSPFrame
                          org.opensourcephysics.tools.TranslatorTool

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.print.Printable, java.rmi.Remote, javax.swing.RootPaneContainer, java.io.Serializable, Tool, javax.swing.WindowConstants

public class TranslatorTool

extends OSPFrame

implements Tool

This provides a GUI for creating and editing string resources associated with a class. Resources are stored in properties files with the same name and located in the same folder as the class.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JFrame

javax.swing.JFrame.AccessibleJFrame

Nested classes inherited from class java.awt.Frame

java.awt.Frame.AccessibleAWTFrame

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class org.opensourcephysics.display.OSPFrame

animated, applet, appletMode, authorMode, autoclear, buttonPanel, chooserDir, constructorThreadGroup, customButtons, DEFAULT_LOOK_AND_FEEL, defaultLocales, keepHidden, launcherMode, osp_icon_file, strategy

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Method Summary

static void	addProperty(java.lang.Class type, java.lang.String key, java.lang.String defaultValue) Adds a property to those defined for the specified class.
static void	associate(java.lang.Object obj, java.lang.Class type) Associates an object with a class for property lookup purposes.
static java.lang.String	getProperty(java.lang.Class type, java.lang.String key) Gets the localized value of a property for the specified class.
static java.lang.String	getProperty(java.lang.Class type, java.lang.String key, java.lang.String defaultValue) Gets the localized value of a property for the specified class.
static java.lang.String	getProperty(java.lang.Object obj, java.lang.String key) Gets the localized value of a property for the specified object.
static java.lang.String	getProperty(java.lang.Object obj, java.lang.String key, java.lang.String defaultValue) Gets the localized value of a property for the specified object.
static TranslatorTool	getTool() Gets the shared TranslatorTool.
protected void	refreshGUI() Refreshes the GUI.
static void	removeProperty(java.lang.Class type, java.lang.String key) Removes a property from those defined for the specified class.
static void	removeProperty(java.lang.Object obj, java.lang.String key) Removes a property from those defined for the specified object.
void	send(Job job, Tool replyTo) Sends a job to this tool and specifies a tool to reply to.
void	setLocale(java.util.Locale locale) Sets the locale.
void	showProperties(java.lang.Class type) Shows the properties for the specified class.

Methods inherited from class org.opensourcephysics.display.OSPFrame

addButton, bufferStrategyShow, clearData, clearDataAndRepaint, createBufferStrategy, dispose, getChooser, getConstructorThreadGroup, getDefaultLocales, getMenu, invalidateImage, isAnimated, isAuthorMode, isAutoclear, isIconified, isKeepHidden, isLauncherMode, loadDisplayMenu, loadToolsMenu, parseXMLMenu, parseXMLMenu, print, removeMenu, removeMenuItem, render, setAnimated, setAuthorMode, setAutoclear, setDefaultCloseOperation, setFontLevel, setKeepHidden, setLauncherMode, setSize, setTitle, setVisible, show, wishesToExit

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Frame

addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, 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, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocation, setLocation, setName, setSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Method Detail

getTool

public static TranslatorTool getTool()

Gets the shared TranslatorTool.

Returns:

the shared TranslatorTool

send

public void send(Job job,
                 Tool replyTo)
          throws java.rmi.RemoteException

Sends a job to this tool and specifies a tool to reply to.

Specified by:

send in interface Tool

Parameters:

job - the Job

replyTo - the tool to notify when the job is complete (may be null)

Throws:

java.rmi.RemoteException

setLocale

public void setLocale(java.util.Locale locale)

Sets the locale.

Parameters:

locale - the locale

associate

public static void associate(java.lang.Object obj,
                             java.lang.Class type)

Associates an object with a class for property lookup purposes.

Parameters:

obj - the object needing translations

type - the class

showProperties

public void showProperties(java.lang.Class type)

Shows the properties for the specified class.

Parameters:

type - the class

getProperty

public static java.lang.String getProperty(java.lang.Class type,
                                           java.lang.String key)

Gets the localized value of a property for the specified class. If no localized value is found, the key is returned.

Parameters:

type - the class requesting the localized value

key - the string to localize

Returns:

the localized string

getProperty

public static java.lang.String getProperty(java.lang.Class type,
                                           java.lang.String key,
                                           java.lang.String defaultValue)

Gets the localized value of a property for the specified class. If no localized value is found, the defaultValue is returned.

Parameters:

type - the class requesting the localized value

key - the string to localize

defaultValue - the default if no localized value found

Returns:

the localized string

getProperty

public static java.lang.String getProperty(java.lang.Object obj,
                                           java.lang.String key)

Gets the localized value of a property for the specified object. The object must first be associated with a class. If no localized value is found, the key is returned.

Parameters:

obj - the object requesting the localized value

key - the string to localize

Returns:

the localized string

getProperty

public static java.lang.String getProperty(java.lang.Object obj,
                                           java.lang.String key,
                                           java.lang.String defaultValue)

Gets the localized value of a property for the specified object. The object must first be associated with a class. If no localized value is found, the defaultValue is returned.

Parameters:

obj - the object requesting the localized value

key - the string to localize

defaultValue - the default if no localized value found

Returns:

the localized string

removeProperty

public static void removeProperty(java.lang.Class type,
                                  java.lang.String key)

Removes a property from those defined for the specified class.

Parameters:

type - the class

key - the property to remove

removeProperty

public static void removeProperty(java.lang.Object obj,
                                  java.lang.String key)

Removes a property from those defined for the specified object. The object must first be associated with a class.

Parameters:

obj - the object

key - the property to remove

addProperty

public static void addProperty(java.lang.Class type,
                               java.lang.String key,
                               java.lang.String defaultValue)

Adds a property to those defined for the specified class.

Parameters:

type - the class

key - the property to add

defaultValue - the default value

refreshGUI

protected void refreshGUI()

Refreshes the GUI.

Overrides:

refreshGUI in class OSPFrame