Package org.openstreetmap.josm.gui

Class MenuScroller

java.lang.Object

org.openstreetmap.josm.gui.MenuScroller

public class MenuScroller
extends java.lang.Object

A class that provides scrolling capabilities to a long menu dropdown or popup menu. A number of items can optionally be frozen at the top of the menu.

Implementation note: The default scrolling interval is 150 milliseconds.

Since:

4593

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	MenuScroller.MenuIcon
private class	MenuScroller.MenuScrollItem
private class	MenuScroller.MenuScrollListener
private class	MenuScroller.MenuScrollTimer
private class	MenuScroller.MouseScrollListener

Field Summary

Fields

Modifier and Type	Field	Description
private static int	ARROW_ICON_HEIGHT
private MenuScroller.MenuScrollItem	downItem
private int	firstIndex
private javax.swing.JPopupMenu	menu
private java.awt.Component[]	menuItems
private MenuScroller.MenuScrollListener	menuListener
private java.awt.event.MouseWheelListener	mouseWheelListener
private int	topFixedCount
private MenuScroller.MenuScrollItem	upItem

Constructor Summary

Constructors

Constructor	Description
MenuScroller(javax.swing.JMenu menu)	Constructs a MenuScroller that scrolls a menu with the default scrolling interval.
MenuScroller(javax.swing.JMenu menu, int interval)	Constructs a MenuScroller that scrolls a menu with the specified scrolling interval.
MenuScroller(javax.swing.JMenu menu, int interval, int topFixedCount)	Constructs a MenuScroller that scrolls a menu with the specified scrolling interval, and the specified numbers of items fixed at the top of the menu.
MenuScroller(javax.swing.JPopupMenu menu)	Constructs a MenuScroller that scrolls a popup menu with the default scrolling interval.
MenuScroller(javax.swing.JPopupMenu menu, int interval)	Constructs a MenuScroller that scrolls a popup menu with the specified scrolling interval.
MenuScroller(javax.swing.JPopupMenu menu, int interval, int topFixedCount)	Constructs a MenuScroller that scrolls a popup menu with the specified scrolling interval, and the specified numbers of items fixed at the top of the popup menu.

Method Summary

Modifier and Type	Method	Description
private int	computeScrollCount(int startIndex)
void	dispose()	Removes this MenuScroller from the associated menu and restores the default behavior of the menu.
int	getTopFixedCount()	Returns the number of items fixed at the top of the menu or popup menu.
private void	refreshMenu()
static MenuScroller	setScrollerFor(javax.swing.JMenu menu)	Registers a menu to be scrolled with the default scrolling interval.
static MenuScroller	setScrollerFor(javax.swing.JMenu menu, int interval)	Registers a menu to be scrolled, with the specified scrolling interval.
static MenuScroller	setScrollerFor(javax.swing.JMenu menu, int interval, int topFixedCount)	Registers a menu to be scrolled, with the specified scrolling interval, and the specified numbers of items fixed at the top of the menu.
static MenuScroller	setScrollerFor(javax.swing.JPopupMenu menu)	Registers a popup menu to be scrolled with the default scrolling interval.
static MenuScroller	setScrollerFor(javax.swing.JPopupMenu menu, int interval)	Registers a popup menu to be scrolled, with the specified scrolling interval.
static MenuScroller	setScrollerFor(javax.swing.JPopupMenu menu, int interval, int topFixedCount)	Registers a popup menu to be scrolled, with the specified scrolling interval, and the specified numbers of items fixed at the top of the popup menu.
void	setTopFixedCount(int topFixedCount)	Sets the number of items to fix at the top of the menu or popup menu.

Methods inherited from class java.lang.Object

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

Field Detail

menu

private javax.swing.JPopupMenu menu

menuItems

private java.awt.Component[] menuItems

upItem

private final MenuScroller.MenuScrollItem upItem

downItem

private final MenuScroller.MenuScrollItem downItem

menuListener

private final MenuScroller.MenuScrollListener menuListener

mouseWheelListener

private final java.awt.event.MouseWheelListener mouseWheelListener

topFixedCount

private int topFixedCount

firstIndex

private int firstIndex

ARROW_ICON_HEIGHT

private static final int ARROW_ICON_HEIGHT

See Also:

Constant Field Values

Constructor Detail

MenuScroller

public MenuScroller(javax.swing.JMenu menu)

Constructs a MenuScroller that scrolls a menu with the default scrolling interval.

Parameters:

menu - the menu

Throws:

java.lang.IllegalArgumentException - if scrollCount is 0 or negative

MenuScroller

public MenuScroller(javax.swing.JPopupMenu menu)

Constructs a MenuScroller that scrolls a popup menu with the default scrolling interval.

Parameters:

menu - the popup menu

Throws:

