net.sf.latexdraw.actions
Class ModifyMagneticGrid

java.lang.Object
  extended by org.malai.action.Action
      extended by org.malai.action.library.ModifyValue
          extended by net.sf.latexdraw.actions.ModifyMagneticGrid
All Implemented Interfaces:
Undoable

public class ModifyMagneticGrid
extends ModifyValue
implements Undoable

This action modifies a property of the magnetic grid.

This file is part of LaTeXDraw.
Copyright (c) 2005-2012 Arnaud BLOUIN

LaTeXDraw 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.
LaTeXDraw 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.

11/14/2010

Since:
3.0
Author:
Arnaud BLOUIN

Nested Class Summary
static class ModifyMagneticGrid.GridProperties
          The different properties of the magnetic grid that can be modified.
 
Nested classes/interfaces inherited from class org.malai.action.Action
Action.ActionStatus
 
Field Summary
protected  LMagneticGrid grid
          The magnetic grid to modify.
protected  java.lang.Object oldValue
          A back-up of the former value of the modified property.
protected  ModifyMagneticGrid.GridProperties property
          The property to modify.
 
Fields inherited from class org.malai.action.library.ModifyValue
value
 
Fields inherited from class org.malai.action.Action
status
 
Constructor Summary
ModifyMagneticGrid()
          Creates the action.
 
Method Summary
protected  void applyValue(java.lang.Object object)
          This method executes the job of methods undo, redo, and do
 boolean canDo()
           
protected  void doActionBody()
          This method contains the core code to execute when the action is executed.
 void flush()
          When an action is no more useful it can be flushes to release the used data.
 java.lang.String getUndoName()
           
 boolean isRegisterable()
          Specifies if the action must be saved in the action register.
protected  boolean isValueMatchesProperty()
           
 void redo()
          Redoes the cancelled action.
 void setGrid(LMagneticGrid grid)
           
 void setProperty(ModifyMagneticGrid.GridProperties property)
           
 void undo()
          Cancels the action.
 
Methods inherited from class org.malai.action.library.ModifyValue
setValue
 
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
 

Field Detail

grid

protected LMagneticGrid grid
The magnetic grid to modify.


property

protected ModifyMagneticGrid.GridProperties property
The property to modify.


oldValue

protected java.lang.Object oldValue
A back-up of the former value of the modified property.

Constructor Detail

ModifyMagneticGrid

public ModifyMagneticGrid()
Creates the action.

Since:
3.0
Method Detail

flush

public void flush()
Description copied from class: Action
When an action is no more useful it can be flushes to release the used data. Should be overridden.

Overrides:
flush in class ModifyValue

undo

public void undo()
Description copied from interface: Undoable
Cancels the action.

Specified by:
undo in interface Undoable

redo

public void redo()
Description copied from interface: Undoable
Redoes the cancelled action.

Specified by:
redo in interface Undoable

applyValue

protected void applyValue(java.lang.Object object)
Description copied from class: ModifyValue
This method executes the job of methods undo, redo, and do

Specified by:
applyValue in class ModifyValue
Parameters:
object - The value to set. Must not be null.

getUndoName

public java.lang.String getUndoName()
Specified by:
getUndoName in interface Undoable
Returns:
The name of the undo 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.

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

canDo

public boolean canDo()
Overrides:
canDo in class ModifyValue
Returns:
True if the action can be executed.

isValueMatchesProperty

protected boolean isValueMatchesProperty()
Specified by:
isValueMatchesProperty in class ModifyValue
Returns:
True: the object to modified supports the selected property.

setGrid

public void setGrid(LMagneticGrid grid)
Parameters:
grid - The grid to modify.
Since:
3.0

setProperty

public void setProperty(ModifyMagneticGrid.GridProperties property)
Parameters:
property - The property to modify.
Since:
3.0