|
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
leon.control.LyTabAreaController
public class LyTabAreaController
A tab area controller is associated to a tab action.
This controller is a view which gather two views controllers (subcontrollers) in the same 'area'.
The tabAreaController provides the following services :
Field Summary | |
---|---|
static java.lang.String |
__VERSION
File Version |
static java.lang.String |
DEMAND_NEXT
Demand code : Next step. |
static java.lang.String |
DEMAND_PREVIOUS
Demand code : Previous step. |
static java.lang.String |
DEMAND_TERMINATE
Demand code : Terminate wizard process. |
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 | |
---|---|
LyTabAreaController(LySession session,
LyController parent,
LyAction action,
LyClassInfo classInfo,
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 |
addTabAction(LyAreaController areaController)
Adds a new action to this tab action. |
void |
cancel()
Method called when the form is cancelled. |
boolean |
canClose(boolean showMessage)
Check if the area controller may be closed. |
void |
closeAction(LyAction action)
Closes an action registered on the tab controller. |
void |
closeAll()
Closes all tabs. |
void |
commit()
Method called when all modifications are committed. |
void |
free(LyController controller)
Free this controller. |
LyAreaController |
getAreaController(LyAction action,
boolean searchHidden)
Accessor to the sub-controllers with the specified action. |
java.lang.Class<?> |
getBehaviorInterface()
Method that gives the interface that must be implemented by the behavior associated to this controller. |
LyClassInfo |
getClassInfo()
Get controller class info if any. |
LyContext |
getControllerContext()
Gets the controller context. |
java.lang.String |
getHelpFile()
Gets help file associated with this controller. |
LyAreaController |
getSelectedAreaController()
Get the selected LyAreaController |
int |
getSelectedTab()
Get the index of the selected tab |
LyObjectList |
getSelection()
Return list of selected objects This method is overriden depending on the nature of the controller. |
LyEnvironment |
getWizardFormEnvironment()
Returns the specific environment used for wizard form. |
boolean |
isWizard()
Checks if the managed action is a wizard action. |
void |
questionAnswer(boolean result,
java.lang.Object clientData)
Answer to a askQuestion request. |
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 |
reset(boolean full)
Reset the entire view : everything is rebuilt. |
void |
selectAction(LyAction action)
Selects an action registered on the tab 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. |
boolean |
update()
This method is called by the view controller when this area is shown to update its content. |
void |
updateCommands()
Updates command bar for wizard mode. |
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
public static final java.lang.String DEMAND_PREVIOUS
public static final java.lang.String DEMAND_NEXT
public static final java.lang.String DEMAND_TERMINATE
Constructor Detail |
---|
public LyTabAreaController(LySession session, LyController parent, LyAction action, LyClassInfo classInfo, 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 LyTabAction. 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 |
---|
public LyClassInfo getClassInfo()
getClassInfo
in class LyAreaController
public void actionDemand(LyActionDemand demand)
actionDemand
in class LyMultiAreaController
demand
- demand parameters sent by the view component.LyController.demandPerformed(leon.view.event.LyDemand)
public void addTabAction(LyAreaController areaController)
areaController
- the area controller managing the action that must be added.public void selectAction(LyAction action)
action
- the action that must be selected.public void closeAll()
public void closeAction(LyAction action)
action
- the action that must be closed.public int getSelectedTab()
public LyAreaController getSelectedAreaController()
public java.lang.String getHelpFile()
getHelpFile
in class LyAreaController
public LyEnvironment getWizardFormEnvironment()
_wizardFormEnvironment
attribute.public void setContextClient(LyAreaController controller)
Method is overriden to take the internal sub-controller structure into account.
setContextClient
in class LyMultiAreaController
controller
- the contextual controller, or null if no client definedpublic void reset(boolean full)
reset
in class LyAreaController
full
- Boolean indicating if a full reset (including reset of datas) is requiered or not
(only reset graphical area).public boolean update()
update
in class LyMultiAreaController
public void updateCommands()
public java.lang.Class<?> getBehaviorInterface()
getBehaviorInterface
in class LyAreaController
public LyContext getControllerContext()
getControllerContext
in interface LyControllerContextInterface
LyControllerContextInterface.getControllerContext()
public void commit()
public void cancel()
public void free(LyController controller)
free
in class LyMultiAreaController
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.LyMultiAreaController.free(LyController)
public LyObjectList getSelection()
getSelection
in class LyAreaController
public boolean isWizard()
public boolean canClose(boolean showMessage)
canClose
in class LyMultiAreaController
showMessage
- indicates if the controller can show an warning message or not
public void questionAnswer(boolean result, java.lang.Object clientData)
questionAnswer
in interface LyQuestionAnswerInterface
result
- true if the user has clicked on Yes or OkclientData
- data specified in the askQuestion methodLyQuestionAnswerInterface.questionAnswer(boolean, java.lang.Object)
public void addAreaController(LyAreaController areaController)
addAreaController
in class LyMultiAreaController
areaController
- the new controller we want to add.public void removeAreaController(LyAreaController areaController)
removeAreaController
in class LyMultiAreaController
areaController
- the new controller we want to remove.public LyAreaController getAreaController(LyAction action, boolean searchHidden)
action
- specified action whose controller must be returned.searchHidden
- search also in hidden tabs (kept for LY_FREE_ON_CLOSE)
public boolean setContext(LyWorkSpace context)
setContext
in interface LyContextInterface
setContext
in class LyMultiAreaController
context
- current context or null if none is specified
LyContextInterface.setContext(leon.data.LyWorkSpace)
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |