net.sf.latexdraw.actions
Class ModifyPencilStyle

java.lang.Object
  extended by org.malai.action.Action
      extended by net.sf.latexdraw.actions.ModifyPencilStyle

public class ModifyPencilStyle
extends Action

This action allows to set the kind of shape that the pencil must draw.

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.

05/14/2010

Since:
3.0
Author:
Arnaud BLOUIN

Nested Class Summary
 
Nested classes/interfaces inherited from class org.malai.action.Action
Action.ActionStatus
 
Field Summary
protected  EditionChoice editingChoice
          The new editing choice to set.
protected  Pencil pencil
          The pencil to set.
 
Fields inherited from class org.malai.action.Action
status
 
Constructor Summary
ModifyPencilStyle()
          Creates the action.
 
Method Summary
 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.
 EditionChoice getEditingChoice()
           
 Pencil getPencil()
           
 boolean isRegisterable()
          Specifies if the action must be saved in the action register.
 void setEditingChoice(EditionChoice editingChoice)
          Sets the new editing choice of the pencil.
 void setPencil(Pencil pencil)
          Sets the pencil to parameterise.
 
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

pencil

protected Pencil pencil
The pencil to set.


editingChoice

protected EditionChoice editingChoice
The new editing choice to set.

Constructor Detail

ModifyPencilStyle

public ModifyPencilStyle()
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 Action

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()
Specified by:
canDo in class Action
Returns:
True if the action can be executed.

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.

getPencil

public Pencil getPencil()
Returns:
The pencil to parameterise.
Since:
3.0

setPencil

public void setPencil(Pencil pencil)
Sets the pencil to parameterise.

Parameters:
pencil - The pencil.
Since:
3.0

getEditingChoice

public EditionChoice getEditingChoice()
Returns:
The editing choice to set.
Since:
3.0

setEditingChoice

public void setEditingChoice(EditionChoice editingChoice)
Sets the new editing choice of the pencil.

Parameters:
editingChoice - The new editing choice (can be null).
Since:
3.0