de.lmu.ifi.dbs.elki.gui.util

Class TreePopup

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPopupMenu

de.lmu.ifi.dbs.elki.gui.util.TreePopup

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.MenuElement

public class TreePopup
extends javax.swing.JPopupMenu

Popup menu that contains a JTree.

Since:

0.7.0

Author:

Erich Schubert

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TreePopup.Handler Event handler class.
class	TreePopup.Renderer Tree cell render.

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

javax.swing.JPopupMenu.AccessibleJPopupMenu, javax.swing.JPopupMenu.Separator

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
static java.lang.String	ACTION_CANCELED Action string for canceled operations (escape button pressed).
static java.lang.String	ACTION_SELECTED Action string for confirmed operations (enter or click).
private TreePopup.Handler	handler Event handler
private javax.swing.tree.TreeModel	model Tree model.
protected javax.swing.JScrollPane	scroller Scroll pane, containing the tree.
private static long	serialVersionUID Serialization version.
protected javax.swing.JTree	tree Tree.
private static javax.swing.border.Border	TREE_BORDER Border of the popup.

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
TreePopup() Constructor with an empty tree model.
TreePopup(javax.swing.tree.TreeModel model) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addActionListener(java.awt.event.ActionListener listener) Register an action listener.
protected java.awt.Rectangle	computePopupBounds(java.awt.Component parent, int px, int py, int pw, int ph)
protected void	configurePopup() Configure the popup display.
protected javax.swing.JScrollPane	createScroller() Creates the scroll pane which houses the scrollable tree.
protected javax.swing.JTree	createTree() Creates the JList used in the popup to display the items in the combo box model.
protected void	fireActionPerformed(java.awt.event.ActionEvent event) Notify action listeners.
javax.swing.JTree	getTree() Access the tree contained.
void	removeActionListener(java.awt.event.ActionListener listener) Unregister an action listener.
void	show(java.awt.Component parent) Display the popup, attached to the given component.

Methods inherited from class javax.swing.JPopupMenu

add, add, add, addMenuKeyListener, addPopupMenuListener, addSeparator, createActionChangeListener, createActionComponent, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getComponent, getComponentAtIndex, getComponentIndex, getDefaultLightWeightPopupEnabled, getInvoker, getLabel, getMargin, getMenuKeyListeners, getPopupMenuListeners, getSelectionModel, getSubElements, getUI, getUIClassID, insert, insert, isBorderPainted, isLightWeightPopupEnabled, isPopupTrigger, isVisible, menuSelectionChanged, pack, paintBorder, paramString, processFocusEvent, processKeyEvent, processKeyEvent, processMouseEvent, remove, removeMenuKeyListener, removePopupMenuListener, setBorderPainted, setDefaultLightWeightPopupEnabled, setInvoker, setLabel, setLightWeightPopupEnabled, setLocation, setPopupSize, setPopupSize, setSelected, setSelectionModel, setUI, setVisible, show, 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, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, 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, 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, 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, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, 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, 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

serialVersionUID

private static final long serialVersionUID

Serialization version.

See Also:

Constant Field Values

ACTION_SELECTED

public static final java.lang.String ACTION_SELECTED

Action string for confirmed operations (enter or click).

See Also:

Constant Field Values

ACTION_CANCELED

public static final java.lang.String ACTION_CANCELED

Action string for canceled operations (escape button pressed).

See Also:

Constant Field Values

tree

protected javax.swing.JTree tree

Tree.

scroller

protected javax.swing.JScrollPane scroller

Scroll pane, containing the tree.

model

private javax.swing.tree.TreeModel model

Tree model.

handler

private TreePopup.Handler handler

Event handler

TREE_BORDER

private static javax.swing.border.Border TREE_BORDER

Border of the popup.

Constructor Detail

TreePopup

public TreePopup()

Constructor with an empty tree model. This needs to also add a root node, and therefore sets getTree().setRootVisible(false).

TreePopup

public TreePopup(javax.swing.tree.TreeModel model)

Constructor.

Parameters:

model - Tree model

Method Detail

createTree

protected javax.swing.JTree createTree()

Creates the JList used in the popup to display the items in the combo box model. This method is called when the UI class is created.

Returns:

a JList used to display the combo box items

configurePopup

protected void configurePopup()

Configure the popup display.

createScroller

protected javax.swing.JScrollPane createScroller()

Creates the scroll pane which houses the scrollable tree.

getTree

public javax.swing.JTree getTree()

Access the tree contained.

Returns:

Tree

show

public void show(java.awt.Component parent)

Display the popup, attached to the given component.

Parameters:

parent - Parent component

computePopupBounds

protected java.awt.Rectangle computePopupBounds(java.awt.Component parent,
                                                int px,
                                                int py,
                                                int pw,
                                                int ph)

addActionListener

public void addActionListener(java.awt.event.ActionListener listener)

Register an action listener.

Parameters:

listener - Action listener

removeActionListener

public void removeActionListener(java.awt.event.ActionListener listener)

Unregister an action listener.

Parameters:

listener - Action listener

fireActionPerformed

protected void fireActionPerformed(java.awt.event.ActionEvent event)

Notify action listeners.

Parameters:

event - the ActionEvent object