LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.app.behaviorinterface
Interface LyActionBehaviorInterface

All Superinterfaces:
LyBehaviorInterface
All Known Subinterfaces:
LyCanvasBehaviorInterface, LyChartBehaviorInterface, LyClassBehaviorInterface, LyConsultBehaviorInterface, LyCreateBehaviorInterface, LyDashboardBehaviorInterface, LyDeleteBehaviorInterface, LyEditTableBehaviorInterface, LyExportBehaviorInterface, LyFormBehaviorInterface, LyHiddenObjectsBehaviorInterface, LyImportBehaviorInterface, LyImportTableBehaviorInterface, LyLoginBehaviorInterface, LyMailBehaviorInterface, LyOutlineBehaviorInterface, LyPanelBehaviorInterface, LyPasswordBehaviorInterface, LyPrintBehaviorInterface, LySetBehaviorInterface, LyShowUrlBehaviorInterface, LyTabActionBehaviorInterface, LyTableBehaviorInterface, LyTextBehaviorInterface, LyTreeBaseBehaviorInterface, LyTreeBehaviorInterface, LyUserInputBehaviorInterface, LyWaitBehaviorInterface, LyWebServicesBehaviorInterface
All Known Implementing Classes:
LyActionBehavior, LyCanvasBehavior, LyChangePhotoBehavior, LyChartBehavior, LyChatBehavior, LyClassBehavior, LyCommonServiceBehavior, LyDashboardBehavior, LyEditTableBehavior, LyExportBehavior, LyFindBehavior, LyHiddenObjectsBehavior, LyImportBehavior, LyImportTableBehavior, LyLoginBehavior, LyMailBehavior, LyMessageBehavior, LyMetricsChartBehavior, LyMetricsPanelBehavior, LyPanelBehavior, LyPasswordBehavior, LyPrintBehavior, LyPrintModelBehavior, LySendFileBehavior, LySendObjectBehavior, LyShareSessionBehavior, LyShowUrlBehavior, LySocialBehavior, LySortWizardBehavior, LyTabActionBehavior, LyTableBehavior, LyTextBehavior, LyTreeBehavior, LyUserInputBehavior, LyWaitBehavior, LyWebServiceBehavior

public interface LyActionBehaviorInterface
extends LyBehaviorInterface

Generic interface for all behaviors that applies on action.

See Also:
LyAreaController

Field Summary
static java.lang.String __VERSION
          File version
 
Method Summary
 boolean endAction(LyAreaController areaController, LyAction action)
          Ends an action for the given controller.
 LyObjectList getClientContext(LyAreaController areaController, LyObjectList context)
          Gets context to set on the controllers that have the given area controller as context.
 java.lang.String getContextTitle(LyAreaController areaController, LyAction action, LyObjectList context)
          Gets title corresponding to the given action and context (sub-title displayed on the right of the titlebar).
 java.lang.String getHelpFile(LyAreaController areaController, LyAction action)
          Gets help file for the given action.
 java.lang.String getImage(LyAreaController areaController, LyAction action)
          Gets the image corresponding to the given object for the given controller.
 java.lang.String getImageTooltip(LyAreaController areaController, LyAction action)
          Gets image tooltip corresponding to the given action.
 java.lang.Object getKeyValue(java.lang.String key)
          Retrieves a value from a registered key.
 java.lang.String getMenuItemImage(LyAreaController areaController, LyAction action)
          Gets the menu image corresponding to the given action for the given controller.
 java.lang.String getTitle(LyAreaController areaController, LyAction action)
          Gets title corresponding to the given action.
 boolean reset(LyAreaController areaController, boolean full)
          The controller resets its content.
 boolean startAction(LyAreaController areaController, LyAction action)
          Starts an action for the given controller.
 
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

startAction

boolean startAction(LyAreaController areaController,
                    LyAction action)
Starts an action for the given controller. This method is the right place to allocate specific resources requiered for the given action.

Parameters:
areaController - the current LyAreaController instance
action - the action that will be executed
Returns:
true if the action starts correctly, false otherwise.

reset

boolean reset(LyAreaController areaController,
              boolean full)
The controller resets its content. This method is the right place to add extra processing when the view is set.

Parameters:
areaController - the current LyAreaController instance
full - indicates if the controller performed a full reset of its content or a partial reset. The meaning of a full reset depends on controller implementation.
Returns:
true if the action starts correctly, false otherwise.

endAction

boolean endAction(LyAreaController areaController,
                  LyAction action)
Ends an action for the given controller. This method is the right place to free specific resources allocated for the given action.

Parameters:
areaController - the current LyAreaController instance
action - the action that was executed
Returns:
true if the action performed correctly, false otherwise

getImage

java.lang.String getImage(LyAreaController areaController,
                          LyAction action)
Gets the image corresponding to the given object for the given controller. This image is mostly used in titlebar.

Parameters:
areaController - controller for which the image is required.
action - the action that was executed
Returns:
Logical name of the image for the given action or null to let controller do the job. The string "_null" means no image.

getImageTooltip

java.lang.String getImageTooltip(LyAreaController areaController,
                                 LyAction action)
Gets image tooltip corresponding to the given action.

Parameters:
areaController - the current LyAreaController instance
action - the action that was executed
Returns:
image tooltip for the given action.

getMenuItemImage

java.lang.String getMenuItemImage(LyAreaController areaController,
                                  LyAction action)
Gets the menu image corresponding to the given action for the given controller.

Parameters:
areaController - The controller for which the image is required.
action - The action for which the image is required
Returns:
Logical name of the image for the given action or null to let controller do the job. The string "_null" means no image.

getTitle

java.lang.String getTitle(LyAreaController areaController,
                          LyAction action)
Gets title corresponding to the given action.

Parameters:
areaController - the current LyAreaController instance
action - the action that was executed
Returns:
Title for the given action or null to let controller do the job.

getContextTitle

java.lang.String getContextTitle(LyAreaController areaController,
                                 LyAction action,
                                 LyObjectList context)
Gets title corresponding to the given action and context (sub-title displayed on the right of the titlebar).

Parameters:
areaController - the current controller instance
action - the action that was executed
context - the action context
Returns:
Context title for the given action or null to let controller do the job.

getHelpFile

java.lang.String getHelpFile(LyAreaController areaController,
                             LyAction action)
Gets help file for the given action.

Parameters:
areaController - the current controller instance
action - the action that was executed
Returns:
Help file for the given action or null to let controller do the job.

getClientContext

LyObjectList getClientContext(LyAreaController areaController,
                              LyObjectList context)
Gets context to set on the controllers that have the given area controller as context.

Parameters:
areaController - the current controller instance.
context - the context that is about to be set.
Returns:
The desired client context.

getKeyValue

java.lang.Object getKeyValue(java.lang.String key)
Retrieves a value from a registered key.

Parameters:
key - The key that must be used.
Returns:
The value stored with the key or null if the key is not registered.

(c) January 2013 - W4 S.A.

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