LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.app.behaviorinterface
Interface LyWaitBehaviorInterface

All Superinterfaces:
LyActionBehaviorInterface, LyBehaviorInterface
All Known Implementing Classes:
LyWaitBehavior

public interface LyWaitBehaviorInterface
extends LyActionBehaviorInterface

This interface defines the methods to implement in order to have a behavior that controls the evolution of the progress bar, the label, and the icon associated to a wait view shown while a time consumming action is performed.

See Also:
LyWaitController

Field Summary
static java.lang.String __VERSION
          File version
 
Method Summary
 void endWaiting(LyWaitController controller)
          Method invoked at the end of the wait, when it is over.
 java.lang.String getWaitIcon(LyWaitController controller)
          Gets the current icon for the waiting view.
 java.lang.String getWaitLabel(LyWaitController controller)
          Gets the current label for the waiting view.
 int getWaitValue(LyWaitController controller)
          Gets the current progress value.
 void increaseOffset(LyWaitController controller)
          Increases the current offset.
 void startWaiting(LyWaitController controller)
          Method called when the waiting starts.
 
Methods inherited from interface leon.app.behaviorinterface.LyActionBehaviorInterface
endAction, getClientContext, getContextTitle, getHelpFile, getImage, getImageTooltip, getKeyValue, getMenuItemImage, getTitle, reset, startAction
 
Methods inherited from interface leon.app.behaviorinterface.LyBehaviorInterface
free, handleDemand, init
 

Field Detail

__VERSION

static final java.lang.String __VERSION
File version

See Also:
Constant Field Values
Method Detail

getWaitValue

int getWaitValue(LyWaitController controller)
Gets the current progress value. This method is invoked when the view is updated.

Parameters:
controller - the current LyWaitController instance
Returns:
the current progress value

getWaitLabel

java.lang.String getWaitLabel(LyWaitController controller)
Gets the current label for the waiting view. This method is invoked when the view is updated. May update the label of the waiting view.

Parameters:
controller - the current LyWaitController instance
Returns:
the label or null if the label should not change

getWaitIcon

java.lang.String getWaitIcon(LyWaitController controller)
Gets the current icon for the waiting view. This method is invoked when the view is updated. May update the icon of the waiting view.

Parameters:
controller - the current LyWaitController instance
Returns:
the current icon or null if the current icon should not change

increaseOffset

void increaseOffset(LyWaitController controller)
Increases the current offset. This method is used to simulate smoth progression of the bar.

Parameters:
controller - the current LyWaitController instance

startWaiting

void startWaiting(LyWaitController controller)
Method called when the waiting starts. May be overriden to do extra work.

Parameters:
controller - current LyWaitController instance

endWaiting

void endWaiting(LyWaitController controller)
Method invoked at the end of the wait, when it is over. Should complete progress bar because the controller has ended the progression. May do extra work here, or close the view.
The default implementation wait until the minimum display time is over (defined by MIN_DURATION).

Parameters:
controller - the current LyWaitController instance

(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com