org.jdesktop.swingx.hyperlink.LinkModelAction Maven / Gradle / Ivy
/*
* $Id: LinkModelAction.java 3294 2009-03-11 10:50:52Z kleopatra $
*
* Copyright 2004 Sun Microsystems, Inc., 4150 Network Circle,
* Santa Clara, California 95054, U.S.A. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package org.jdesktop.swingx.hyperlink;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import javax.swing.Action;
/**
* Specialized LinkAction for a target of type {@link LinkModel}.
*
*
* This action delegates actionPerformed to vistingDelegate.
*
* PENDING: move to swingx package?
*
* @author Jeanette Winzenburg
*/
public class LinkModelAction extends AbstractHyperlinkAction {
private ActionListener delegate;
public static final String VISIT_ACTION = "visit";
private PropertyChangeListener linkListener;
public LinkModelAction() {
this((T) null);
}
public LinkModelAction(ActionListener visitingDelegate) {
this(null, visitingDelegate);
}
public LinkModelAction(T target) {
this(target, null);
}
public LinkModelAction(T target, ActionListener visitingDelegate) {
super(target);
setVisitingDelegate(visitingDelegate);
}
/**
* The delegate to invoke on actionPerformed.
*
* The delegates actionPerformed is invoked with an ActionEvent
* having the target as source. Delegates are expected to
* cope gracefully with the T.
*
*
* PENDING: JW - How to formalize?
*
* @param delegate the action invoked on the target.
*/
public void setVisitingDelegate(ActionListener delegate) {
this.delegate = delegate;
}
/**
* This action delegates to the visitingDelegate if both
* delegate and target are != null, does nothing otherwise.
* The actionEvent carries the target as source.
*
* PENDING: pass through a null target? - most probably!
*
*
*
*/
public void actionPerformed(ActionEvent e) {
if ((delegate != null) && (getTarget() != null)) {
delegate.actionPerformed(new ActionEvent(getTarget(), ActionEvent.ACTION_PERFORMED, VISIT_ACTION));
}
}
/**
* installs a propertyChangeListener on the target and
* updates the visual properties from the target.
*/
@Override
protected void installTarget() {
if (getTarget() != null) {
getTarget().addPropertyChangeListener(getTargetListener());
}
updateFromTarget();
}
/**
* removes the propertyChangeListener.
*
* Implementation NOTE: this does not clean-up internal state! There is
* no need to because updateFromTarget handles both null and not-null
* targets. Hmm...
*
*/
@Override
protected void uninstallTarget() {
if (getTarget() == null) return;
getTarget().removePropertyChangeListener(getTargetListener());
}
protected void updateFromTarget() {
if (getTarget() != null) {
putValue(Action.NAME, getTarget().getText());
putValue(Action.SHORT_DESCRIPTION, getTarget().getURL().toString());
putValue(VISITED_KEY, new Boolean(getTarget().getVisited()));
} else {
Object[] keys = getKeys();
if (keys == null) return;
for (int i = 0; i < keys.length; i++) {
putValue(keys[i].toString(), null);
}
}
}
private PropertyChangeListener getTargetListener() {
if (linkListener == null) {
linkListener = new PropertyChangeListener() {
public void propertyChange(PropertyChangeEvent evt) {
updateFromTarget();
}
};
}
return linkListener;
}
}