java.lang.IllegalArgumentException - if scrollCount is 0 or negative

MenuScroller

public MenuScroller(javax.swing.JMenu menu,
                    int interval)

Constructs a MenuScroller that scrolls a menu with the specified scrolling interval.

Parameters:

menu - the menu

interval - the scroll interval, in milliseconds

Throws:

java.lang.IllegalArgumentException - if scrollCount or interval is 0 or negative

Since:

7463

MenuScroller

public MenuScroller(javax.swing.JPopupMenu menu,
                    int interval)

Constructs a MenuScroller that scrolls a popup menu with the specified scrolling interval.

Parameters:

menu - the popup menu

interval - the scroll interval, in milliseconds

Throws:

java.lang.IllegalArgumentException - if scrollCount or interval is 0 or negative

Since:

7463

MenuScroller

public MenuScroller(javax.swing.JMenu menu,
                    int interval,
                    int topFixedCount)

Constructs a MenuScroller that scrolls a menu with the specified scrolling interval, and the specified numbers of items fixed at the top of the menu.

Parameters:

menu - the menu

interval - the scroll interval, in milliseconds

topFixedCount - the number of items to fix at the top. May be 0

Throws:

java.lang.IllegalArgumentException - if scrollCount or interval is 0 or negative or if topFixedCount is negative

Since:

7463

MenuScroller

public MenuScroller(javax.swing.JPopupMenu menu,
                    int interval,
                    int topFixedCount)

Constructs a MenuScroller that scrolls a popup menu with the specified scrolling interval, and the specified numbers of items fixed at the top of the popup menu.

Parameters:

menu - the popup menu

interval - the scroll interval, in milliseconds

topFixedCount - the number of items to fix at the top. May be 0

Throws:

java.lang.IllegalArgumentException - if scrollCount or interval is 0 or negative or if topFixedCount is negative

Since:

7463

Method Detail

computeScrollCount

private int computeScrollCount(int startIndex)

setScrollerFor

public static MenuScroller setScrollerFor(javax.swing.JMenu menu)

Registers a menu to be scrolled with the default scrolling interval.

Parameters:

menu - the menu

Returns:

the MenuScroller

setScrollerFor

public static MenuScroller setScrollerFor(javax.swing.JPopupMenu menu)

Registers a popup menu to be scrolled with the default scrolling interval.

Parameters:

menu - the popup menu

Returns:

the MenuScroller

setScrollerFor

public static MenuScroller setScrollerFor(javax.swing.JMenu menu,
                                          int interval)

Registers a menu to be scrolled, with the specified scrolling interval.

Parameters:

menu - the menu

interval - the scroll interval, in milliseconds

Returns:

the MenuScroller

Throws:

java.lang.IllegalArgumentException - if scrollCount or interval is 0 or negative

Since:

7463

setScrollerFor

public static MenuScroller setScrollerFor(javax.swing.JPopupMenu menu,
                                          int interval)

Registers a popup menu to be scrolled, with the specified scrolling interval.

Parameters:

menu - the popup menu

interval - the scroll interval, in milliseconds

Returns:

the MenuScroller

Throws:

java.lang.IllegalArgumentException - if scrollCount or interval is 0 or negative

Since:

7463

setScrollerFor

public static MenuScroller setScrollerFor(javax.swing.JMenu menu,
                                          int interval,
                                          int topFixedCount)

Registers a menu to be scrolled, with the specified scrolling interval, and the specified numbers of items fixed at the top of the menu.

Parameters:

menu - the menu

interval - the scroll interval, in milliseconds

topFixedCount - the number of items to fix at the top. May be 0.

Returns:

the MenuScroller

Throws:

java.lang.IllegalArgumentException - if scrollCount or interval is 0 or negative or if topFixedCount is negative

Since:

7463

setScrollerFor

public static MenuScroller setScrollerFor(javax.swing.JPopupMenu menu,
                                          int interval,
                                          int topFixedCount)

Registers a popup menu to be scrolled, with the specified scrolling interval, and the specified numbers of items fixed at the top of the popup menu.

Parameters:

menu - the popup menu

interval - the scroll interval, in milliseconds

topFixedCount - the number of items to fix at the top. May be 0

Returns:

the MenuScroller

Throws:

java.lang.IllegalArgumentException - if scrollCount or interval is 0 or negative or if topFixedCount is negative

Since:

7463

getTopFixedCount

public int getTopFixedCount()

Returns the number of items fixed at the top of the menu or popup menu.

Returns:

the number of items

setTopFixedCount

public void setTopFixedCount(int topFixedCount)

Sets the number of items to fix at the top of the menu or popup menu.

Parameters:

topFixedCount - the number of items

dispose

public void dispose()

Removes this MenuScroller from the associated menu and restores the default behavior of the menu.

refreshMenu

private void refreshMenu()