Package org.jdesktop.swingx.hyperlink

Class AbstractHyperlinkAction<T>

java.lang.Object

javax.swing.AbstractAction

org.jdesktop.swingx.action.AbstractActionExt

org.jdesktop.swingx.hyperlink.AbstractHyperlinkAction<T>

All Implemented Interfaces:

ActionListener, ItemListener, Serializable, Cloneable, EventListener, Action

Direct Known Subclasses:

BasicCalendarHeaderHandler.ZoomOutAction, HyperlinkAction, LinkModelAction

public abstract class AbstractHyperlinkAction<T>
extends AbstractActionExt

Convenience implementation to simplify JXHyperlink configuration and provide minimal api.

Author:

Jeanette Winzenburg

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected T	target	the object the actionPerformed can act on.
static String	VISITED_KEY	Key for the visited property value.

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from class org.jdesktop.swingx.action.AbstractActionExt

GROUP, IS_STATE, LARGE_ICON

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor	Description
AbstractHyperlinkAction()	Instantiates a LinkAction with null target.
AbstractHyperlinkAction(T target)	Instantiates a LinkAction with a target of type targetClass.

Method Summary

Modifier and Type	Method	Description
T	getTarget()
protected void	installTarget()	hook for subclasses to update internal state after a new target has been set.
boolean	isVisited()
void	itemStateChanged(ItemEvent e)	Callback method as ItemListener.
void	setStateAction(boolean state)	Set the state property.
void	setTarget(T target)	PRE: isTargetable(target)
void	setVisited(boolean visited)	Set the visited property.
protected void	uninstallTarget()	hook for subclasses to cleanup before the old target is overwritten.

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class org.jdesktop.swingx.action.AbstractActionExt

dispose, getAccelerator, getActionCommand, getGroup, getLargeIcon, getLongDescription, getMnemonic, getName, getShortDescription, getSmallIcon, isSelected, isStateAction, setAccelerator, setActionCommand, setGroup, setLargeIcon, setLongDescription, setMnemonic, setMnemonic, setName, setSelected, setShortDescription, setSmallIcon, setStateAction, toString

Methods inherited from interface javax.swing.Action

accept

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Methods inherited from class java.lang.Object

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

Field Detail

VISITED_KEY

public static final String VISITED_KEY

Key for the visited property value.

See Also:

Constant Field Values

target

protected T target

the object the actionPerformed can act on.

Constructor Detail

AbstractHyperlinkAction

public AbstractHyperlinkAction()

Instantiates a LinkAction with null target.

AbstractHyperlinkAction

public AbstractHyperlinkAction(T target)

Instantiates a LinkAction with a target of type targetClass. The visited property is initialized as defined by installTarget()

Parameters:

target - the target this action should act on.

Method Detail

setVisited

public void setVisited(boolean visited)

Set the visited property.

Parameters:

visited -

isVisited

public boolean isVisited()

Returns:

visited state

getTarget

public T getTarget()

setTarget

public void setTarget(T target)

PRE: isTargetable(target)

Parameters:

target -

installTarget

protected void installTarget()

hook for subclasses to update internal state after a new target has been set.

Subclasses are free to decide the details. Here:

• the text property is set to target.toString or empty String if the target is null
• visited is set to false.

uninstallTarget

protected void uninstallTarget()

hook for subclasses to cleanup before the old target is overwritten.

Subclasses are free to decide the details. Here: does nothing.

itemStateChanged

public void itemStateChanged(ItemEvent e)

Description copied from class: AbstractActionExt

Callback method as ItemListener. Updates internal state based on the given ItemEvent.

Here: synchs selected property if isStateAction(), does nothing otherwise.

Specified by:

itemStateChanged in interface ItemListener

Overrides:

itemStateChanged in class AbstractActionExt

Parameters:

e - the ItemEvent fired by a ItemSelectable on changing the selected state.

setStateAction

public void setStateAction(boolean state)

Set the state property. Overridden to to nothing. PENDING: really?

Overrides:

setStateAction in class AbstractActionExt

Parameters:

state - if true then this action will fire ItemEvents