/*
* @(#)AbstractViewAction.java
*
* Copyright (c) 1996-2010 by the original authors of JHotDraw and all its
* contributors. All rights reserved.
*
* You may not use, copy or modify this file, except in compliance with the
* license agreement you entered into with the copyright holders. For details
* see accompanying license terms.
*/
package org.jhotdraw.app.action;
import edu.umd.cs.findbugs.annotations.Nullable;
import java.beans.*;
import javax.swing.*;
import org.jhotdraw.app.Application;
import org.jhotdraw.app.View;
/**
* This abstract class can be extended to implement an {@code Action} that acts
* on behalf of a {@link View}.
*
* If the current View object is disabled or is null, the
* AbstractViewAction is disabled as well.
*
* A property name can be specified. When the specified property
* changes or when the current view changes, method updateView
* is invoked.
*
* @author Werner Randelshofer
* @version $Id: AbstractViewAction.java 717 2010-11-21 12:30:57Z rawcoder $
*/
public abstract class AbstractViewAction extends AbstractAction {
private Application app;
@Nullable private View view;
private String propertyName;
public final static String VIEW_PROPERTY = "view";
public final static String ENABLED_PROPERTY = "enabled";
private PropertyChangeListener applicationListener = new PropertyChangeListener() {
@Override
public void propertyChange(PropertyChangeEvent evt) {
if (evt.getPropertyName() == Application.ACTIVE_VIEW_PROPERTY) { // Strings get interned
updateView((View) evt.getOldValue(), (View) evt.getNewValue());
}
}
};
private PropertyChangeListener viewListener = new PropertyChangeListener() {
@Override
public void propertyChange(PropertyChangeEvent evt) {
String name = evt.getPropertyName();
if (name == "enabled") { // Strings get interned
updateEnabled((Boolean) evt.getOldValue(), (Boolean) evt.getNewValue());
} else if (name == propertyName) {
updateView();
}
}
};
/** Creates a new instance which acts on the specified view of the application. */
public AbstractViewAction(Application app, @Nullable View view) {
this.app = app;
this.view = view;
this.enabled = true;
if (view == null) {
app.addPropertyChangeListener(applicationListener);
} else {
view.addPropertyChangeListener(viewListener);
}
}
/**
* Updates the listeners of this action depending on the current view
* of the application.
*/
protected void updateView(@Nullable View oldValue, @Nullable View newValue) {
// We only need to do this, if the view has not been explicitly set
if (view == null) {
if (oldValue != null) {
uninstallViewListeners(oldValue);
}
if (newValue != null) {
installViewListeners(newValue);
}
firePropertyChange(VIEW_PROPERTY, oldValue, newValue);
updateEnabled(oldValue != null && oldValue.isEnabled(),
newValue != null && newValue.isEnabled());
updateView();
}
}
/**
* Sets the property name.
*/
protected void setPropertyName(String name) {
this.propertyName = name;
if (name != null) {
updateView();
}
}
/**
* Gets the property name.
*/
protected String getPropertyName() {
return propertyName;
}
/**
* This method is invoked, when the property changed and when
* the view changed.
*/
protected void updateView() {
}
/**
* Installs listeners on the view object.
*/
protected void installViewListeners(View p) {
p.addPropertyChangeListener(viewListener);
}
/**
* Uninstalls listeners on the view object.
*/
protected void uninstallViewListeners(View p) {
p.removePropertyChangeListener(viewListener);
}
/**
* Updates the enabled state of this action depending on the new enabled
* state of the view.
*/
protected void updateEnabled(boolean oldValue, boolean newValue) {
firePropertyChange("enabled", oldValue, isEnabled());
}
public Application getApplication() {
return app;
}
@Nullable
public View getActiveView() {
return (view == null) ? app.getActiveView() : view;
}
/**
* Returns true if the action is enabled.
* The enabled state of the action depends on the state that has been set
* using setEnabled(), on the enabled state of the application,
* on the enabled state of the active view and whether there is an active
* view.
*
* @return true if the action is enabled, false otherwise
* @see Action#isEnabled
*/
@Override
public boolean isEnabled() {
return getApplication().isEnabled() &&
getActiveView() != null
&& getActiveView().isEnabled()
&& this.enabled;
}
/**
* Enables or disables the action. The enabled state of the action
* depends on the value that is set here and on the enabled state of
* the application.
*
* @param newValue true to enable the action, false to
* disable it
* @see Action#setEnabled
*/
@Override
public void setEnabled(boolean newValue) {
boolean oldValue = this.enabled;
this.enabled = newValue;
boolean projIsEnabled = getActiveView() != null && getActiveView().isEnabled();
firePropertyChange(ENABLED_PROPERTY,
Boolean.valueOf(oldValue && projIsEnabled),
Boolean.valueOf(newValue && projIsEnabled));
}
}
Ads help maintain this website.