Package VASSAL.tools.menu

Class MenuScroller

java.lang.Object

VASSAL.tools.menu.MenuScroller

public class MenuScroller
extends 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 and/or bottom of the menu.

Implementation note: The default number of items to display at a time is 15, and the default scrolling interval is 125 milliseconds.

Version:

1.5.0 04/05/12

Author:

Darryl

Constructor Summary

Constructors

Constructor	Description
MenuScroller(JMenu menu)	Constructs a MenuScroller that scrolls a menu with the default number of items to display at a time, and default scrolling interval.
MenuScroller(JMenu menu, int scrollCount)	Constructs a MenuScroller that scrolls a menu with the specified number of items to display at a time, and default scrolling interval.
MenuScroller(JMenu menu, int scrollCount, int interval)	Constructs a MenuScroller that scrolls a menu with the specified number of items to display at a time, and specified scrolling interval.
MenuScroller(JMenu menu, int scrollCount, int interval, int topFixedCount, int bottomFixedCount)	Constructs a MenuScroller that scrolls a menu with the specified number of items to display in the scrolling region, the specified scrolling interval, and the specified numbers of items fixed at the top and bottom of the menu.
MenuScroller(JPopupMenu menu)	Constructs a MenuScroller that scrolls a popup menu with the default number of items to display at a time, and default scrolling interval.
MenuScroller(JPopupMenu menu, int scrollCount)	Constructs a MenuScroller that scrolls a popup menu with the specified number of items to display at a time, and default scrolling interval.
MenuScroller(JPopupMenu menu, int scrollCount, int interval)	Constructs a MenuScroller that scrolls a popup menu with the specified number of items to display at a time, and specified scrolling interval.
MenuScroller(JPopupMenu menu, int scrollCount, int interval, int topFixedCount, int bottomFixedCount)	Constructs a MenuScroller that scrolls a popup menu with the specified number of items to display in the scrolling region, the specified scrolling interval, and the specified numbers of items fixed at the top and bottom of the popup menu.

Method Summary

Modifier and Type	Method	Description
int	getBottomFixedCount()	Returns the number of items fixed at the bottom of the menu or popup menu.
int	getInterval()	Returns the scroll interval in milliseconds
int	getscrollCount()	Returns the number of items in the scrolling portion of the menu.
int	getTopFixedCount()	Returns the number of items fixed at the top of the menu or popup menu.
void	keepVisible(int index)	Scrolls the item at the specified index into view each time the menu is opened.
void	keepVisible(JMenuItem item)	Scrolls the specified item into view each time the menu is opened.
void	setBottomFixedCount(int bottomFixedCount)	Sets the number of items to fix at the bottom of the menu or popup menu.
void	setInterval(int interval)	Sets the scroll interval in milliseconds
void	setScrollCount(int scrollCount)	Sets the number of items in the scrolling portion of the menu.
static MenuScroller	setScrollerFor(JMenu menu)	Registers a menu to be scrolled with the default number of items to display at a time and the default scrolling interval.
static MenuScroller	setScrollerFor(JMenu menu, int scrollCount)	Registers a menu to be scrolled with the default number of items to display at a time and the specified scrolling interval.
static MenuScroller	setScrollerFor(JMenu menu, int scrollCount, int interval)	Registers a menu to be scrolled, with the specified number of items to display at a time and the specified scrolling interval.
static MenuScroller	setScrollerFor(JMenu menu, int scrollCount, int interval, int topFixedCount, int bottomFixedCount)	Registers a menu to be scrolled, with the specified number of items to display in the scrolling region, the specified scrolling interval, and the specified numbers of items fixed at the top and bottom of the menu.
static MenuScroller	setScrollerFor(JPopupMenu menu)	Registers a popup menu to be scrolled with the default number of items to display at a time and the default scrolling interval.
static MenuScroller	setScrollerFor(JPopupMenu menu, int scrollCount)	Registers a popup menu to be scrolled with the default number of items to display at a time and the specified scrolling interval.
static MenuScroller	setScrollerFor(JPopupMenu menu, int scrollCount, int interval)	Registers a popup menu to be scrolled, with the specified number of items to display at a time and the specified scrolling interval.
static MenuScroller	setScrollerFor(JPopupMenu menu, int scrollCount, int interval, int topFixedCount, int bottomFixedCount)	Registers a popup menu to be scrolled, with the specified number of items to display in the scrolling region, the specified scrolling interval, and the specified numbers of items fixed at the top and bottom 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

