LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.app.behaviorinterface
Interface LyTreeBehaviorInterface

All Superinterfaces:
LyActionBehaviorInterface, LyBehaviorInterface, LyPanelBehaviorInterface, LyTreeBaseBehaviorInterface
All Known Implementing Classes:
LyTreeBehavior

public interface LyTreeBehaviorInterface
extends LyTreeBaseBehaviorInterface

This interface defines the methods to implement in order to modify the default behavior of a tree controller.

See Also:
LyTreeController

Field Summary
static java.lang.String __VERSION
          File version
 
Method Summary
 LyInfoList<LyClassInfo> getClassInfos(LyTreeController controller)
          Gets the list of all classInfos that can be found in the tree.
 LyInfoDataList<LyAction,LyClassInfo> getExtraPopupMenuActions(LyTreeController treeController, LyInfoDataList<LyAction,LyClassInfo> actions, LyClassInfo classInfo, LyInfoList<LyClassInfo> sons)
          Gets the ordered list of pairs of (action, classInfo) to display in popup menu.
 LyFilter getFilter(LyTreeController controller, java.lang.String level)
          Gets the filter used in the tree for the given level.
 LyObjectList getParents(java.lang.Object nodeObject, LyTreeController controller)
          Gets the given node parent objects list.
 LyObjectList getSons(LyObject parentNodeObject, LyTreeNode treeNode, java.lang.String level, LyTreeController controller)
          Gets all children objects of the given parent.
 LyObjectList getSons(LyObject parentNodeObject, java.lang.String level, LyTreeController controller)
          Deprecated. Since V3.3, use getSons(LyObject, String, LyTreeController).
 LyInfoList<LyClassInfo> getSonsClassInfos(LyClassInfo parentClassInfo, java.lang.String parentLevel, LyTreeController controller)
          Gets the list of classInfo that represent the possibles children of the given classInfo at the given level.
 LySort getSort(LyTreeController controller, java.lang.String level)
          Gets the sort used in the tree for the given level.
 LyObjectList getTreeSons(java.lang.Object parentNodeObject, LyInfoList<LyClassInfo> classInfos, LyTreeController controller)
          Deprecated. use getSons(LyObject, String, LyTreeController)
 boolean isSorted(LyTreeController controller)
          Indicates if data in the tree are sorted or not.
 void selectionChanged(LyTreeController controller)
          Method invoked when the selection has changed in the tree view.
 
Methods inherited from interface leon.app.behaviorinterface.LyTreeBaseBehaviorInterface
buildTreeNode, dragFinished, dragStart, drop, getTreeRootObject, updateTreeNode, validityModified
 
Methods inherited from interface leon.app.behaviorinterface.LyPanelBehaviorInterface
completePopupMenu, getPopupMenuActions, needRefresh, validateFilter
 
Methods inherited from interface leon.app.behaviorinterface.LyActionBehaviorInterface
endAction, getClientContext, getContextTitle, getHelpFile, getImage, getImageTooltip, getKeyValue, getMenuItemImage, getTitle, reset, startAction
 
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

isSorted

boolean isSorted(LyTreeController controller)
Indicates if data in the tree are sorted or not.

Parameters:
controller - current Tree Controller
Returns:
true if the tree must be sorted false otherwise

getTreeSons

LyObjectList getTreeSons(java.lang.Object parentNodeObject,
                         LyInfoList<LyClassInfo> classInfos,
                         LyTreeController controller)
Deprecated. use getSons(LyObject, String, LyTreeController)

Gets children of the given parent node.

Parameters:
parentNodeObject - parent of the requested objects.
classInfos - target (only for data tree)
controller - current LyTreeController instance
Returns:
the list of children objects, or null if the subtree is empty
See Also:
getSons(LyObject, String, LyTreeController)

getSons

LyObjectList getSons(LyObject parentNodeObject,
                     java.lang.String level,
                     LyTreeController controller)
Deprecated. Since V3.3, use getSons(LyObject, String, LyTreeController).

Gets all children objects of the given parent. A null parent object is considered as the root node.

Parameters:
parentNodeObject - parent of the requested objects.
level - the current level of the tree, as declared in the metamodel
controller - the current tree controller
Returns:
the list of children objects, or null if the subtree is empty

getSons

LyObjectList getSons(LyObject parentNodeObject,
                     LyTreeNode treeNode,
                     java.lang.String level,
                     LyTreeController controller)
Gets all children objects of the given parent. A null parent object is considered as the root node.

Parameters:
parentNodeObject - parent of the requested objects.
treeNode - the current tree node associated to given object
level - the current level of the tree, as declared in the metamodel
controller - the current tree controller
Returns:
the list of children objects, or null if the subtree is empty

getParents

LyObjectList getParents(java.lang.Object nodeObject,
                        LyTreeController controller)
Gets the given node parent objects list.

Parameters:
nodeObject - the node object
controller - current LyTreeController instance
Returns:
the list of possible given node parents or null if the only parent is the root

getSonsClassInfos

LyInfoList<LyClassInfo> getSonsClassInfos(LyClassInfo parentClassInfo,
                                          java.lang.String parentLevel,
                                          LyTreeController controller)
Gets the list of classInfo that represent the possibles children of the given classInfo at the given level.

Parameters:
parentClassInfo - the classInfo of the parent
parentLevel - the current level of the parent
controller - the current tree controller
Returns:
a list of classInfo

getClassInfos

LyInfoList<LyClassInfo> getClassInfos(LyTreeController controller)
Gets the list of all classInfos that can be found in the tree.

Parameters:
controller - the current tree controller
Returns:
the list of classInfo

selectionChanged

void selectionChanged(LyTreeController controller)
Method invoked when the selection has changed in the tree view.

Parameters:
controller - the current tree controller

getSort

LySort getSort(LyTreeController controller,
               java.lang.String level)
Gets the sort used in the tree for the given level.

Parameters:
controller - the current tree controller
level - the current level on tree
Returns:
the found sort

getFilter

LyFilter getFilter(LyTreeController controller,
                   java.lang.String level)
Gets the filter used in the tree for the given level.

Parameters:
controller - the current tree controller
level - the current level on tree
Returns:
the found filter

getExtraPopupMenuActions

LyInfoDataList<LyAction,LyClassInfo> getExtraPopupMenuActions(LyTreeController treeController,
                                                              LyInfoDataList<LyAction,LyClassInfo> actions,
                                                              LyClassInfo classInfo,
                                                              LyInfoList<LyClassInfo> sons)
Gets the ordered list of pairs of (action, classInfo) to display in popup menu.

Parameters:
treeController - Tree controller that displays the menu.
actions - List of pairs (action, classInfo) that the controller is about to present in popup menu.
classInfo - Class of the selected object.
sons - List of classes declared as sons of the given class info.
Returns:
List of pairs (action, classInfo) that the controller will display in menu.

(c) January 2013 - W4 S.A.

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