+ * This should either never be called or only called in the constructor of this action. + *
+ * All registered adapters should be removed in {@link #destroy()}
+ */
+ protected void installAdapters() {
+ // make this action listen to layer change and selection change events
+ if (listenToLayerChange()) {
+ layerChangeAdapter = new LayerChangeAdapter();
+ activeLayerChangeAdapter = new ActiveLayerChangeAdapter();
+ getLayerManager().addLayerChangeListener(layerChangeAdapter);
+ getLayerManager().addActiveLayerChangeListener(activeLayerChangeAdapter);
+ }
+ if (listenToSelectionChange()) {
+ selectionChangeAdapter = new SelectionChangeAdapter();
+ DataSet.addSelectionListener(selectionChangeAdapter);
+ }
+ initEnabledState();
+ }
+
+ /**
+ * Overwrite this if {@link #updateEnabledState()} should be called when the active / availabe layers change. Default is true.
+ * @return true if a {@link LayerChangeListener} and a {@link ActiveLayerChangeListener} should be registered.
+ * @since xxx
+ */
+ protected boolean listenToLayerChange() {
+ return true;
+ }
+
+ /**
+ * Overwrite this if {@link #updateEnabledState()} should be called when the selection changed. Default is true.
+ * @return true if a {@link SelectionChangedListener} should be registered.
+ * @since xxx
+ */
+ protected boolean listenToSelectionChange() {
+ return true;
+ }
+
@Override
public void destroy() {
if (sc != null) {
Main.unregisterActionShortcut(this);
}
if (layerChangeAdapter != null) {
- Main.getLayerManager().removeActiveLayerChangeListener(layerChangeAdapter);
+ getLayerManager().removeLayerChangeListener(layerChangeAdapter);
+ getLayerManager().removeActiveLayerChangeListener(activeLayerChangeAdapter);
+ }
+ if (selectionChangeAdapter != null) {
+ DataSet.removeSelectionListener(selectionChangeAdapter);
}
- DataSet.removeSelectionListener(selectionChangeAdapter);
}
private void setHelpId() {
@@ -197,6 +235,20 @@ public abstract class JosmAction extends AbstractAction implements Destroyable {
}
/**
+ * Returns the shortcut for this action.
+ * @return the shortcut for this action, or "No shortcut" if none is defined
+ */
+ public Shortcut getShortcut() {
+ if (sc == null) {
+ sc = Shortcut.registerShortcut("core:none", tr("No Shortcut"), KeyEvent.CHAR_UNDEFINED, Shortcut.NONE);
+ // as this shortcut is shared by all action that don't want to have a shortcut,
+ // we shouldn't allow the user to change it...
+ // this is handled by special name "core:none"
+ }
+ return sc;
+ }
+
+ /**
* Sets the tooltip text of this action.
* @param tooltip The text to display in tooltip. Can be {@code null}
*/
@@ -207,30 +259,37 @@ public abstract class JosmAction extends AbstractAction implements Destroyable {
}
/**
+ * Gets the layer manager used for this action. Defaults to the main layer manager but you can overwrite this.
+ *
+ * The layer manager must be available when {@link #installAdapters()} is called and must not change. + * + * @return The layer manager. + * @since xxx + */ + public MainLayerManager getLayerManager() { + return Main.getLayerManager(); + } + + /** * Replies the current edit layer * * @return the current edit layer. null, if no edit layer exists + * @deprecated Use {@link #getLayerManager()}.getEditLayer() instead. To be removed in end of 2016. */ + @Deprecated public static OsmDataLayer getEditLayer() { - return Main.main != null ? Main.main.getEditLayer() : null; + return Main.getLayerManager().getEditLayer(); } /** * Replies the current dataset. * * @return the current dataset. null, if no current dataset exists + * @deprecated Use {@link #getLayerManager()}.getEditDataSet() instead. To be removed in end of 2016. */ + @Deprecated public static DataSet getCurrentDataSet() { - return Main.main != null ? Main.main.getCurrentDataSet() : null; - } - - protected void installAdapters() { - // make this action listen to layer change and selection change events - layerChangeAdapter = new LayerChangeAdapter(); - selectionChangeAdapter = new SelectionChangeAdapter(); - Main.getLayerManager().addActiveLayerChangeListener(layerChangeAdapter); - DataSet.addSelectionListener(selectionChangeAdapter); - initEnabledState(); + return Main.getLayerManager().getEditDataSet(); } protected static void waitFuture(final Future future, final PleaseWaitProgressMonitor monitor) { @@ -272,6 +331,7 @@ public abstract class JosmAction extends AbstractAction implements Destroyable { * * @see #updateEnabledState(Collection) * @see #initEnabledState() + * @see #listenToLayerChange() */ protected void updateEnabledState() { } @@ -285,6 +345,7 @@ public abstract class JosmAction extends AbstractAction implements Destroyable { * * @see #updateEnabledState() * @see #initEnabledState() + * @see #listenToSelectionChange() */ protected void updateEnabledState(Collection selection) { } @@ -292,9 +353,19 @@ public abstract class JosmAction extends AbstractAction implements Destroyable { /** * Adapter for layer change events. Runs updateEnabledState() whenever the active layer changed. */ - protected class LayerChangeAdapter implements ActiveLayerChangeListener { + protected class LayerChangeAdapter implements LayerChangeListener { @Override - public void activeOrEditLayerChanged(ActiveLayerChangeEvent e) { + public void layerAdded(LayerAddEvent e) { + updateEnabledState(); + } + + @Override + public void layerRemoving(LayerRemoveEvent e) { + updateEnabledState(); + } + + @Override + public void layerOrderChanged(LayerOrderChangeEvent e) { updateEnabledState(); } @@ -305,6 +376,21 @@ public abstract class JosmAction extends AbstractAction implements Destroyable { } /** + * Adapter for layer change events. Runs updateEnabledState() whenever the active layer changed. + */ + protected class ActiveLayerChangeAdapter implements ActiveLayerChangeListener { + @Override + public void activeOrEditLayerChanged(ActiveLayerChangeEvent e) { + updateEnabledState(); + } + + @Override + public String toString() { + return "ActiveLayerChangeAdapter [" + JosmAction.this.toString() + ']'; + } + } + + /** * Adapter for selection change events. Runs updateEnabledState() whenever the selection changed. */ protected class SelectionChangeAdapter implements SelectionChangedListener {