Action.java

/*
 * Created on 17-dic-2005
 * 
 * TODO To change the template for this generated file go to Window -
 * Preferences - Java - Code Style - Code Templates
 */
package org.herac.tuxguitar.gui.actions;

import org.apache.log4j.Logger;
import org.eclipse.swt.events.TypedEvent;
import org.herac.tuxguitar.gui.TuxGuitar;
import org.herac.tuxguitar.gui.editors.TablatureEditor;
import org.herac.tuxguitar.gui.undo.UndoableEdit;
import org.herac.tuxguitar.song.managers.TGSongManager;
import org.herac.tuxguitar.util.TGSynchronizer;

/**
 * @author julian
 * 
 *         TODO To change the template for this generated type comment go to
 *         Window Preferences - Java - Code Style - Code Templates
 */
public abstract class Action extends ActionAdapter {

  protected static final int AUTO_LOCK = 0x01;

  protected static final int AUTO_UNLOCK = 0x02;

  protected static final int AUTO_UPDATE = 0x04;

  protected static final int DISABLE_ON_PLAYING = 0x10;

  protected static final int KEY_BINDING_AVAILABLE = 0x08;

  private int flags;

  private String name;

  public Action(String name, int flags) {
    this.name = name;
    this.flags = flags;
  }

  public void addUndoableEdit(UndoableEdit anEdit) {
    TuxGuitar.instance().getUndoableManager().addEdit(anEdit);
  }

  protected abstract int execute(TypedEvent e);

  public void fireUpdate(int measureNumber) {
    this.getEditor().getTablature().getViewLayout().fireUpdate(measureNumber);
  }

  public TablatureEditor getEditor() {
    return TuxGuitar.instance().getTablatureEditor();
  }

  protected int getFlags() {
    return this.flags;
  }

  public String getName() {
    return this.name;
  }

  public TGSongManager getSongManager() {
    return TuxGuitar.instance().getSongManager();
  }

  public boolean isKeyBindingAvailable() {
    return ((getFlags() & KEY_BINDING_AVAILABLE) != 0);
  }

  @Override
  public synchronized void process(final TypedEvent e) {
    if (!ActionLock.isLocked() && !TuxGuitar.instance().isLocked()) {
      final int flags = getFlags();

      if ((flags & DISABLE_ON_PLAYING) != 0
          && TuxGuitar.instance().getPlayer().isRunning()) {
        TuxGuitar.instance().updateCache(((flags & AUTO_UPDATE) != 0));
        return;
      }

      if ((flags & AUTO_LOCK) != 0) {
        ActionLock.lock();
      }

      try {
        TGSynchronizer.instance().runLater(new TGSynchronizer.TGRunnable() {
          public void run() throws Throwable {
            if (!TuxGuitar.isDisposed()) {
              int result = execute(e);

              TuxGuitar.instance().updateCache(
                  (((flags | result) & AUTO_UPDATE) != 0));

              if (((flags | result) & AUTO_UNLOCK) != 0) {
                ActionLock.unlock();
              }
            }
          }
        });
      } catch (Throwable throwable) {
        LOG.error(throwable);
      }
    }
  }

  /** The Logger for this class. */
  public static final transient Logger LOG = Logger.getLogger(Action.class);

  public synchronized void updateTablature() {
    TuxGuitar.instance().fireUpdate();
  }
}