org.malai.action.library
Class Scroll

java.lang.Object
  extended by org.malai.action.Action
      extended by org.malai.action.library.Scroll

public class Scroll
extends Action

Defines an action that scrolls 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  int increment
          The scrolling increment.
protected  MPanel panel
          The panel that contains the scroller.
 
Fields inherited from class org.malai.action.Action
status
 
Constructor Summary
Scroll()
          Creates and initialises a Scroll 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.
 int getIncrement()
           
 MPanel getPanel()
           
 boolean isRegisterable()
          Specifies if the action must be saved in the action register.
 void setIncrement(int increment)
          Sets the increment.
 void setPanel(MPanel panel)
          Sets the panel that contains the scroller.
 
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

panel

protected MPanel panel
The panel that contains the scroller.


increment

protected int increment
The scrolling increment.

Constructor Detail

Scroll

public Scroll()
Creates and initialises a Scroll 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()
Specified by:
canDo in class Action
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.

getPanel

public MPanel getPanel()
Returns:
The panel to scroll.
Since:
0.2

setPanel

public void setPanel(MPanel panel)
Sets the panel that contains the scroller.

Parameters:
panel - The new panel.
Since:
0.2

getIncrement

public int getIncrement()
Returns:
The increment.
Since:
0.2

setIncrement

public void setIncrement(int increment)
Sets the increment.

Parameters:
increment - The new value of the increment.
Since:
0.2