com.google.gwt.user.client.ui
Class LayoutCommand

java.lang.Object
  extended by com.google.gwt.user.client.ui.LayoutCommand
All Implemented Interfaces:
Scheduler.ScheduledCommand

public class LayoutCommand
extends java.lang.Object
implements Scheduler.ScheduledCommand

A scheduled command used by animated layouts to ensure that only layout is ever performed for a panel within a given user event.

Note: This class assumes that Layout.Layer#getUserObject() will return the widget associated with a given layer.


Constructor Summary
LayoutCommand(Layout layout)
          Creates a new command for the given layout object.
 
Method Summary
 void cancel()
          Cancels this command.
 void execute()
          Invokes the command.
 void schedule(int duration, Layout.AnimationCallback callback)
          Schedules a layout.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LayoutCommand

public LayoutCommand(Layout layout)
Creates a new command for the given layout object.

Parameters:
layout -
Method Detail

cancel

public void cancel()
Cancels this command. A subsequent call to #schedule(int, AnimationCallback) will re-enable it.


execute

public final void execute()
Description copied from interface: Scheduler.ScheduledCommand
Invokes the command.

Specified by:
execute in interface Scheduler.ScheduledCommand

schedule

public void schedule(int duration,
                     Layout.AnimationCallback callback)
Schedules a layout. The duration and callback passed to this method will supercede any previous call that has not yet been executed.

Parameters:
duration -
callback -