com.alee.utils.swing

Class AbstractObjectHoverBehavior<C extends javax.swing.JComponent,V>

java.lang.Object

java.awt.event.MouseAdapter

com.alee.utils.swing.AbstractObjectHoverBehavior<C,V>

All Implemented Interfaces:

Behavior, java.awt.event.ComponentListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

ListItemHoverBehavior, TreePathHoverBehavior

public abstract class AbstractObjectHoverBehavior<C extends javax.swing.JComponent,V>
extends java.awt.event.MouseAdapter
implements java.awt.event.ComponentListener, Behavior

Field Summary

Fields

Modifier and Type	Field and Description
protected C	component Component into which this behavior is installed.
protected boolean	enabledOnly Whether or not behavior should only track hover events when component is enabled.
protected V	hoverObject Current hover object.

Constructor Summary

Constructors

Constructor and Description
AbstractObjectHoverBehavior(C component) Constructs behavior for the specified component.
AbstractObjectHoverBehavior(C component, boolean enabledOnly) Constructs behavior for the specified component.

Method Summary

Modifier and Type	Method and Description
protected void	checkHoverChange(V object) Checks hover object change and fires event if it has changed.
protected void	clearHover() Clears hover path.
void	componentHidden(java.awt.event.ComponentEvent e)
void	componentMoved(java.awt.event.ComponentEvent e)
void	componentResized(java.awt.event.ComponentEvent e)
void	componentShown(java.awt.event.ComponentEvent e)
protected abstract V	getObjectAt(java.awt.Point point) Returns object at the specified point.
abstract void	hoverChanged(V previous, V current) Informs when hover object changes.
void	install() Installs behavior into component.
boolean	isEnabledOnly() Returns whether or not behavior should only track hover events when component is enabled.
void	mouseDragged(java.awt.event.MouseEvent e)
void	mouseEntered(java.awt.event.MouseEvent e)
void	mouseExited(java.awt.event.MouseEvent e)
void	mouseMoved(java.awt.event.MouseEvent e)
void	setEnabledOnly(boolean enabledOnly) Sets whether or not behavior should only track hover events when component is enabled.
void	uninstall() Uninstalls behavior from the component.
protected void	updateHover() Updates hover index.
protected void	updateHover(java.awt.event.MouseEvent e) Updates hover index.
protected void	updateHover(java.awt.Point point) Updates hover path.

Methods inherited from class java.awt.event.MouseAdapter

mouseClicked, mousePressed, mouseReleased, mouseWheelMoved

Methods inherited from class java.lang.Object

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

Field Detail

component

protected final C extends javax.swing.JComponent component

Component into which this behavior is installed.

enabledOnly

protected boolean enabledOnly

Whether or not behavior should only track hover events when component is enabled.

hoverObject

protected V hoverObject

Current hover object. It is saved explicitly to properly provide previous state object.

Constructor Detail

AbstractObjectHoverBehavior

public AbstractObjectHoverBehavior(C component)

Constructs behavior for the specified component.

Parameters:

component - component into which this behavior is installed

AbstractObjectHoverBehavior

public AbstractObjectHoverBehavior(C component,
                                   boolean enabledOnly)

Constructs behavior for the specified component.

Parameters:

component - component into which this behavior is installed

enabledOnly - whether or not behavior should only track hover events when component is enabled

Method Detail

install

public void install()

Installs behavior into component.

uninstall

public void uninstall()

Uninstalls behavior from the component.

isEnabledOnly

public boolean isEnabledOnly()

Returns whether or not behavior should only track hover events when component is enabled.

Returns:

true if behavior should only track hover events when component is enabled, false otherwise

setEnabledOnly

public void setEnabledOnly(boolean enabledOnly)

Sets whether or not behavior should only track hover events when component is enabled.

Parameters:

enabledOnly - whether or not behavior should only track hover events when component is enabled

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

Overrides:

mouseEntered in class java.awt.event.MouseAdapter

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent e)

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

Overrides:

mouseMoved in class java.awt.event.MouseAdapter

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent e)

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

Overrides:

mouseDragged in class java.awt.event.MouseAdapter

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Specified by:

mouseExited in interface java.awt.event.MouseListener

Overrides:

mouseExited in class java.awt.event.MouseAdapter

componentResized

public void componentResized(java.awt.event.ComponentEvent e)

Specified by:

componentResized in interface java.awt.event.ComponentListener

componentMoved

public void componentMoved(java.awt.event.ComponentEvent e)

Specified by:

componentMoved in interface java.awt.event.ComponentListener

componentShown

public void componentShown(java.awt.event.ComponentEvent e)

Specified by:

componentShown in interface java.awt.event.ComponentListener

componentHidden

public void componentHidden(java.awt.event.ComponentEvent e)

Specified by:

componentHidden in interface java.awt.event.ComponentListener

updateHover

protected void updateHover()

Updates hover index.

updateHover

protected void updateHover(java.awt.event.MouseEvent e)

Updates hover index.

Parameters:

e - mouse event

updateHover

protected void updateHover(java.awt.Point point)

Updates hover path.

Parameters:

point - mouse position on the component

getObjectAt

protected abstract V getObjectAt(java.awt.Point point)

Returns object at the specified point.

Parameters:

point - hover point

Returns:

object at the specified point

clearHover

protected void clearHover()

Clears hover path.

checkHoverChange

protected void checkHoverChange(V object)

Checks hover object change and fires event if it has changed.

Parameters:

object - hover object

hoverChanged

public abstract void hoverChanged(V previous,
                                  V current)

Informs when hover object changes.

Parameters:

previous - previous hover object

current - current hover object