LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.control
Class LyCompoundAreaController

java.lang.Object
  extended by leon.control.LyController
      extended by leon.control.LyAreaController
          extended by leon.control.LyMultiAreaController
              extended by leon.control.LyCompoundAreaController
All Implemented Interfaces:
LyGetSessionInterface, LyContextInterface, LyGetActionInterface, LySelectFileListenerInterface, LyGuiListener, LyInfoListener, LyEvaluator, LyDemandListener
Direct Known Subclasses:
LyCompoundFilterController, LySelectController, LyXRefAreaController

public class LyCompoundAreaController
extends LyMultiAreaController

A compound area controller is associated to a compound action.

This controller is a view which gather two views controllers (subcontrollers) in the same 'area'.

The compoundAreaController provides the following services :


Field Summary
static java.lang.String __VERSION
          File version
 
Fields inherited from class leon.control.LyAreaController
DEFAULT_MENU_ITEM_IMAGE_SIZE, DEMAND_APPLY, DEMAND_CANCEL, DEMAND_CLOSE, DEMAND_CREATE_CHART, DEMAND_DELETE_CHART, DEMAND_DELETE_OBJECTINFOS, DEMAND_DELETE_PREFERENCE, DEMAND_UPDATE_VIEW, DEMAND_VALIDATE
 
Fields inherited from class leon.control.LyController
_nbControllers, _nextId, CONTROLLER_ID_SEP, DEFAULT_IMAGE_FORMAT, DEMAND_HELP, ID_SEP
 
Constructor Summary
LyCompoundAreaController(LySession session, LyController parent, LyAction action, LyClassInfo classInfo, LyObjectList context)
          Constructor.
 
Method Summary
 void actionDemand(LyActionDemand demand)
          Invoked when an action occurs.
 void free(LyController controller)
          Free this controller.
 LyAreaController getContextClient()
          Accessor to the area controller which is the client context for the other area controller.
 void reset(boolean full)
          Reset the entire view : everything is rebuilt.
 void setAction(LyAction action)
          Deprecated. Use setAction(LyAction, boolean)
 void setAction(LyAction action, boolean deleteOnClose)
          Change client context action (or second action if no action is used for context).
 void setAction(LyAction action, LyObjectList context, short index, boolean deleteOnClose)
          Change action at the given position.
 void setAction(LyAction action, short index)
          Deprecated. Use setAction(LyAction, short, boolean)
 void setAction(LyAction action, short index, boolean deleteOnClose)
          Change action at the given position.
 boolean setContext(LyWorkSpace context)
          Set current controller context.
 void setContextClient(LyAreaController controller)
          Accessor to set another area controller which will receive contextual notification when something occur on this area controller.
 
Methods inherited from class leon.control.LyMultiAreaController
addAreaController, addAreaControllerStack, canClose, clearViewCache, getAreaController, getAreaController, getAreaControllersCount, getAreaControllerStack, getAreaControllerStackCount, getFinalAreaControllers, getLastModified, isViewResizable, openSubAreaController, removeAreaController, removeAreaControllerStack, setIdle, setViewController, update
 
Methods inherited from class leon.control.LyAreaController
canFree, completeMenuBar, completeMessages, free, getAction, getAreaStackController, getBehavior, getBehaviorInterface, getBuilder, getClassInfo, getContent, getContext, getContextTitle, getDefaultAction, getEnvironment, getFastEditionAction, getHelpFile, getImage, getImageTooltip, getInfoLabel, getInfoLabel, getKeyValue, getLabel, getMenuItemImage, getName, getParameter, getParameter, getParameterMarks, getParent, getParent, getParentAreaController, getRefreshTime, getSelection, getShortLabel, getTarget, getTitle, getViewController, getViewController, hasMark, hasNotMark, hasViewController, hideView, infoEvent, initialize, isInitialized, isOutlined, menuDemand, reset, selectFileDemand, setContext, setPreference, showView, showView, testParameter, toString, updateTitleBar
 
