org.malai.action.library
Class ShowWidget

java.lang.Object
  extended by org.malai.action.Action
      extended by org.malai.action.library.WidgetAction
          extended by org.malai.action.library.ShowWidget

public class ShowWidget
extends WidgetAction

This action shows or hides a JComponent.

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.

11/20/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  boolean visible
          Defines if the component must be shown or hidden.
 
Fields inherited from class org.malai.action.library.WidgetAction
component
 
Fields inherited from class org.malai.action.Action
status
 
Constructor Summary
ShowWidget()
          Creates the action.
 
Method Summary
 boolean canDo()
           
protected  void doActionBody()
          This method contains the core code to execute when the action is executed.
 boolean isRegisterable()
          Specifies if the action must be saved in the action register.
 void setVisible(boolean visible)
           
 
Methods inherited from class org.malai.action.library.WidgetAction
flush, setComponent
 
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

visible

protected boolean visible
Defines if the component must be shown or hidden.

Constructor Detail

ShowWidget

public ShowWidget()
Creates the action.

Since:
0.2
Method Detail

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 WidgetAction
Returns:
True if the action can be executed.

setVisible

public void setVisible(boolean visible)
Parameters:
visible - Defines if the component must be shown or hidden.
Since:
0.2