rle.vm
Class TreeTool

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  rle.vm.TreeTool

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.TreeSelectionListener

Direct Known Subclasses:

VariantMgr

public abstract class TreeTool
extends javax.swing.JPanel
implements javax.swing.event.TreeSelectionListener

The base class for configuration tools that use a tree at the left-hand side and a panel of editors at the right.

See Also:

Serialized Form

Nested Class Summary

static class

TreeTool.Mode

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

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

Field Summary

protected javax.swing.JMenu	actionMenu
protected InfoGroupNode	currentData
protected SchemaBean	currentSchema
protected VariantBean	currentVariant
protected javax.swing.JMenu	fileMenu
protected javax.swing.JMenu	optionMenu
protected javax.swing.JMenu	schemaMenu
protected javax.swing.JMenu	variantMenu

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

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

TreeTool()

Method Summary

protected abstract void	addRecentVariant(VariantBean variant) Add this variant to the list of recent variants.
protected abstract java.util.ArrayList<VariantBean>	availableVariants() Generate a list of available variants according to the particular implementation.
void	closeVariant() Close the current variant and remove any interfaces associated with it.
protected void	createOptionsMenu()
abstract InfoGroupNode	createRootNode(VariantBean variant) Create a root node from the data file for this variant.
abstract SchemaBean	createSchema(VariantBean variant) Create a schema from the schema file for this variant.
protected void	createUi()
protected abstract VariantBean	createVariant() Create a new variant.
protected javax.swing.JFrame	createWindow(java.lang.String title) Configure a window to display this tree tool.
void	currentValueChanged() Pretend that the currently selected node was just selected, ie repopulate the right hand side.
protected void	doClone()
protected void	doCopyNode()
protected void	doDown() Move the selected node down.
protected void	doEditStructure() Pop a dialog to manage the attributes and structural properties of a group or instance node.
protected void	doInsertGroup() Insert a new group for the structure of the current instance, or subgroup for the structure of the current group.
protected void	doInsertInstance() Insert a new instance of the current group.
protected abstract void	doManageEditors()
protected abstract void	doManageGlobalAttributeSets()
protected abstract void	doManageLanguages()
protected abstract void	doManageProperties()
protected void	doMoveNode()
protected void	doUp() Move the selected node up.
protected abstract VariantBean	findVariant(java.lang.String key) Locate a particular variant based on its key.
InfoGroupNode	getCurrentData()
SchemaBean	getCurrentSchema()
VariantBean	getCurrentVariant()
protected Form	getForm()
javax.swing.JComponent	getFormContainer()
TreeTool.Mode	getMode()
protected javax.swing.JLabel	getNodeLabel()
java.lang.String	getTranslatingLangId() The id of the foreign language we are now translating to, or null if there is no such language.
javax.swing.JTree	getTree() Returns a handle to the tree
void	openVariant(VariantBean variant) Open a variant for editing or viewing.
protected abstract void	persist() Persist the current variant.
protected abstract java.util.ArrayList<VariantBean>	recentVariants() Retrieve the list of recently used variants, for use in populating the items in the file menu.
void	setMode(TreeTool.Mode m)
void	setTranslatingLangId(java.lang.String s)
abstract void	valueChanged(javax.swing.tree.TreePath treePath)

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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, 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, 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, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.event.TreeSelectionListener

valueChanged

Field Detail

currentVariant

protected VariantBean currentVariant

currentSchema

protected SchemaBean currentSchema

currentData

protected InfoGroupNode currentData

fileMenu

protected javax.swing.JMenu fileMenu

variantMenu

protected javax.swing.JMenu variantMenu

schemaMenu

protected javax.swing.JMenu schemaMenu

actionMenu

protected javax.swing.JMenu actionMenu

optionMenu

protected javax.swing.JMenu optionMenu

Constructor Detail

TreeTool

public TreeTool()

Method Detail

createRootNode

public abstract InfoGroupNode createRootNode(VariantBean variant)

Create a root node from the data file for this variant. If no such file exists, initialize a new root node.

Parameters:

variant -

Returns:

createSchema

public abstract SchemaBean createSchema(VariantBean variant)

Create a schema from the schema file for this variant. If no such file exists, initialize a new schema.

Parameters:

variant -

Returns:

openVariant

public void openVariant(VariantBean variant)

Open a variant for editing or viewing.

Parameters:

variant -

closeVariant

public void closeVariant()

Close the current variant and remove any interfaces associated with it.

createVariant

protected abstract VariantBean createVariant()

Create a new variant. This method should be implemented to provide any particular functionality desired.

Returns:

availableVariants

protected abstract java.util.ArrayList<VariantBean> availableVariants()

Generate a list of available variants according to the particular implementation.

recentVariants

protected abstract java.util.ArrayList<VariantBean> recentVariants()

Retrieve the list of recently used variants, for use in populating the items in the file menu.

addRecentVariant

protected abstract void addRecentVariant(VariantBean variant)

Add this variant to the list of recent variants.

findVariant

protected abstract VariantBean findVariant(java.lang.String key)

Locate a particular variant based on its key.

Parameters:

key -

Returns:

persist

protected abstract void persist()
                         throws java.lang.Exception

Persist the current variant. This will be called when the user clicks "save."

Throws:

java.lang.Exception

getCurrentVariant

public VariantBean getCurrentVariant()

getCurrentSchema

public SchemaBean getCurrentSchema()

getCurrentData

public InfoGroupNode getCurrentData()

createWindow

protected javax.swing.JFrame createWindow(java.lang.String title)

Configure a window to display this tree tool.

Parameters:

title -

Returns:

createOptionsMenu

protected void createOptionsMenu()

currentValueChanged

public void currentValueChanged()

Pretend that the currently selected node was just selected, ie repopulate the right hand side.

valueChanged

public abstract void valueChanged(javax.swing.tree.TreePath treePath)

doManageProperties

protected abstract void doManageProperties()

doManageGlobalAttributeSets

protected abstract void doManageGlobalAttributeSets()

doManageLanguages

protected abstract void doManageLanguages()

doManageEditors

protected abstract void doManageEditors()

getFormContainer

public javax.swing.JComponent getFormContainer()

getNodeLabel

protected javax.swing.JLabel getNodeLabel()

getForm

protected Form getForm()

createUi

protected void createUi()

doClone

protected void doClone()

doCopyNode

protected void doCopyNode()

doMoveNode

protected void doMoveNode()

doInsertInstance

protected void doInsertInstance()

Insert a new instance of the current group.

doInsertGroup

protected void doInsertGroup()

Insert a new group for the structure of the current instance, or subgroup for the structure of the current group.

doEditStructure

protected void doEditStructure()

Pop a dialog to manage the attributes and structural properties of a group or instance node.

doUp

protected void doUp()

Move the selected node up.

doDown

protected void doDown()

Move the selected node down.

getTree

public javax.swing.JTree getTree()

Returns a handle to the tree

Returns:

setMode

public void setMode(TreeTool.Mode m)

getMode

public TreeTool.Mode getMode()

getTranslatingLangId

public java.lang.String getTranslatingLangId()

The id of the foreign language we are now translating to, or null if there is no such language.

setTranslatingLangId

public void setTranslatingLangId(java.lang.String s)