|
LEONARDI Application Composer - 8.9.0.40 by W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LySessionBehaviorInterface
This interface defines the methods to implement in order to change the default behavior of a session.
LySession
Field Summary | |
---|---|
static java.lang.String |
__VERSION
File version |
Method Summary | |
---|---|
java.lang.String |
checkControllerId(LyController controller,
java.lang.String id)
Method to compute id of the given controller. |
void |
close(LySession session)
Method called when a session is closed. |
void |
controllerAdded(LySession session,
LyController controller)
Method called when a controller is added to the session. |
void |
controllerRemoved(LySession session,
LyController controller)
Method called when a controller is removed from the session. |
boolean |
enableAction(LySession session,
LyAction action,
LyController controller,
LyObjectList objects,
boolean showError)
Enables the given action on the given list of objects for the given controller. |
boolean |
enableTransverseAction(LySession session,
LyAction action,
LyClassInfo classInfo,
LyController controller,
LyObjectList objects,
boolean showError)
Enables the given transverse action on the given list of objects for the given controller. |
void |
exit(LySession session)
Method called when the user ask to quit the given session. |
LyController |
findExistingController(LySession session,
LyController parent,
LyAction action,
LyClassInfo classInfo,
LyObjectList objects,
boolean recurseAllSessions)
Searches for an existing controller being shown, and return it if found. |
java.lang.String |
getHelpFile(LySession session,
LyController controller,
LyAction action)
Get an help file for the given session, the given controller and the given action. |
LyAction |
getRootAction(LySession session)
Gets root action for this session. |
LyController |
getRootContextController(LySession session)
Get a root level context controller. |
int |
getSessionTimeout(LySession session)
Gets the session time out for the current session. |
boolean |
handleDemand(LySession session,
LyController controller,
LyDemand demand)
Invoked when a demand is sent to a listener of this session. |
LyController |
invokeAction(LySession session,
LyController order,
LyAction action,
LyClassInfo classInfo,
LyObjectList objects,
boolean show)
Invoke an action. |
boolean |
invokeExtraAction(LySession session,
LyController order,
LyAction action,
LyClassInfo classInfo,
LyObjectList objects,
boolean show)
Invoke an action that has no controller. |
LyInfoList<LyInfo> |
loadUserPreferences(LySession session,
java.lang.String userId)
Load session preferences. |
LyInfoList<LyInfo> |
loadUserStickers(LySession session,
java.lang.String userId)
Load session stickers. |
void |
sessionTimeout(LySession session)
Method invoked when a session is in time out. |
void |
showAbout(LySession session,
LyController parent)
Method invoked when the user ask for the 'about' action. |
void |
showHelp(LySession session,
LyController parent)
Method invoked when the user ask for the 'help' action. |
void |
showLog(LySession session,
LyController controler)
Method invoked when the user ask for the 'log' action. |
void |
showVersion(LySession session,
LyController parent)
Method invoked when the user ask for the 'version' action. |
void |
start(LySession session)
Method called when a session is started. |
boolean |
validateAction(LySession session,
LyAction action,
LyController controller)
Validates the given action for the given controller. |
void |
viewControllerHidden(LySession session,
LyViewController viewController)
Method called when a view controller is hidden within the given session. |
void |
viewControllerShown(LySession session,
LyViewController viewController)
Method called when a view controller is shown within the given session. |
Methods inherited from interface leon.app.behaviorinterface.LyDataSessionBehaviorInterface |
---|
close, connectionLost, controlBeforeCommit, free, getDefaultUnitForField, getKeyValue, getUser, handleException, start, updateUndoRedo |
Field Detail |
---|
static final java.lang.String __VERSION
Method Detail |
---|
void start(LySession session)
session
- the started session.LyInfoList<LyInfo> loadUserPreferences(LySession session, java.lang.String userId)
session
- Session on which preferences are loaded.userId
- Id of the session user.
LyInfoList<LyInfo> loadUserStickers(LySession session, java.lang.String userId)
session
- Session on which stickers are loaded.userId
- Id of the session user.
void close(LySession session)
session
- the closed session.LyAction getRootAction(LySession session)
session
- current session.
void exit(LySession session)
session
- Session to exit fromjava.lang.String checkControllerId(LyController controller, java.lang.String id)
controller
- The new controller.id
- Desired id.
void controllerAdded(LySession session, LyController controller)
session
- Session in which a controller is added.controller
- Controller added to the session.void controllerRemoved(LySession session, LyController controller)
session
- Session in which a controller is removed.controller
- Controller removed from the session.void viewControllerShown(LySession session, LyViewController viewController)
session
- the sessionviewController
- The view controller that is shown.void viewControllerHidden(LySession session, LyViewController viewController)
session
- the sessionviewController
- The view controller that is hidden.boolean validateAction(LySession session, LyAction action, LyController controller)
session
- the current sessionaction
- the action to validatecontroller
- the controller for this action
boolean enableAction(LySession session, LyAction action, LyController controller, LyObjectList objects, boolean showError)
session
- the current sessionaction
- the action to enablecontroller
- the controller for this actionobjects
- list of objects on which the action has to be enabledshowError
- report an error if the action is not enabled
boolean enableTransverseAction(LySession session, LyAction action, LyClassInfo classInfo, LyController controller, LyObjectList objects, boolean showError)
session
- the current sessionaction
- the action to enableclassInfo
- the classInfo for which the action is checkedcontroller
- the controller for this actionobjects
- list of objects on which the action has to be enabledshowError
- report an error if the action is not enabled
boolean invokeExtraAction(LySession session, LyController order, LyAction action, LyClassInfo classInfo, LyObjectList objects, boolean show)
session
- the current sessionorder
- the source controlleraction
- the action to executeclassInfo
- class on which the action appliesobjects
- list of objects on which the action appliesshow
- indicates if the action must be shown or not
LyController invokeAction(LySession session, LyController order, LyAction action, LyClassInfo classInfo, LyObjectList objects, boolean show)
session
- the current sessionorder
- the source controlleraction
- the action to executeclassInfo
- class on which the action appliesobjects
- list of objects on which the action appliesshow
- indicates if the action must be shown or not
int getSessionTimeout(LySession session)
session
- the current session
void sessionTimeout(LySession session)
session
- the current sessionLyController getRootContextController(LySession session)
session
- the session
void showAbout(LySession session, LyController parent)
session
- the current sessionparent
- the parent controllervoid showLog(LySession session, LyController controler)
session
- the current sessioncontroler
- the parent controllervoid showVersion(LySession session, LyController parent)
session
- the current sessionparent
- the parent controllervoid showHelp(LySession session, LyController parent)
session
- the current sessionparent
- the parent controllerboolean handleDemand(LySession session, LyController controller, LyDemand demand)
session
- the current sessioncontroller
- controller that routed the demand.demand
- demand parameters sent by the view component.
LyController findExistingController(LySession session, LyController parent, LyAction action, LyClassInfo classInfo, LyObjectList objects, boolean recurseAllSessions)
session
- the current sessionparent
- The source controller.action
- The action to execute.classInfo
- The class on which the action applies.objects
- The list of objects on which the action applies.recurseAllSessions
- indicates if we recurse deeped into all sessions
LySessionBehavior.invokeAction(leon.app.LySession, leon.control.LyController, leon.info.LyAction, leon.info.LyClassInfo, leon.data.LyObjectList, boolean)
java.lang.String getHelpFile(LySession session, LyController controller, LyAction action)
session
- the current session.controller
- the controller of the action.action
- the action for which the helpfile is required.
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |