com.jidesoft.swing.JidePopupMenu

All Implemented Interfaces:: ImageObserver, MenuContainer, Serializable, Accessible, MenuElement, Scrollable

public class JidePopupMenu extends JPopupMenu implements Scrollable

This component extends JPopupMenu and adds a method to display the menu inside the screen even if the mouse pointer is near the edge of the screen.

It also puts the menu items into a scroll pane. When there are too many menu items that can't fit into one screen, the scroll pane will scroll up and down so that you can still get to all menu items.

See Also:

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPopupMenu
JPopupMenu.AccessibleJPopupMenu, JPopupMenu.Separator

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

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

Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, 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

JidePopupMenu()

Constructs a JPopupMenu without an "invoker".

JidePopupMenu(String label)

Constructs a JPopupMenu with the specified title.
Method Summary

Modifier and Type

Method

Description

protected Point

getPopupMenuOrigin(Component invoker, int x, int y)

Figures out the sizes needed to calculate the menu position.

Dimension

getPreferredScrollableViewportSize()

int

getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)

boolean

getScrollableTracksViewportHeight()

boolean

getScrollableTracksViewportWidth()

int

getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)

String

getUIClassID()

int

getVisibleMenuItemCount()

Gets the maximum visible menu item count.

void

setLocation(int x, int y)

void

setVisibleMenuItemCount(int visibleMenuItemCount)

Sets the visible menu item count.

void

show(Component invoker, int x, int y)

Displays the PopUpMenu at a specified position.

void

updateUI()

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, insert, insert, isBorderPainted, isLightWeightPopupEnabled, isPopupTrigger, isVisible, menuSelectionChanged, pack, paintBorder, paramString, processFocusEvent, processKeyEvent, processKeyEvent, processMouseEvent, remove, removeMenuKeyListener, removePopupMenuListener, setBorderPainted, setDefaultLightWeightPopupEnabled, setInvoker, setLabel, setLightWeightPopupEnabled, setPopupSize, setPopupSize, setSelected, setSelectionModel, setUI, setVisible

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, 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 Details
- JidePopupMenu
  
  public JidePopupMenu()
  
  Constructs a JPopupMenu without an "invoker".
- JidePopupMenu
  
  public JidePopupMenu(String label)
  
  Constructs a JPopupMenu with the specified title.
  
  Parameters:
  
  label - the string that a UI may use to display as a title for the popup menu.
Method Details
- getUIClassID
  
  public String getUIClassID()
  
  Overrides:
  
  getUIClassID in class JPopupMenu
- updateUI
  
  public void updateUI()
  
  Overrides:
  
  updateUI in class JPopupMenu
- show
  
  public void show(Component invoker, int x, int y)
  
  Displays the PopUpMenu at a specified position.
  
  Overrides:
  
  show in class JPopupMenu
  
  Parameters:
  
  invoker - the component that triggers the event
  
  x - mouse X position on screen
  
  y - mouse Y position on screen
- getPopupMenuOrigin
  
  protected Point getPopupMenuOrigin(Component invoker, int x, int y)
  
  Figures out the sizes needed to calculate the menu position.
  
  Parameters:
  
  invoker - the component that triggers the event
  
  x - mouse X position on screen
  
  y - mouse Y position on screen
  
  Returns:
  
  new position
- setLocation
  
  public void setLocation(int x, int y)
  
  Overrides:
  
  setLocation in class JPopupMenu
- getPreferredScrollableViewportSize
  
  public Dimension getPreferredScrollableViewportSize()
  
  Specified by:
  
  getPreferredScrollableViewportSize in interface Scrollable
- getScrollableUnitIncrement
  
  public int getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)
  
  Specified by:
  
  getScrollableUnitIncrement in interface Scrollable
- getScrollableBlockIncrement
  
  public int getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)
  
  Specified by:
  
  getScrollableBlockIncrement in interface Scrollable
- getScrollableTracksViewportWidth
  
  public boolean getScrollableTracksViewportWidth()
  
  Specified by:
  
  getScrollableTracksViewportWidth in interface Scrollable
- getScrollableTracksViewportHeight
  
  public boolean getScrollableTracksViewportHeight()
  
  Specified by:
  
  getScrollableTracksViewportHeight in interface Scrollable
- getVisibleMenuItemCount
  
  public int getVisibleMenuItemCount()
  
  Gets the maximum visible menu item count.
  
  Returns:
  
  the maximum visible menu item count.
  
  Since:
  
  3.6.2
- setVisibleMenuItemCount
  
  public void setVisibleMenuItemCount(int visibleMenuItemCount)
  
  Sets the visible menu item count. It will control the popup menu height along with the screen size, whichever is smaller.
  
  Parameters:
  
  visibleMenuItemCount - the maximum menu item count to be shown. -1 means no limit.
  
  Since:
  
  3.6.2

Class JidePopupMenu

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPopupMenu

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Constructor Details

JidePopupMenu

JidePopupMenu

Method Details

getUIClassID

updateUI

show

getPopupMenuOrigin

setLocation

getPreferredScrollableViewportSize

getScrollableUnitIncrement

getScrollableBlockIncrement

getScrollableTracksViewportWidth

getScrollableTracksViewportHeight

getVisibleMenuItemCount

setVisibleMenuItemCount