Constructor Detail

• public MenuScroller(javax.swing.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

• public MenuScroller(javax.swing.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

• public MenuScroller(javax.swing.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.

  throws:

  IllegalArgumentException if scrollCount is 0 or negative

  Parameters:

  menu - the menu

  scrollCount - the number of items to display at a time

• public MenuScroller(javax.swing.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.

  throws:

  IllegalArgumentException if scrollCount is 0 or negative

  Parameters:

  menu - the popup menu

  scrollCount - the number of items to display at a time

• public MenuScroller(javax.swing.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.

  throws:

  IllegalArgumentException if scrollCount or interval is 0 or negative

  Parameters:

  menu - the menu

  scrollCount - the number of items to display at a time

  interval - the scroll interval, in milliseconds

• public MenuScroller(javax.swing.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.

  throws:

  IllegalArgumentException if scrollCount or interval is 0 or negative

  Parameters:

  menu - the popup menu

  scrollCount - the number of items to display at a time

  interval - the scroll interval, in milliseconds

• public MenuScroller(javax.swing.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.

  throws:

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

  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

• public MenuScroller(javax.swing.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.

  throws:

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

  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

Method Detail

• public void dispose()

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

• @java.lang.Override public void finalize()

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

  throws:

  Throwable if an error occurs.

  See Also:

  MenuScroller.dispose

• public int getBottomFixedCount()

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

  Returns:

  the number of items

• public int getInterval()

  Returns the scroll interval in milliseconds

  Returns:

  the scroll interval in milliseconds

• public int getTopFixedCount()

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

  Returns:

  the number of items

• 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

• 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)

• 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)

• 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

• public void setInterval(int interval)

  Sets the scroll interval in milliseconds

  throws:

  IllegalArgumentException if interval is 0 or negative

  Parameters:

  interval - the scroll interval in milliseconds

• public void setScrollCount(int scrollCount)

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

  throws:

  IllegalArgumentException if scrollCount is 0 or negative

  Parameters:

  scrollCount - the number of items to display at a time

• public static MenuScroller 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 MenuScroller

• public static MenuScroller 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 MenuScroller

• public static MenuScroller 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.

  throws:

  IllegalArgumentException if scrollCount is 0 or negative

  Parameters:

  menu - the menu

  scrollCount - the number of items to display at a time

  Returns:

  the MenuScroller

• public static MenuScroller 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.

  throws:

  IllegalArgumentException if scrollCount is 0 or negative

  Parameters:

  menu - the popup menu

  scrollCount - the number of items to display at a time

  Returns:

  the MenuScroller

• public static MenuScroller 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.

  throws:

  IllegalArgumentException if scrollCount or interval is 0 or negative

  Parameters:

  menu - the menu

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

  interval - the scroll interval, in milliseconds

  Returns:

  the MenuScroller

• public static MenuScroller 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.

  throws:

  IllegalArgumentException if scrollCount or interval is 0 or negative

  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

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

  throws:

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

  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

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

  throws:

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

  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

• 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