org.wandora.application.gui.tree

Class TopicTreePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.wandora.application.gui.tree.TopicTreePanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, TopicSelector, RefreshListener, TopicMapListener

public class TopicTreePanel
extends javax.swing.JPanel
implements TopicSelector, TopicMapListener, RefreshListener

Author:

olli

See Also:

Serialized Form

Nested Class Summary

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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
javax.swing.JPanel	buttonPanel
private TopicTreeRelation[]	initialAllRelations
private java.util.Set<java.lang.String>	initialSelectedRelations
private javax.swing.JLabel	jLabel1
private javax.swing.JPanel	jPanel1
private javax.swing.JTree	jTree
private java.lang.String	name
private javax.swing.JButton	newInstanceButton
private javax.swing.JButton	newRootButton
private javax.swing.JPanel	newRootPanel
private javax.swing.JButton	newSubclassButton
private java.lang.String	rootTopic
private javax.swing.JScrollPane	scrollPane
private boolean	treeEnabled
private Wandora	wandora

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 and Description
TopicTreePanel(java.lang.String rootTopic, Wandora parent) Creates new form TopicTreePanel
TopicTreePanel(java.lang.String rootTopic, Wandora parent, java.util.Set<java.lang.String> selectedAssociations, TopicTreeRelation[] associations)
TopicTreePanel(java.lang.String rootTopic, Wandora wandora, java.util.Set<java.lang.String> selectedRelations, TopicTreeRelation[] allRelations, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	associationChanged(Association a) A notification used to report general or large changes in association.
void	associationPlayerChanged(Association a, Topic role, Topic newPlayer, Topic oldPlayer) A notification that a player in an association with a certain role has been changed.
void	associationRemoved(Association a) A notification that an association has been completely removed.
void	associationTypeChanged(Association a, Topic newType, Topic oldType) A notification that association type has changed.
void	cleanup()
void	doRefresh()
java.awt.Component	getPanel() Returns the panel used to make selection.
java.lang.String	getRootSI()
Topic	getSelectedTopic() Returns the selected topic.
Topic[]	getSelectedTopics() Returns an array of selected topics.
Topic	getSelection()
java.lang.String	getSelectorName() Gets the name of the selector.
TopicTree	getTopicTree()
void	init()
private void	initComponents() This method is called from within the constructor to initialize the form.
private void	jTreeTreeExpanded(javax.swing.event.TreeExpansionEvent evt)
boolean	needsRefresh()
private void	newInstanceButtonActionPerformed(java.awt.event.ActionEvent evt)
private void	newRootButtonActionPerformed(java.awt.event.ActionEvent evt)
private void	newSubclassButtonActionPerformed(java.awt.event.ActionEvent evt)
void	refresh()
void	setModel(java.lang.String rootSI, java.util.Set<java.lang.String> selectedRelations, TopicTreeRelation[] allRelations)
void	setTreeEnabled(boolean b)
void	topicBaseNameChanged(Topic t, java.lang.String newName, java.lang.String oldName) Notification that the base name has been changed.
void	topicChanged(Topic t) A notification used to report general or large changes in topic, for example when topics are merged.
void	topicDataChanged(Topic t, Topic type, Topic version, java.lang.String newValue, java.lang.String oldValue) Notification that topic occurrence has been changed.
void	topicRemoved(Topic t) Notification that a topic has been completely removed.
void	topicSubjectIdentifierChanged(Topic t, Locator added, Locator removed) Notification that a subject identifier has changed.
void	topicSubjectLocatorChanged(Topic t, Locator newLocator, Locator oldLocator) Notification that the subject locator has been changed.
void	topicTypeChanged(Topic t, Topic added, Topic removed) Notification that a topic type has changed.
void	topicVariantChanged(Topic t, java.util.Collection<Topic> scope, java.lang.String newName, java.lang.String oldName) Notification that a variant name has been changed.
void	updateSelectedAssociation(java.lang.String oldRelation, java.lang.String newRelation)

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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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 Detail

rootTopic

private java.lang.String rootTopic

wandora

private Wandora wandora

name

private java.lang.String name

initialSelectedRelations

private java.util.Set<java.lang.String> initialSelectedRelations

initialAllRelations

private TopicTreeRelation[] initialAllRelations

treeEnabled

private boolean treeEnabled

buttonPanel

public javax.swing.JPanel buttonPanel

jLabel1

private javax.swing.JLabel jLabel1

jPanel1

private javax.swing.JPanel jPanel1

jTree

private javax.swing.JTree jTree

newInstanceButton

private javax.swing.JButton newInstanceButton

newRootButton

private javax.swing.JButton newRootButton

newRootPanel

private javax.swing.JPanel newRootPanel

newSubclassButton

private javax.swing.JButton newSubclassButton

scrollPane

private javax.swing.JScrollPane scrollPane

Constructor Detail

TopicTreePanel

public TopicTreePanel(java.lang.String rootTopic,
                      Wandora parent)
               throws TopicMapException

Creates new form TopicTreePanel

Throws:

TopicMapException

TopicTreePanel

public TopicTreePanel(java.lang.String rootTopic,
                      Wandora parent,
                      java.util.Set<java.lang.String> selectedAssociations,
                      TopicTreeRelation[] associations)
               throws TopicMapException

Throws:

TopicMapException

TopicTreePanel

public TopicTreePanel(java.lang.String rootTopic,
                      Wandora wandora,
                      java.util.Set<java.lang.String> selectedRelations,
                      TopicTreeRelation[] allRelations,
                      java.lang.String name)
               throws TopicMapException

Parameters:

rootTopic - Subject identifier of the topic that is used as root for the tree

selectedRelations - Names of the associations in associations array that are used in this topic tree chooser.

allRelations - A list of tree association types. Not all of them are necessarily used in this topic tree chooser. selectedAssociations contains the names of the used association types.

Throws:

TopicMapException

Method Detail

setModel

public void setModel(java.lang.String rootSI,
                     java.util.Set<java.lang.String> selectedRelations,
                     TopicTreeRelation[] allRelations)
              throws TopicMapException

Parameters:

rootSI - Subject identifier of the topic that is used as root for the tree

selectedRelations - Names of the associations in associations array that are used in this topic tree chooser.

allRelations - A list of tree association types. Not all of them are necessarily used in this topic tree chooser. selectedAssociations contains the names of the used association types.

Throws:

TopicMapException

getSelectorName

public java.lang.String getSelectorName()

Description copied from interface: TopicSelector

Gets the name of the selector.

Specified by:

getSelectorName in interface TopicSelector

setTreeEnabled

public void setTreeEnabled(boolean b)

getRootSI

public java.lang.String getRootSI()

updateSelectedAssociation

public void updateSelectedAssociation(java.lang.String oldRelation,
                                      java.lang.String newRelation)

initComponents

private void initComponents()

This method is called from within the constructor to initialize the form. WARNING: Do NOT modify this code. The content of this method is always regenerated by the Form Editor.

newRootButtonActionPerformed

private void newRootButtonActionPerformed(java.awt.event.ActionEvent evt)

newSubclassButtonActionPerformed

private void newSubclassButtonActionPerformed(java.awt.event.ActionEvent evt)

newInstanceButtonActionPerformed

private void newInstanceButtonActionPerformed(java.awt.event.ActionEvent evt)

jTreeTreeExpanded

private void jTreeTreeExpanded(javax.swing.event.TreeExpansionEvent evt)

getSelection

public Topic getSelection()

needsRefresh

public boolean needsRefresh()

refresh

public void refresh()
             throws TopicMapException

Throws:

TopicMapException

getSelectedTopics

public Topic[] getSelectedTopics()

Description copied from interface: TopicSelector

Returns an array of selected topics. If no topics are selected returns an array of 0 length;

Specified by:

getSelectedTopics in interface TopicSelector

getSelectedTopic

public Topic getSelectedTopic()

Description copied from interface: TopicSelector

Returns the selected topic. If no topic is selected returns null. If multiple topics are selected, returns one of the selected topics.

Specified by:

getSelectedTopic in interface TopicSelector

init

public void init()

Specified by:

init in interface TopicSelector

cleanup

public void cleanup()

Specified by:

cleanup in interface TopicSelector

getPanel

public java.awt.Component getPanel()

Description copied from interface: TopicSelector

Returns the panel used to make selection. Usually your class should extend javax.swing.JPanel (or equivalent) and then just return this.

Specified by:

getPanel in interface TopicSelector

topicSubjectIdentifierChanged

public void topicSubjectIdentifierChanged(Topic t,
                                          Locator added,
                                          Locator removed)
                                   throws TopicMapException

Description copied from interface: TopicMapListener

Notification that a subject identifier has changed. Either added or removed is non-null and indicates that a subject identifier has been added or removed, respectively. The non-null parameter contains the new subject identifier or the removed subject identifier.

Specified by:

topicSubjectIdentifierChanged in interface TopicMapListener

Throws:

TopicMapException

topicBaseNameChanged

public void topicBaseNameChanged(Topic t,
                                 java.lang.String newName,
                                 java.lang.String oldName)
                          throws TopicMapException

Description copied from interface: TopicMapListener

Notification that the base name has been changed. Either newName or oldName may be null indicating that base name was removed or old name was empty.

Specified by:

topicBaseNameChanged in interface TopicMapListener

Throws:

TopicMapException

topicTypeChanged

public void topicTypeChanged(Topic t,
                             Topic added,
                             Topic removed)
                      throws TopicMapException

Description copied from interface: TopicMapListener

Notification that a topic type has changed. Either added or removed is non-null and indicates that a type has been added or removed, respectively. The non-null parameter contains the new type or the removed type.

Specified by:

topicTypeChanged in interface TopicMapListener

Throws:

TopicMapException

topicVariantChanged

public void topicVariantChanged(Topic t,
                                java.util.Collection<Topic> scope,
                                java.lang.String newName,
                                java.lang.String oldName)
                         throws TopicMapException

Description copied from interface: TopicMapListener

Notification that a variant name has been changed. Either newName or oldName may be null indicating that the variant name was removed or old name was empty.

Specified by:

topicVariantChanged in interface TopicMapListener

Throws:

TopicMapException

topicDataChanged

public void topicDataChanged(Topic t,
                             Topic type,
                             Topic version,
                             java.lang.String newValue,
                             java.lang.String oldValue)
                      throws TopicMapException

Description copied from interface: TopicMapListener

Notification that topic occurrence has been changed. Either newValue or oldValue may be null indicating that the occurrence was removed or old value was empty.

Specified by:

topicDataChanged in interface TopicMapListener

Throws:

TopicMapException

topicSubjectLocatorChanged

public void topicSubjectLocatorChanged(Topic t,
                                       Locator newLocator,
                                       Locator oldLocator)
                                throws TopicMapException

Description copied from interface: TopicMapListener

Notification that the subject locator has been changed. Either newLocator or oldLocator may be null indicating that locator was removed or there was no old locator.

Specified by:

topicSubjectLocatorChanged in interface TopicMapListener

Throws:

TopicMapException

topicRemoved

public void topicRemoved(Topic t)
                  throws TopicMapException

Description copied from interface: TopicMapListener

Notification that a topic has been completely removed.

Specified by:

topicRemoved in interface TopicMapListener

Throws:

TopicMapException

topicChanged

public void topicChanged(Topic t)
                  throws TopicMapException

Description copied from interface: TopicMapListener

A notification used to report general or large changes in topic, for example when topics are merged. Such a large change may consist of any number of smaller changes that are NOT reported individually with the other listener methods. This method is used when tracking individual changes is hard to implement.

Specified by:

topicChanged in interface TopicMapListener

Throws:

TopicMapException

associationTypeChanged

public void associationTypeChanged(Association a,
                                   Topic newType,
                                   Topic oldType)
                            throws TopicMapException

Description copied from interface: TopicMapListener

A notification that association type has changed. Either newType or oldType can be null to indicate that old or new type was null. When type is changed from one topic to another, both will be non-null.

Specified by:

associationTypeChanged in interface TopicMapListener

Throws:

TopicMapException

associationPlayerChanged

public void associationPlayerChanged(Association a,
                                     Topic role,
                                     Topic newPlayer,
                                     Topic oldPlayer)
                              throws TopicMapException

Description copied from interface: TopicMapListener

A notification that a player in an association with a certain role has been changed. Either newPlayer or oldPlayer can be null to indicate that the no new player for the role was set or that there was no player with the role previously. Both can also be non-null to indicate that the player of the role changed.

Specified by:

associationPlayerChanged in interface TopicMapListener

Throws:

TopicMapException

associationRemoved

public void associationRemoved(Association a)
                        throws TopicMapException

Description copied from interface: TopicMapListener

A notification that an association has been completely removed.

Specified by:

associationRemoved in interface TopicMapListener

Throws:

TopicMapException

associationChanged

public void associationChanged(Association a)
                        throws TopicMapException

Description copied from interface: TopicMapListener

A notification used to report general or large changes in association. Such a large change may consist of any number of smaller changes that are NOT reported individually with the other listener methods. This method is used when tracking individual changes is hard to implement.

Specified by:

associationChanged in interface TopicMapListener

Throws:

TopicMapException

doRefresh

public void doRefresh()
               throws TopicMapException

Specified by:

doRefresh in interface RefreshListener

Throws:

TopicMapException

getTopicTree

public TopicTree getTopicTree()