net.sf.latexdraw.actions
Class ModifyPencilParameter

java.lang.Object
  extended by org.malai.action.Action
      extended by org.malai.action.library.ModifyValue
          extended by net.sf.latexdraw.actions.ShapePropertyAction
              extended by net.sf.latexdraw.actions.ModifyPencilParameter

public class ModifyPencilParameter
extends ShapePropertyAction

This action modifies a parameter of the pencil and updates its corresponding instrument.

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/19/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  Pencil pencil
          The pencil to modify.
 
Fields inherited from class net.sf.latexdraw.actions.ShapePropertyAction
property
 
Fields inherited from class org.malai.action.library.ModifyValue
value
 
Fields inherited from class org.malai.action.Action
status
 
Constructor Summary
ModifyPencilParameter()
          Creates and initialises the action.
 
Method Summary
protected  void applyValue(java.lang.Object obj)
          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.
protected  boolean isPropertySupported()
           
 boolean isRegisterable()
          Specifies if the action must be saved in the action register.
 void setPencil(Pencil pencil)
          Defines the pencil to modify.
 
Methods inherited from class net.sf.latexdraw.actions.ShapePropertyAction
isValueMatchesProperty, setProperty
 
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

pencil

protected Pencil pencil
The pencil to modify.

Constructor Detail

ModifyPencilParameter

public ModifyPencilParameter()
Creates and initialises 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 ShapePropertyAction

canDo

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

isPropertySupported

protected boolean isPropertySupported()
Overrides:
isPropertySupported in class ShapePropertyAction
Returns:
True if the property to modify is supported.

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.

setPencil

public void setPencil(Pencil pencil)
Defines the pencil to modify.

Parameters:
pencil - The pencil to modify.
Since:
3.0

applyValue

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

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