Constructor Details

MenuScroller

public MenuScroller(JMenu menu)

Constructs a MenuScroller that scrolls a menu with the default number of items to display at a time, and default scrolling interval.

Parameters:

menu - the menu

MenuScroller

public MenuScroller(JPopupMenu menu)

Constructs a MenuScroller that scrolls a popup menu with the default number of items to display at a time, and default scrolling interval.

Parameters:

menu - the popup menu

MenuScroller

public MenuScroller(JMenu menu,
 int scrollCount)

Constructs a MenuScroller that scrolls a menu with the specified number of items to display at a time, and default scrolling interval.

Parameters:

menu - the menu

scrollCount - the number of items to display at a time

Throws:

IllegalArgumentException - if scrollCount is 0 or negative

MenuScroller

public MenuScroller(JPopupMenu menu,
 int scrollCount)

Constructs a MenuScroller that scrolls a popup menu with the specified number of items to display at a time, and default scrolling interval.

Parameters:

menu - the popup menu

scrollCount - the number of items to display at a time

Throws:

IllegalArgumentException - if scrollCount is 0 or negative

MenuScroller

public MenuScroller(JMenu menu,
 int scrollCount,
 int interval)

Constructs a MenuScroller that scrolls a menu with the specified number of items to display at a time, and specified scrolling interval.

Parameters:

menu - the menu

scrollCount - the number of items to display at a time

interval - the scroll interval, in milliseconds

Throws:

IllegalArgumentException - if scrollCount or interval is 0 or negative

MenuScroller

public MenuScroller(JPopupMenu menu,
 int scrollCount,
 int interval)

Constructs a MenuScroller that scrolls a popup menu with the specified number of items to display at a time, and specified scrolling interval.

Parameters:

menu - the popup menu

scrollCount - the number of items to display at a time

interval - the scroll interval, in milliseconds

Throws:

IllegalArgumentException - if scrollCount or interval is 0 or negative

MenuScroller

public MenuScroller(JMenu menu,
 int scrollCount,
 int interval,
 int topFixedCount,
 int bottomFixedCount)

Constructs a MenuScroller that scrolls a menu with the specified number of items to display in the scrolling region, the specified scrolling interval, and the specified numbers of items fixed at the top and bottom of the menu.

Parameters:

menu - the menu

scrollCount - the number of items to display in the scrolling portion

interval - the scroll interval, in milliseconds

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

bottomFixedCount - the number of items to fix at the bottom. May be 0

Throws:

IllegalArgumentException - if scrollCount or interval is 0 or negative or if topFixedCount or bottomFixedCount is negative

MenuScroller

public MenuScroller(JPopupMenu menu,
 int scrollCount,
 int interval,
 int topFixedCount,
 int bottomFixedCount)

Constructs a MenuScroller that scrolls a popup menu with the specified number of items to display in the scrolling region, the specified scrolling interval, and the specified numbers of items fixed at the top and bottom of the popup menu.

Parameters:

menu - the popup menu

scrollCount - the number of items to display in the scrolling portion

interval - the scroll interval, in milliseconds

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

bottomFixedCount - the number of items to fix at the bottom. May be 0

Throws:

IllegalArgumentException - if scrollCount or interval is 0 or negative or if topFixedCount or bottomFixedCount is negative

Method Details

setScrollerFor

public static MenuScroller setScrollerFor(JMenu menu)

Registers a menu to be scrolled with the default number of items to display at a time and the default scrolling interval.

Parameters:

menu - the menu

Returns:

the MenuScroller

setScrollerFor

public static MenuScroller setScrollerFor(JPopupMenu menu)

Registers a popup menu to be scrolled with the default number of items to display at a time and the default scrolling interval.

Parameters:

menu - the popup menu

Returns:

the MenuScroller

setScrollerFor

public static MenuScroller setScrollerFor(JMenu menu,
 int scrollCount)

