LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.app.behaviorinterface
Interface LyTabActionBehaviorInterface

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

public interface LyTabActionBehaviorInterface
extends LyActionBehaviorInterface

Interface for the controller of tab actions.

See Also:
LyTabAreaController

Field Summary
static java.lang.String __VERSION
          File version
 
Method Summary
 void afterCommit(LyTabAreaController tabAreaController)
          Method called when Terminate is selected after committing actions done in wizard.
 boolean beforeCommit(LyTabAreaController tabAreaController)
          Method called when Terminate is selected before committing actions done in wizard.
 LyAreaController buildAreaController(LyTabAreaController tabAreaController, LyAction action)
          Builds area controller corresponding to the given action.
 void cancel(LyTabAreaController tabAreaController)
          Method called when Cancel is selected before cancelling actions done in wizard.
 boolean enableNext(LyTabAreaController tabAreaController, int index)
          This method is only used for tab actions with wizard type.
 boolean enableTerminate(LyTabAreaController tabAreaController, int index)
          This method is only used for tab actions with wizard type.
 java.lang.String[] getHrefColors(LyTabAreaController tabAreaController)
          Get the colors used for hyperlinks displayed in left panel of the wizard.
 java.lang.String getImage(LyTabAreaController tabAreaController, int index)
          Get image to display in left panel of the wizard.
 LyAction getNextAction(LyTabAreaController tabAreaController, int index)
          Get next action to be displayed in right panel of the wizard.
 java.lang.String[] getStepLabels(LyTabAreaController tabAreaController)
          Get labels to display in left panel of the wizard.
 void selectedTabChanged(LyTabAreaController tabAreaController, int selectedTab, LyAreaController selectedAreaController)
          Method called when a tab has been selected.
 
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

getStepLabels

java.lang.String[] getStepLabels(LyTabAreaController tabAreaController)
Get labels to display in left panel of the wizard. This method is only used for tab actions with wizard type.

Parameters:
tabAreaController - Controller of the tab action.
Returns:
A table of strings corresponding to labels, or null if no label is wanted.

getImage

java.lang.String getImage(LyTabAreaController tabAreaController,
                          int index)
Get image to display in left panel of the wizard. This method is only used for tab actions with wizard type.

Parameters:
tabAreaController - Controller of the tab action.
index - Index of the current step.
Returns:
A string that gives the name of the image to display.

getHrefColors

java.lang.String[] getHrefColors(LyTabAreaController tabAreaController)
Get the colors used for hyperlinks displayed in left panel of the wizard. This method is only used for tab actions with wizard type.

Parameters:
tabAreaController - Controller of the tab action.
Returns:
An array of strings that gives the colors for hyperlinks, highlighted hyperlinks, visited hyperlinks and disabled hyperlinks.

getNextAction

LyAction getNextAction(LyTabAreaController tabAreaController,
                       int index)
Get next action to be displayed in right panel of the wizard. This method is only used for tab actions with wizard type and is called when next button is selected the first time the step is reached.

Parameters:
tabAreaController - Controller of the tab action.
index - Index of the current step.
Returns:
The next action to be displayed.

buildAreaController

LyAreaController buildAreaController(LyTabAreaController tabAreaController,
                                     LyAction action)
Builds area controller corresponding to the given action. This method is only used for tab actions with wizard type.

Parameters:
tabAreaController - Controller of the tab action.
action - Action for which a controller is requested.
Returns:
The desired area controller, if null is returned the tabAreaController will construct it.

enableNext

boolean enableNext(LyTabAreaController tabAreaController,
                   int index)
This method is only used for tab actions with wizard type.

Parameters:
tabAreaController - Controller of the tab action.
index - Index of the current step.
Returns:
A boolean indicating if the Next button is enabled or not.

enableTerminate

boolean enableTerminate(LyTabAreaController tabAreaController,
                        int index)
This method is only used for tab actions with wizard type.

Parameters:
tabAreaController - Controller of the tab action.
index - Index of the current step.
Returns:
A boolean indicating if the Terminate button is enabled or not.

beforeCommit

boolean beforeCommit(LyTabAreaController tabAreaController)
Method called when Terminate is selected before committing actions done in wizard. This method is only used for tab actions with wizard type.

Parameters:
tabAreaController - Controller of the tab action.
Returns:
A boolean indicating if the commit can be done.

afterCommit

void afterCommit(LyTabAreaController tabAreaController)
Method called when Terminate is selected after committing actions done in wizard. This method is only used for tab actions with wizard type.

Parameters:
tabAreaController - Controller of the tab action.

cancel

void cancel(LyTabAreaController tabAreaController)
Method called when Cancel is selected before cancelling actions done in wizard. This method is only used for tab actions with wizard type.

Parameters:
tabAreaController - Controller of the tab action.

selectedTabChanged

void selectedTabChanged(LyTabAreaController tabAreaController,
                        int selectedTab,
                        LyAreaController selectedAreaController)
Method called when a tab has been selected.

Parameters:
tabAreaController - the tab action controller
selectedTab - the index of the selected tab
selectedAreaController - the controller of the selected tab action

(c) January 2013 - W4 S.A.

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