LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.app.behaviorinterface
Interface LyDashboardBehaviorInterface

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

public interface LyDashboardBehaviorInterface
extends LyActionBehaviorInterface

This interface defines the methods to implement in order to modify the default behavior of a dashboard controller.

See Also:
LyDashboardController

Field Summary
static java.lang.String __VERSION
          File version
 
Method Summary
 LyTab buildTab(LyDashboardController dashboard, LyAreaController controller)
          Builds a tab for given area controller when the useTabs mode is active.
 void closeController(LyDashboardController dashboard, LyAreaController controller)
          Method called when a controller is closed in the dasboard panel.
 LyInfoList<LyAction> getActions(LyDashboardController dashboard, LyInfoList<LyAction> actions)
          Get the list of actions displayed in the dashboard.
 LyInfoList<LyClassInfo> getSearchClasses(LyDashboardController dashboard)
          Get the classes list to be displayed in search tool.
 boolean isFreedOnClose(LyDashboardController dashboard, LyAction action, LyViewController viewController)
          Indicates if the given sub view controller has to be freed when closed.
 boolean isFreedOnClose(LyDashboardController dashboard, LyViewController viewController)
          Deprecated. Use isFreedOnClose(LyDashboardController, LyAction, LyViewController) instead.
 void openController(LyDashboardController dashboard, LyAreaController controller)
          Method called when a new controller is (re)opened in the dasboard panel.
 boolean openNewView(LyDashboardController dashboard, LyAction action)
          Indicates if the given action has to be opened in a new view.
 
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

isFreedOnClose

boolean isFreedOnClose(LyDashboardController dashboard,
                       LyViewController viewController)
Deprecated. Use isFreedOnClose(LyDashboardController, LyAction, LyViewController) instead.

Indicates if the given sub view controller has to be freed when closed.

Parameters:
dashboard - Dashboard controller.
viewController - View controller.
Returns:
True if the given view controller is freed on closing, false otherwise.
See Also:
isFreedOnClose(LyDashboardController,LyAction,LyViewController)

isFreedOnClose

boolean isFreedOnClose(LyDashboardController dashboard,
                       LyAction action,
                       LyViewController viewController)
Indicates if the given sub view controller has to be freed when closed.

Parameters:
dashboard - Dashboard controller.
action - The action of the sub view controller.
viewController - View controller.
Returns:
True if the given view controller is freed on closing, false otherwise.

openNewView

boolean openNewView(LyDashboardController dashboard,
                    LyAction action)
Indicates if the given action has to be opened in a new view.

Parameters:
dashboard - Dashboard controller.
action - the action to be opened.
Returns:
True if the given action has to be opened in a new view, false otherwise.

openController

void openController(LyDashboardController dashboard,
                    LyAreaController controller)
Method called when a new controller is (re)opened in the dasboard panel.

Parameters:
dashboard - Dashboard controller.
controller - Area controller opened in the dashboard.

closeController

void closeController(LyDashboardController dashboard,
                     LyAreaController controller)
Method called when a controller is closed in the dasboard panel.

Parameters:
dashboard - Dashboard controller.
controller - Area controller closed in the dashboard.

buildTab

LyTab buildTab(LyDashboardController dashboard,
               LyAreaController controller)
Builds a tab for given area controller when the useTabs mode is active.

Parameters:
dashboard - Dashboard controller.
controller - Area controller opened in the dashboard.
Returns:
the newly created tab.

getActions

LyInfoList<LyAction> getActions(LyDashboardController dashboard,
                                LyInfoList<LyAction> actions)
Get the list of actions displayed in the dashboard.

Parameters:
dashboard - Dashboard controller.
actions - List of actions declared in the model. Can be null.
Returns:
the actions list of the dashboard.

getSearchClasses

LyInfoList<LyClassInfo> getSearchClasses(LyDashboardController dashboard)
Get the classes list to be displayed in search tool.

Parameters:
dashboard - The dashboard controller.
Returns:
the classes list used for search, null to let the controller do the job.

(c) January 2013 - W4 S.A.

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