Methods inherited from class leon.control.LyController
activateViewDemand, demandPerformed, dragDropDemand, getApplication, getClassInfo, getComponent, getId, getImage, getImage, getImage, getImage, getImageFromPrefix, getImageFromPrefix, getImageFromPrefix, getName, getObjectId, getSession, getUserData, getView, getViewManager, helpDemand, hideView, isFreed, isIdle, selectionDemand, setBuilder, setBuilderClass, setLastModified, setName, setUserData, showError, showError, showWarning, updateViewFromValues
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

__VERSION

public static final java.lang.String __VERSION
File version

See Also:
Constant Field Values
Constructor Detail

LyCompoundAreaController

public LyCompoundAreaController(LySession session,
                                LyController parent,
                                LyAction action,
                                LyClassInfo classInfo,
                                LyObjectList context)
Constructor.

Parameters:
session - current session associated to the controller. The controller automatically registers on the specified session.
parent - parent controller (or null for 'root' controller). Controller hierarchy indicates a child controller (for example a dialog created from a main view)
action - related action. The action should be an instance of LyCompoundAction. If an action is specified, the controller uses action parameters (action name, action specific XML view description ...)
classInfo - classInfo : useless in this controller, should be null. Kept for compatibility.
context - current context (may be null if the view is not contextual to a list of objects).
Method Detail

free

public void free(LyController controller)
Free this controller. Current implementation overrides generic method to free table of controllers.

Overrides:
free in class LyMultiAreaController
Parameters:
controller - controller instance which requested the freeing of this controller. If the controller is the parent, this controller is freed otherwise the method does nothing.
See Also:
LyAreaController.free()

reset

public void reset(boolean full)
Reset the entire view : everything is rebuilt.

Overrides:
reset in class LyAreaController
Parameters:
full - Boolean indicating if a full reset (including reset of datas) is requiered or not (only reset graphical area).

setContext

public boolean setContext(LyWorkSpace context)
Set current controller context. This method set the context of the sub AreaController Two possibilities: One of the subareas is a context for the other one, so this method set its context. Both Areas are "equal" so the context is set for both.

Specified by:
setContext in interface LyContextInterface
Overrides:
setContext in class LyMultiAreaController
Parameters:
context - context or null if none is specified
Returns:
true if successfull
See Also:
LyContextInterface.setContext(leon.data.LyWorkSpace)

getContextClient

public LyAreaController getContextClient()
Accessor to the area controller which is the client context for the other area controller.

Overrides:
getContextClient in class LyAreaController
Returns:
the area controller whose context is defined by the other area controller.

setContextClient

public void setContextClient(LyAreaController controller)
Accessor to set another area controller which will receive contextual notification when something occur on this area controller.

Method is overrident to take the internal sub-controller structure into account.

Overrides:
setContextClient in class LyMultiAreaController
Parameters:
controller - the contextual controller, or null if no client defined

setAction

public void setAction(LyAction action,
                      boolean deleteOnClose)
Change client context action (or second action if no action is used for context).

Overrides:
setAction in class LyMultiAreaController
Parameters:
action - New action added in compound area.
deleteOnClose - Delete controller when action is changed.

setAction

public final void setAction(LyAction action)
Deprecated. Use setAction(LyAction, boolean)

Change client context action (or second action if no action is used for context).

Parameters:
action - New action added in compound area.

setAction

public void setAction(LyAction action,
                      LyObjectList context,
                      short index,
                      boolean deleteOnClose)
Change action at the given position.

Parameters:
action - New action added in compound area.
context - The context of the new action.
index - Index of the replaced action.
deleteOnClose - Delete controller when action is changed.

setAction

public void setAction(LyAction action,
                      short index,
                      boolean deleteOnClose)
Change action at the given position.

Parameters:
action - New action added in compound area.
index - Index of the replaced action.
deleteOnClose - Delete controller when action is changed.

setAction

public final void setAction(LyAction action,
                            short index)
Deprecated. Use setAction(LyAction, short, boolean)

Change action at the given position.

Parameters:
action - New action added in compound area.
index - Index of the replaced action.

actionDemand

public void actionDemand(LyActionDemand demand)
Invoked when an action occurs. At this level, the implementation manages

Overrides:
actionDemand in class LyMultiAreaController
Parameters:
demand - demand parameters sent by the view component.
See Also:
LyController.demandPerformed(leon.view.event.LyDemand)

(c) January 2013 - W4 S.A.

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