Package com.inductiveautomation.snap.swing

Class PopupList<T>

  • All Implemented Interfaces:
    java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.MenuElement
    public class PopupList<T>
extends javax.swing.JPopupMenu
implements java.awt.event.KeyListener, java.awt.event.MouseListener
    A popup window that has a JList instead of menu items.
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      class  PopupList.PopupListCellRenderer
      A ListCellRenderer for PopupList.

      • 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 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 Description
      PopupList​(javax.swing.JComponent aComponent)
      Creates a new popup list.
      PopupList​(javax.swing.JComponent aComponent, T[] theItems)
      Creates a new popup list with given items.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected javax.swing.JList createJList()
      Creates the JList.
      protected void fireAction​(java.awt.event.InputEvent anEvent)
      Called when user hits return or double-clicks.
      protected javax.swing.Icon getItemIcon​(T anItem)
      Returns the icon to use list item.
      protected java.lang.String getItemText​(T anItem)
      Returns the text to use for list item.
      javax.swing.JList getJList()
      Returns the JList.
      T getSelectedItem()
      Returns the currently selected JList item.
      protected void initJList​(javax.swing.JList aList)
      Initializes the JList.
      void keyPressed​(java.awt.event.KeyEvent e)
      KeyListener Method to consume Arrow Up/Down, Enter and Escape.
      void keyReleased​(java.awt.event.KeyEvent e)
      KeyListener Method to consume Arrow Up/Down, Enter and Escape.
      void keyTyped​(java.awt.event.KeyEvent e)
      KeyListener Method to consume Arrow Up/Down, Enter and Escape.
      void mouseClicked​(java.awt.event.MouseEvent e)  
      void mouseEntered​(java.awt.event.MouseEvent e)  
      void mouseExited​(java.awt.event.MouseEvent e)  
      void mousePressed​(java.awt.event.MouseEvent e)
      MouseListener methods.
      void mouseReleased​(java.awt.event.MouseEvent e)  
      void selectDown()
      Select down.
      void selectUp()
      Select up.
      void setItems​(T[] theItems)
      Sets items.
      void setPreferredSize​(java.awt.Dimension aSize)
      Override to store requested preferred size.
      void setVisible​(boolean b)
      Override to add/remove Component KeyListener.
      void show​(java.awt.Component invoker, int x, int y)
      Override to resize PopupMenu window if it won't fit on screen.

      • 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, 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setMixingCutoutShape, 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

    • Constructor Detail

      • PopupList

        public PopupList​(javax.swing.JComponent aComponent)
        Creates a new popup list.

      • PopupList

        public PopupList​(javax.swing.JComponent aComponent,
                 T[] theItems)
        Creates a new popup list with given items.

    • Method Detail

      • getJList

        public javax.swing.JList getJList()
        Returns the JList.

      • createJList

        protected javax.swing.JList createJList()
        Creates the JList.

      • initJList

        protected void initJList​(javax.swing.JList aList)
        Initializes the JList.

      • setItems

        public void setItems​(T[] theItems)
        Sets items.

      • getSelectedItem

        public T getSelectedItem()
        Returns the currently selected JList item.

      • selectUp

        public void selectUp()
        Select up.

      • selectDown

        public void selectDown()
        Select down.

      • getItemText

        protected java.lang.String getItemText​(T anItem)
        Returns the text to use for list item.

      • getItemIcon

        protected javax.swing.Icon getItemIcon​(T anItem)
        Returns the icon to use list item.

      • fireAction

        protected void fireAction​(java.awt.event.InputEvent anEvent)
        Called when user hits return or double-clicks.

      • setPreferredSize

        public void setPreferredSize​(java.awt.Dimension aSize)
        Override to store requested preferred size.
        Overrides:
        setPreferredSize in class javax.swing.JComponent

      • show

        public void show​(java.awt.Component invoker,
                 int x,
                 int y)
        Override to resize PopupMenu window if it won't fit on screen.
        Overrides:
        show in class javax.swing.JPopupMenu

      • setVisible

        public void setVisible​(boolean b)
        Override to add/remove Component KeyListener.
        Overrides:
        setVisible in class javax.swing.JPopupMenu

      • keyTyped

        public void keyTyped​(java.awt.event.KeyEvent e)
        KeyListener Method to consume Arrow Up/Down, Enter and Escape.
        Specified by:
        keyTyped in interface java.awt.event.KeyListener

      • keyPressed

        public void keyPressed​(java.awt.event.KeyEvent e)
        KeyListener Method to consume Arrow Up/Down, Enter and Escape.
        Specified by:
        keyPressed in interface java.awt.event.KeyListener

      • keyReleased

        public void keyReleased​(java.awt.event.KeyEvent e)
        KeyListener Method to consume Arrow Up/Down, Enter and Escape.
        Specified by:
        keyReleased in interface java.awt.event.KeyListener

      • mousePressed

        public void mousePressed​(java.awt.event.MouseEvent e)
        MouseListener methods.
        Specified by:
        mousePressed in interface java.awt.event.MouseListener

      • mouseReleased

        public void mouseReleased​(java.awt.event.MouseEvent e)
        Specified by:
        mouseReleased in interface java.awt.event.MouseListener

      • mouseEntered

        public void mouseEntered​(java.awt.event.MouseEvent e)
        Specified by:
        mouseEntered in interface java.awt.event.MouseListener

      • mouseExited

        public void mouseExited​(java.awt.event.MouseEvent e)
        Specified by:
        mouseExited in interface java.awt.event.MouseListener

      • mouseClicked

        public void mouseClicked​(java.awt.event.MouseEvent e)
        Specified by:
        mouseClicked in interface java.awt.event.MouseListener