org.malai.action.library
Class ActivateInstrument

java.lang.Object
  extended by org.malai.action.Action
      extended by org.malai.action.library.InstrumentAction
          extended by org.malai.action.library.ActivateInstrument
Direct Known Subclasses:
InitTextSetter

public class ActivateInstrument
extends InstrumentAction

This action activates an instrument.

This file is part of Malai.
Copyright (c) 2009-2012 Arnaud BLOUIN

Malai is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
Malai is distributed without any warranty; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Since:
0.2
Author:
Arnaud Blouin

Nested Class Summary
 
Nested classes/interfaces inherited from class org.malai.action.Action
Action.ActionStatus
 
Field Summary
 
Fields inherited from class org.malai.action.library.InstrumentAction
instrument
 
Fields inherited from class org.malai.action.Action
status
 
Constructor Summary
ActivateInstrument()
          InstrumentAction.InstrumentAction()
 
Method Summary
protected  void doActionBody()
          This method contains the core code to execute when the action is executed.
 boolean isRegisterable()
          Specifies if the action must be saved in the action register.
 
Methods inherited from class org.malai.action.library.InstrumentAction
canDo, flush, getInstrument, setInstrument
 
Methods inherited from class org.malai.action.Action
abort, cancelledBy, doIt, done, getStatus, hadEffect, isDone, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ActivateInstrument

public ActivateInstrument()
InstrumentAction.InstrumentAction()

Method Detail

doActionBody

protected void doActionBody()
Description copied from class: Action
This method contains the core code to execute when the action is executed.

Specified by:
doActionBody in class Action

isRegisterable

public boolean isRegisterable()
Description copied from class: Action
Specifies if the action must be saved in the action register. For instance, some actions, such as a scroll of the scroll bars, should not be saved nor put in the undo/redo manager. Thus, they must not be registrable.

Specified by:
isRegisterable in class Action
Returns:
True: the action is registrable.