artisynth.core.modelmenu

Class JMenuScroller

java.lang.Object

artisynth.core.modelmenu.JMenuScroller

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

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

Modified from: http://www.camick.com/java/source/MenuScroller.java

Constructor Summary

Constructors

Constructor and Description
JMenuScroller(javax.swing.JMenu menu) Constructs a JMenuScroller that scrolls a menu with the default number of items to display at a time, and default scrolling interval.
JMenuScroller(javax.swing.JMenu menu, int scrollCount) Constructs a JMenuScroller that scrolls a menu with the specified number of items to display at a time, and default scrolling interval.
JMenuScroller(javax.swing.JMenu menu, int scrollCount, int interval) Constructs a JMenuScroller that scrolls a menu with the specified number of items to display in the scrolling region, and the specified scrolling interval.
JMenuScroller(javax.swing.JPopupMenu menu) Constructs a JMenuScroller that scrolls a popup menu with the default number of items to display at a time, and default scrolling interval.
JMenuScroller(javax.swing.JPopupMenu menu, int scrollCount) Constructs a JMenuScroller that scrolls a popup menu with the specified number of items to display at a time, and default scrolling interval.
JMenuScroller(javax.swing.JPopupMenu menu, int scrollCount, int interval) Constructs a JMenuScroller that scrolls a popup menu with the specified number of items to display in the scrolling region, and the specified scrolling interval.

Method Summary

Modifier and Type	Method and Description
void	dispose() Removes this JMenuScroller from the associated menu and restores the default behavior of the menu.
void	finalize() Ensures that the dispose method of this JMenuScroller is called when there are no more refrences to it.
int	getInterval() Returns the scroll interval in milliseconds
int	getscrollCount() Returns the number of items in the scrolling portion of the menu.
void	keepVisible(int index) Scrolls the item at the specified index into view each time the menu is opened.
void	keepVisible(javax.swing.JMenuItem item) Scrolls the specified item into view each time the menu is opened.
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 JMenuScroller	setScrollerFor(javax.swing.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 JMenuScroller	setScrollerFor(javax.swing.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 JMenuScroller	setScrollerFor(javax.swing.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 JMenuScroller	setScrollerFor(javax.swing.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 JMenuScroller	setScrollerFor(javax.swing.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 JMenuScroller	setScrollerFor(javax.swing.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

JMenuScroller

public JMenuScroller(javax.swing.JMenu menu)

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

Parameters:

menu - the menu

JMenuScroller

public JMenuScroller(javax.swing.JPopupMenu menu)

Constructs a JMenuScroller 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

JMenuScroller

public JMenuScroller(javax.swing.JMenu menu,
                     int scrollCount)

Constructs a JMenuScroller 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:

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

JMenuScroller

public JMenuScroller(javax.swing.JPopupMenu menu,
                     int scrollCount)

Constructs a JMenuScroller 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:

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

JMenuScroller

public JMenuScroller(javax.swing.JMenu menu,
                     int scrollCount,
                     int interval)

Constructs a JMenuScroller that scrolls a menu with the specified number of items to display in the scrolling region, and the specified scrolling interval.

Parameters:

menu - the menu

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

interval - the scroll interval, in milliseconds

Throws:

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

JMenuScroller

public JMenuScroller(javax.swing.JPopupMenu menu,
                     int scrollCount,
                     int interval)

Constructs a JMenuScroller that scrolls a popup menu with the specified number of items to display in the scrolling region, and the specified scrolling interval.

Parameters:

menu - the popup menu

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

interval - the scroll interval, in milliseconds

Throws:

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

Method Detail

setScrollerFor

public static JMenuScroller setScrollerFor(javax.swing.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 JMenuScroller

setScrollerFor

public static JMenuScroller setScrollerFor(javax.swing.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 JMenuScroller

setScrollerFor

public static JMenuScroller setScrollerFor(javax.swing.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 JMenuScroller

Throws:

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

setScrollerFor

public static JMenuScroller setScrollerFor(javax.swing.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 JMenuScroller

Throws:

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

setScrollerFor

public static JMenuScroller setScrollerFor(javax.swing.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 JMenuScroller

Throws:

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

setScrollerFor

public static JMenuScroller setScrollerFor(javax.swing.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 JMenuScroller

Throws:

java.lang.IllegalArgumentException - if scrollCount or interval is 0 or 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:

java.lang.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:

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

keepVisible

public void keepVisible(javax.swing.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)

dispose

public void dispose()

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

finalize

public void finalize()
              throws java.lang.Throwable

Ensures that the dispose method of this JMenuScroller is called when there are no more refrences to it.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - if an error occurs.

See Also:

dispose()