com.wordpress.tipsforjava.swing
[Java] Class ScrollBarToolTip

java.lang.Object
  com.wordpress.tipsforjava.swing.ScrollBarToolTip

All Implemented Interfaces:

MouseListener, MouseMotionListener

public class ScrollBarToolTip
extends Object

The ScrollBarToolTip class allows you to simulate the display of a tooltip as the scrollbar thumb is being dragged. This may be usefull when scrolling through a large amount of data in a scrollpane. The STYLE of the tooltip can be specified. A "fixed" style implies that the tooltip is fixed at a certain spot when the mouse is pressed on the toolbar thumb. A "floating" style implies that the tooltip will move as the toolbar thumb is dragged. The POSITION of the tooltip indicates how the tooltip is placed relative to the scrollbar. The default tooltip text shows the relationship of the current position of the scrollbar to the maximum scrollbar value as a percentage.

Authors:

Rob Camick

Darryl Burke

ADJUSTMENT

private static final int ADJUSTMENT

GAP

private static final int GAP

popup

private Popup popup

position

private ScrollBarToolTip.Position position

pressedPoint

private Point pressedPoint

scrollBar

private JScrollBar scrollBar

style

private ScrollBarToolTip.Style style

toolTip

private JToolTip toolTip

ScrollBarToolTip

public ScrollBarToolTip(JScrollBar scrollBar)

Convenience constructor with a Style enum of FIXED_PRESSED and a Position enum of INSIDE.

Parameters:

scrollBar - the JScrollBar the tooltip will be displayed for

ScrollBarToolTip

public ScrollBarToolTip(JScrollBar scrollBar, ScrollBarToolTip.Style style, ScrollBarToolTip.Position position)

Create a ScrollBarToolTip

Parameters:

scrollBar - the JScrollBar the tooltip will be displayed for

style - the style of the tooltip (see setStyle() for values)

position - the position of the tooltip (see setPosition() for values)

getHorizontalX

private int getHorizontalX(MouseEvent e)

getHorizontalY

private int getHorizontalY(MouseEvent e)

getPosition

public ScrollBarToolTip.Position getPosition()

Get the Position tooltip

Returns:

the tooltip Position

getStyle

public ScrollBarToolTip.Style getStyle()

Get the Style tooltip

Returns:

the tooltip Style

getToolTipLocation

protected Point getToolTipLocation(MouseEvent event)

getToolTipText

protected String getToolTipText(MouseEvent event)

getVerticalX

private int getVerticalX(MouseEvent e)

getVerticalY

private int getVerticalY(MouseEvent e)

mouseClicked

de
	public
public void mouseClicked(MouseEvent e)

mouseDragged

de
	public
public void mouseDragged(MouseEvent e)

Update the tooltip text and/or position as the mouse is dragged

mouseEntered

de
	public
public void mouseEntered(MouseEvent e)

mouseExited

de
	public
public void mouseExited(MouseEvent e)

mouseMoved

de
	public
public void mouseMoved(MouseEvent e)

mousePressed

de
	public
public void mousePressed(MouseEvent e)

mouseReleased

de
	public
public void mouseReleased(MouseEvent e)

setPosition

public void setPosition(ScrollBarToolTip.Position position)

Set the Position of the tooltip relative to the scrollbar. The valid Positions are:

• Center - the tooltip is centered over the scrollbar
• Inside - the tooltip is located inside the scrollpane the scrollbar belongs to
• Inside Edge - the tooltip is justified to the inside edge of the scrollbar
• Outside - the tooltip is located outside the scrollpane the scrollbar belongs to
• Outside Edge - the tooltip is justified to the outside edge of the scrollbar

Parameters:

position - the Position of the tooltip

setStyle

public void setStyle(ScrollBarToolTip.Style style)

Set the Style of the tooltip. The valid Styles are:

• Fixed Pressed - the tooltip is fixed at the position where the mouse was pressed to begin dragging
• Fixed Start - the tooltip is fixed at the start of the scrollbar (top or left, depending on the orientation)
• Fixed End - the tooltip is fixed at the end of the scrollbar (bottom or right, depending on the orientation)
• Float Start - the tooltip floats between the start of the scrollbar and the scrollbar thumb as the thumb is dragged
• Float End - the tooltip floats between the end of the scrollbar and the scrollbar thumb as the thumb is dragged

Parameters:

style - the Style of the tooltip

showToolTip

protected void showToolTip(MouseEvent event)

valueOf

ScrollBarToolTip valueOf(String name)

Returns the enum constant of this type with the specified name.

valueOf

ScrollBarToolTip valueOf(String name)

Returns the enum constant of this type with the specified name.

values

ScrollBarToolTip[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

values

ScrollBarToolTip[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Groovy Documentation