LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.app.behavior
Class LyTabActionBehavior

java.lang.Object
  extended by leon.app.behavior.LyBehavior
      extended by leon.app.behavior.LyActionBehavior
          extended by leon.app.behavior.LyTabActionBehavior
All Implemented Interfaces:
LyActionBehaviorInterface, LyBehaviorInterface, LyTabActionBehaviorInterface, LyGetSessionInterface

public class LyTabActionBehavior
extends LyActionBehavior
implements LyTabActionBehaviorInterface

This class implements the default behavior for tab actions.


Field Summary
static java.lang.String __VERSION
          File version
 
Constructor Summary
LyTabActionBehavior()
          Construct a tab action behavior.
 
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 class leon.app.behavior.LyActionBehavior
endAction, getClientContext, getContextTitle, getHelpFile, getImage, getImageTooltip, getKeyValue, getMenuItemImage, getTitle, reset, startAction
 
Methods inherited from class leon.app.behavior.LyBehavior
free, getSession, handleDemand, init
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
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

public static final java.lang.String __VERSION
File version

See Also:
Constant Field Values
Constructor Detail

LyTabActionBehavior

public LyTabActionBehavior()
Construct a tab action behavior.

Method Detail

getStepLabels

public 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.

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

getImage

public 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.

Specified by:
getImage in interface LyTabActionBehaviorInterface
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

public 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.

Specified by:
getHrefColors in interface LyTabActionBehaviorInterface
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

public 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.

Specified by:
getNextAction in interface LyTabActionBehaviorInterface
Parameters:
tabAreaController - Controller of the tab action.
index - Index of the current step.
Returns:
The next action to be displayed.

buildAreaController

public 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.

Specified by:
buildAreaController in interface LyTabActionBehaviorInterface
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

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

Specified by:
enableNext in interface LyTabActionBehaviorInterface
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

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

Specified by:
enableTerminate in interface LyTabActionBehaviorInterface
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

public 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.

Specified by:
beforeCommit in interface LyTabActionBehaviorInterface
Parameters:
tabAreaController - Controller of the tab action.
Returns:
A boolean indicating if the commit can be done.

afterCommit

public 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.

Specified by:
afterCommit in interface LyTabActionBehaviorInterface
Parameters:
tabAreaController - Controller of the tab action.

cancel

public 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.

Specified by:
cancel in interface LyTabActionBehaviorInterface
Parameters:
tabAreaController - Controller of the tab action.

selectedTabChanged

public void selectedTabChanged(LyTabAreaController tabAreaController,
                               int selectedTab,
                               LyAreaController selectedAreaController)
Method called when a tab has been selected.
The default implementation does nothing.

Specified by:
selectedTabChanged in interface LyTabActionBehaviorInterface
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