|
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 |
java.lang.Objectleon.control.LyController
leon.control.LyAreaController
leon.control.LyMultiAreaController
public abstract class 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 | |
---|---|
LyMultiAreaController(LySession session,
LyController parent,
LyAction action,
LyObjectList context)
Constructor. |
Method Summary | |
---|---|
void |
actionDemand(LyActionDemand demand)
Invoked when an action occurs. |
void |
addAreaController(LyAreaController areaController)
Append a new sub-controllers at the children list This method should not be used directly, use action description instead (LyMultiAction). |
void |
addAreaControllerStack(LyAreaController areaController)
Append a new sub-controllers at the stack list. |
boolean |
canClose(boolean showMessage)
Check if the area controller may be closed. |
void |
clearViewCache()
Clears all cached data for this controller (especially the view and the component). |
void |
free(LyController controller)
Free this controller. |
LyAreaController |
getAreaController(int index)
Accessor to the sub-controllers at the specified index. |
LyAreaController |
getAreaController(LyAction action)
Accessor to the sub-controllers with the specified action. |
int |
getAreaControllersCount()
Accessor to the number of sub-controllers. |
LyAreaController |
getAreaControllerStack(int index)
Accessor to the sub-controllers in the stack at the specified index. |
int |
getAreaControllerStackCount()
Accessor to the number of sub-controllers in the stack. |
java.util.Vector<LyController> |
getFinalAreaControllers()
Accessor to all the sub-controllers that are not instances of LyMultiAreaController. |
long |
getLastModified()
Accessor to the last modification date of this controller. |
boolean |
isViewResizable()
Indicates if the view for this compound controller is resizable. |
void |
openSubAreaController(LyAreaController areaController,
boolean open)
Opens a sub-area controller and updates the state of the view. |
void |
removeAreaController(LyAreaController areaController)
Remove a sub-controllers at the children list This method should not be used directly, use action description instead (LyMultiAction). |
void |
removeAreaControllerStack(LyAreaController areaController)
Remove a sub-controllers at the stack list. |
void |
setAction(LyAction action,
boolean deleteOnClose)
Change the main action for this controller. |
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. |
void |
setIdle(boolean idle)
Sets idle mode on this controller. |
void |
setViewController(LyViewController viewController)
Accessor to the view controller of the area. |
boolean |
update()
This method is called by the view controller when this area is shown to update its content. |
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 |
---|
public static final java.lang.String __VERSION
Constructor Detail |
---|
public LyMultiAreaController(LySession session, LyController parent, LyAction action, LyObjectList context)
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 LyMultiAction. If an
action is specified, the controller uses action parameters (action name,
action specific XML view description ...)context
- current context (may be null if the view is not contextual to a list of
objects).Method Detail |
---|
public boolean setContext(LyWorkSpace context)
setContext
in interface LyContextInterface
setContext
in class LyAreaController
context
- current context or null if none is specified
LyContextInterface.setContext(leon.data.LyWorkSpace)
public void setContextClient(LyAreaController controller)
Method is overrident to take the internal sub-controller structure into account.
setContextClient
in class LyAreaController
controller
- the contextual controller, or null if no client definedpublic void actionDemand(LyActionDemand demand)
actionDemand
in class LyAreaController
demand
- demand parameters sent by the view component.LyController.demandPerformed(leon.view.event.LyDemand)
public int getAreaControllersCount()
public LyAreaController getAreaController(int index)
index
- specified index, from >=0 and < getAreaControllersCount()
public int getAreaControllerStackCount()
public LyAreaController getAreaControllerStack(int index)
index
- specified index, from >=0 and < getAreaControllerStackCount()
public LyAreaController getAreaController(LyAction action)
action
- specified action whose controller must be returned.
public void addAreaController(LyAreaController areaController)
areaController
- the new controller we want to add.public void removeAreaController(LyAreaController areaController)
areaController
- the new controller we want to remove.public void addAreaControllerStack(LyAreaController areaController)
areaController
- the new controller we want to add in the stack.public void removeAreaControllerStack(LyAreaController areaController)
areaController
- the new controller we want to remove from the stack.public void setViewController(LyViewController viewController)
setViewController
in class LyAreaController
viewController
- the controller which manages the parent frame / dialogpublic void setAction(LyAction action, boolean deleteOnClose)
action
- New main action.deleteOnClose
- Delete controller when action is changed.public void openSubAreaController(LyAreaController areaController, boolean open)
areaController
- areaController opened from current form controller.open
- indicates whether areaController opened from current form controller is
opening or closing.public void free(LyController controller)
free
in class LyAreaController
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.LyAreaController.free()
public boolean canClose(boolean showMessage)
canClose
in class LyAreaController
showMessage
- indicates if the controller can show an warning message or not
public long getLastModified()
getLastModified
in class LyAreaController
public void clearViewCache()
This method may be invoked for memory optimization, but the controller is still valid and may be used. (Unlike free) Further usage, needs to rebuild internal component & view which may be time consuming.
clearViewCache
in class LyAreaController
public boolean isViewResizable()
isViewResizable
in class LyAreaController
public java.util.Vector<LyController> getFinalAreaControllers()
public boolean update()
update
in class LyAreaController
public void setIdle(boolean idle)
setIdle
in class LyAreaController
idle
- the idle status
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |