org.malai.action.library
Class Zoom

java.lang.Object
  extended by org.malai.action.Action
      extended by org.malai.action.library.PositionAction
          extended by org.malai.action.library.Zoom

public class Zoom
extends PositionAction

Defines an action that zoom int/out a panel.

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.

05/11/2010

Since:
0.2
Version:
0.2
Author:
Arnaud BLOUIN

Nested Class Summary
 
Nested classes/interfaces inherited from class org.malai.action.Action
Action.ActionStatus
 
Field Summary
protected  Zoomable zoomable
          The object to zoom.
protected  double zoomLevel
          The zooming level.
 
Fields inherited from class org.malai.action.library.PositionAction
px, py
 
Fields inherited from class org.malai.action.Action
status
 
Constructor Summary
Zoom()
          Initialises a Zoom 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.
 boolean isRegisterable()
          Specifies if the action must be saved in the action register.
 void setZoomable(Zoomable zoomable)
           
 void setZoomLevel(double zoomLevel)
           
 
Methods inherited from class org.malai.action.library.PositionAction
setPx, setPy
 
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

zoomable

protected Zoomable zoomable
The object to zoom.


zoomLevel

protected double zoomLevel
The zooming level.

Constructor Detail

Zoom

public Zoom()
Initialises a Zoom action.

Since:
0.2
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

canDo

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

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.

setZoomable

public void setZoomable(Zoomable zoomable)
Parameters:
zoomable - the zoomable to set.
Since:
0.2

setZoomLevel

public void setZoomLevel(double zoomLevel)
Parameters:
zoomLevel - the zoomLevel to set.
Since:
0.2