Registers a menu to be scrolled with the default number of items to display at a time and the specified scrolling interval.

Parameters:

menu - the menu

scrollCount - the number of items to display at a time

Returns:

the MenuScroller

Throws:

IllegalArgumentException - if scrollCount is 0 or negative

setScrollerFor

public static MenuScroller setScrollerFor(JPopupMenu menu,
 int scrollCount)

Registers a popup menu to be scrolled with the default number of items to display at a time and the specified scrolling interval.

Parameters:

menu - the popup menu

scrollCount - the number of items to display at a time

Returns:

the MenuScroller

Throws:

IllegalArgumentException - if scrollCount is 0 or negative

setScrollerFor

public static MenuScroller setScrollerFor(JMenu menu,
 int scrollCount,
 int interval)

Registers a menu to be scrolled, with the specified number of items to display at a time and the specified scrolling interval.

Parameters:

menu - the menu

scrollCount - the number of items to be displayed at a time

interval - the scroll interval, in milliseconds

Returns:

the MenuScroller

Throws:

IllegalArgumentException - if scrollCount or interval is 0 or negative

setScrollerFor

public static MenuScroller setScrollerFor(JPopupMenu menu,
 int scrollCount,
 int interval)

Registers a popup menu to be scrolled, with the specified number of items to display at a time and the specified scrolling interval.

Parameters:

menu - the popup menu

scrollCount - the number of items to be displayed at a time

interval - the scroll interval, in milliseconds

Returns:

the MenuScroller

Throws:

IllegalArgumentException - if scrollCount or interval is 0 or negative

setScrollerFor

public static MenuScroller setScrollerFor(JMenu menu,
 int scrollCount,
 int interval,
 int topFixedCount,
 int bottomFixedCount)

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

Parameters:

menu - the menu

scrollCount - the number of items to display in the scrolling portion

interval - the scroll interval, in milliseconds

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

bottomFixedCount - the number of items to fix at the bottom. May be 0

Returns:

the MenuScroller

Throws:

IllegalArgumentException - if scrollCount or interval is 0 or negative or if topFixedCount or bottomFixedCount is negative

setScrollerFor

public static MenuScroller setScrollerFor(JPopupMenu menu,
 int scrollCount,
 int interval,
 int topFixedCount,
 int bottomFixedCount)

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

Parameters:

menu - the popup menu

scrollCount - the number of items to display in the scrolling portion

interval - the scroll interval, in milliseconds

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

bottomFixedCount - the number of items to fix at the bottom. May be 0

Returns:

the MenuScroller

Throws:

IllegalArgumentException - if scrollCount or interval is 0 or negative or if topFixedCount or bottomFixedCount is negative

getInterval

public int getInterval()

Returns the scroll interval in milliseconds

Returns:

the scroll interval in milliseconds

setInterval

public void setInterval(int interval)

Sets the scroll interval in milliseconds

Parameters:

interval - the scroll interval in milliseconds

Throws:

IllegalArgumentException - if interval is 0 or negative

getscrollCount

public int getscrollCount()

Returns the number of items in the scrolling portion of the menu.

Returns:

the number of items to display at a time

setScrollCount

public void setScrollCount(int scrollCount)

Sets the number of items in the scrolling portion of the menu.

Parameters:

scrollCount - the number of items to display at a time

Throws:

IllegalArgumentException - if scrollCount is 0 or negative

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

getBottomFixedCount

public int getBottomFixedCount()

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

Returns:

the number of items

setBottomFixedCount

public void setBottomFixedCount(int bottomFixedCount)

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

Parameters:

bottomFixedCount - the number of items

keepVisible

public void keepVisible(JMenuItem item)

Scrolls the specified item into view each time the menu is opened. Call this method with null to restore the default behavior, which is to show the menu as it last appeared.

Parameters:

item - the item to keep visible

See Also:

• keepVisible(int)

keepVisible

public void keepVisible(int index)

Scrolls the item at the specified index into view each time the menu is opened. Call this method with -1 to restore the default behavior, which is to show the menu as it last appeared.

Parameters:

index - the index of the item to keep visible

See Also:

• keepVisible(javax.swing.JMenuItem)