SAP CL_TREE_CONTROL_BASE OO Class - Internal Tree Control Class
CL_TREE_CONTROL_BASE is a standard SAP object class available within R/3 SAP systems depending on your version and release level. You can view/maintain the class details by entering its name into the relevant SAP transactions such as SE24, SE80 or even SE84. Below is the documentation available for class CL_TREE_CONTROL_BASE including details of:
- Interface class implementations
- Inheritance details
- Methods defined within class ( including link to full details )
- Attributes ( including initial values )
- Class Events
Inheritance
This OO class has a superclass assigned to it, which means it will inherit its objects and methods. The superclass for CL_TREE_CONTROL_BASE is CL_GUI_CONTROLInterface Implementation
This OO class is an Interface Implementation, which means it will implement its own version of the methods from implementation class IF_CONTROL_COMPOSITE_SUPPORTInterface Implementation
This OO class is an Interface Implementation, which means it will implement its own version of the methods from implementation class IF_DRAGDROPMethod list of CL_TREE_CONTROL_BASE SAP class
A method is a coding block that performs a certain procedure (i.e. ABAP functionality) on an object within the overall SAP class. In simple terms if the object is an SAP database table a method could be the procedure to add a record or to delete a record. If you are new to OO in many respects, the implementation of a method is similar to a function module and can be called in a very similar way using CALL METHOD.
Instead of "CALL FUNCTION", Methods are referenced using the following syntax: CALL METHOD =>methodname EXPORTING/IMPORTING...
| Method Name | Description | Visability |
| ADD_KEY_STROKE | Define Key That Triggers KEYPRESS Event | Public |
| CALL METHOD cl_tree_control_base=>ADD_KEY_STROKE...more details | ||
| ADD_STYLE_INFO | Accessibility: Sets Info Text to One Style | Public |
| CALL METHOD cl_tree_control_base=>ADD_STYLE_INFO...more details | ||
| CC_INTERNAL_ERROR | Handle Internal Error | Protected |
| CALL METHOD cl_tree_control_base=>CC_INTERNAL_ERROR...more details | ||
| CC_SET_HIDE_SELECTION | ' | Protected |
| CALL METHOD cl_tree_control_base=>CC_SET_HIDE_SELECTION...more details | ||
| CC_SET_NODE_SELECTION_MODE | ' | Protected |
| CALL METHOD cl_tree_control_base=>CC_SET_NODE_SELECTION_MODE...more details | ||
| CLEAR_ALL_STYLE_INFOS | Accessibility: Deletes the Info Texts of All Styles | Public |
| CALL METHOD cl_tree_control_base=>CLEAR_ALL_STYLE_INFOS...more details | ||
|
| ||
| CLEAR_STYLE_INFO | Accessibility: Deletes the Info Text for One Style | Public |
| CALL METHOD cl_tree_control_base=>CLEAR_STYLE_INFO...more details | ||
| COLLAPSE_ALL_NODES | Collapses all Branches of Tree | Public |
| CALL METHOD cl_tree_control_base=>COLLAPSE_ALL_NODES...more details | ||
| COLLAPSE_NODES | Collapse nodes | Public |
| CALL METHOD cl_tree_control_base=>COLLAPSE_NODES...more details | ||
| COLLAPSE_SUBTREE | Collapses all Branches of a Part of the Tree | Public |
| CALL METHOD cl_tree_control_base=>COLLAPSE_SUBTREE...more details | ||
| CONSTRUCTOR | Creates Control | Public |
| CALL METHOD cl_tree_control_base=>CONSTRUCTOR...more details | ||
| DELETE_ALL_NODES | Deletes all nodes of the tree | Public |
| CALL METHOD cl_tree_control_base=>DELETE_ALL_NODES...more details | ||
| DELETE_NODE | Deletes one node of the tree | Public |
| CALL METHOD cl_tree_control_base=>DELETE_NODE...more details | ||
| DELETE_NODES | Delete Several NOdes | Public |
| CALL METHOD cl_tree_control_base=>DELETE_NODES...more details | ||
| DRAG_ACCEPT_FILES | Enable GridView to Accept Dragged Files (e.g. from Explorer) | Public |
| CALL METHOD cl_tree_control_base=>DRAG_ACCEPT_FILES...more details | ||
| ENSURE_VISIBLE | Ensures That One Node Is Visible in Control | Public |
| CALL METHOD cl_tree_control_base=>ENSURE_VISIBLE...more details | ||
| EXPAND_NODE | Expand Node (Subtree) | Public |
| CALL METHOD cl_tree_control_base=>EXPAND_NODE...more details | ||
| EXPAND_NODES | Expand Nodes | Public |
| CALL METHOD cl_tree_control_base=>EXPAND_NODES...more details | ||
| EXPAND_ROOT_NODES | Expands all Root Nodes | Public |
| CALL METHOD cl_tree_control_base=>EXPAND_ROOT_NODES...more details | ||
| GET_DROPPED_EXTERNAL_FILES | Get Dropped Files | Public |
| CALL METHOD cl_tree_control_base=>GET_DROPPED_EXTERNAL_FILES...more details | ||
| GET_EXPANDED_NODES | Reads Expanded Nodes | Public |
| CALL METHOD cl_tree_control_base=>GET_EXPANDED_NODES...more details | ||
| GET_ITEM | Gets Item Object | Protected |
| CALL METHOD cl_tree_control_base=>GET_ITEM...more details | ||
| GET_NODE_BY_KEY | Get Node Object | Protected |
| CALL METHOD cl_tree_control_base=>GET_NODE_BY_KEY...more details | ||
| GET_NODE_KEY_TABLE | Get Table Using Keys from Property | Protected |
| CALL METHOD cl_tree_control_base=>GET_NODE_KEY_TABLE...more details | ||
| GET_SELECTED_NODE | Returns the Key of the Selected Node | Public |
| CALL METHOD cl_tree_control_base=>GET_SELECTED_NODE...more details | ||
| GET_SELECTED_NODES | Reads the selected nodes | Public |
| CALL METHOD cl_tree_control_base=>GET_SELECTED_NODES...more details | ||
| GET_TOP_NODE | Returns the Key of the Node at Top of Control | Public |
| CALL METHOD cl_tree_control_base=>GET_TOP_NODE...more details | ||
| HANDLE_BASE_EVENT | Dispatches Basic Events | Private |
| CALL METHOD cl_tree_control_base=>HANDLE_BASE_EVENT...more details | ||
| HANDLE_ERROR_IN_TABLE | Analyze Error in Passed Table | Protected |
| CALL METHOD cl_tree_control_base=>HANDLE_ERROR_IN_TABLE...more details | ||
| HANDLE_EVENT | Virtual Method | Protected |
| CALL METHOD cl_tree_control_base=>HANDLE_EVENT...more details | ||
| HANDLE_EVENT_NODE_KEYPRESS | Handle Event NODE_KEYPRESS | Private |
| CALL METHOD cl_tree_control_base=>HANDLE_EVENT_NODE_KEYPRESS...more details | ||
| HANDLE_NODE_KEY_EVENT | Handle Events With Form EVENT(NODE_KEY) | Private |
| CALL METHOD cl_tree_control_base=>HANDLE_NODE_KEY_EVENT...more details | ||
| HANDLE_ON_DROP_EXTERNAL_FILES | Handle Event ON_DROP_EXTERNAL_FILES | Private |
| CALL METHOD cl_tree_control_base=>HANDLE_ON_DROP_EXTERNAL_FILES...more details | ||
| INIT_TREE | Initialize Control | Private |
| CALL METHOD cl_tree_control_base=>INIT_TREE...more details | ||
| INTERNAL_ERROR | Handle Internal Error | Protected |
| CALL METHOD cl_tree_control_base=>INTERNAL_ERROR...more details | ||
| MOVE_NODE | Move Node in Tree | Public |
| CALL METHOD cl_tree_control_base=>MOVE_NODE...more details | ||
| NODE_SET_DISABLED | Sets Whether a Node Can Be Selected | Public |
| CALL METHOD cl_tree_control_base=>NODE_SET_DISABLED...more details | ||
| NODE_SET_DRAGDROPID | Sets the DRAGDROPID Property of a Node | Public |
| CALL METHOD cl_tree_control_base=>NODE_SET_DRAGDROPID...more details | ||
| NODE_SET_EXPANDER | Sets the EXPANDER Property for a Node | Public |
| CALL METHOD cl_tree_control_base=>NODE_SET_EXPANDER...more details | ||
| NODE_SET_EXP_IMAGE | Sets the Folder Symbol to Expanded | Public |
| CALL METHOD cl_tree_control_base=>NODE_SET_EXP_IMAGE...more details | ||
| NODE_SET_HIDDEN | Sets Visibility of a Node | Public |
| CALL METHOD cl_tree_control_base=>NODE_SET_HIDDEN...more details | ||
| NODE_SET_IS_FOLDER | Sets the IS_FOLDER Property of a Node | Public |
| CALL METHOD cl_tree_control_base=>NODE_SET_IS_FOLDER...more details | ||
| NODE_SET_NO_BRANCH | Sets Whether The Control Draws Hierarchy Line for a Node | Public |
| CALL METHOD cl_tree_control_base=>NODE_SET_NO_BRANCH...more details | ||
| NODE_SET_N_IMAGE | Sets Leaf Symbol / Closed Folder Symbol | Public |
| CALL METHOD cl_tree_control_base=>NODE_SET_N_IMAGE...more details | ||
| NODE_SET_STYLE | Sets the STYLE Property of a Node | Public |
| CALL METHOD cl_tree_control_base=>NODE_SET_STYLE...more details | ||
| RELEASE_HANDLE | Releases a Handle After an Error | Protected |
| CALL METHOD cl_tree_control_base=>RELEASE_HANDLE...more details | ||
| REMOVE_ALL_KEY_STROKES | Romve All Definitions of ADD_KEY_STROKE | Public |
| CALL METHOD cl_tree_control_base=>REMOVE_ALL_KEY_STROKES...more details | ||
| SCROLL | Scrolls Tree Control | Public |
| CALL METHOD cl_tree_control_base=>SCROLL...more details | ||
| SELECT_NODES | Select Nodes (Only With Multiple Node Selection) | Public |
| CALL METHOD cl_tree_control_base=>SELECT_NODES...more details | ||
| SET_COLUMN_PROPERTIES | Sets Attributes of a Column in the Control | Protected |
| CALL METHOD cl_tree_control_base=>SET_COLUMN_PROPERTIES...more details | ||
| SET_CTX_MENU_SELECT_EVENT_APPL | Sets the Context Menu Selection Events | Public |
| CALL METHOD cl_tree_control_base=>SET_CTX_MENU_SELECT_EVENT_APPL...more details | ||
| SET_DEFAULT_DROP | Standard Drop for Free Area in Control | Public |
| CALL METHOD cl_tree_control_base=>SET_DEFAULT_DROP...more details | ||
| SET_DISABLE_SEL_CHANGE_CTX_MEN | 'X': Clicking node with right mouse button does not select | Public |
| CALL METHOD cl_tree_control_base=>SET_DISABLE_SEL_CHANGE_CTX_MEN...more details | ||
| SET_FOLDER_SHOW_EXP_IMAGE | 'X': Open Folder Always Displays EXP_IMAGE | Public |
| CALL METHOD cl_tree_control_base=>SET_FOLDER_SHOW_EXP_IMAGE...more details | ||
| SET_HAS_3D_FRAME | ' ': Display Control Without 3D Frame; 'X': Display With | Public |
| CALL METHOD cl_tree_control_base=>SET_HAS_3D_FRAME...more details | ||
| SET_ITEM_PROPERTY | Sets Property of an Item | Protected |
| CALL METHOD cl_tree_control_base=>SET_ITEM_PROPERTY...more details | ||
| SET_NODE_KEY_TABLE | Set Table with Key Derived from Property | Protected |
| CALL METHOD cl_tree_control_base=>SET_NODE_KEY_TABLE...more details | ||
| SET_NODE_PROPERTY | Set Property of a Node | Protected |
| CALL METHOD cl_tree_control_base=>SET_NODE_PROPERTY...more details | ||
| SET_NODE_TABLE_COLUMN_NAMES | Pass Names of Columns in Node Table to Control | Private |
| CALL METHOD cl_tree_control_base=>SET_NODE_TABLE_COLUMN_NAMES...more details | ||
| SET_SCREEN_UPDATE | Controls When Control is Redrawn | Public |
| CALL METHOD cl_tree_control_base=>SET_SCREEN_UPDATE...more details | ||
| SET_SELECTED_NODE | Sets Selected Node in Single Selection | Public |
| CALL METHOD cl_tree_control_base=>SET_SELECTED_NODE...more details | ||
| SET_TOP_NODE | Sets Node That Appears at Top of Control | Public |
| CALL METHOD cl_tree_control_base=>SET_TOP_NODE...more details | ||
| SET_WEB_GUI_LOCAL_EXPAND | WEB GUI: Local Open/Close for Folders | Public |
| CALL METHOD cl_tree_control_base=>SET_WEB_GUI_LOCAL_EXPAND...more details | ||
| UNSELECT_ALL | Deselects Everything | Public |
| CALL METHOD cl_tree_control_base=>UNSELECT_ALL...more details | ||
| UNSELECT_NODES | Deselects Nodes (Only With Multiple Node Selection) | Public |
| CALL METHOD cl_tree_control_base=>UNSELECT_NODES...more details | ||
CL_TREE_CONTROL_BASE attributes
List of attributes within class CL_ABAP_CHAR_UTILITIES. These can be referenced using the following syntax CL_ABAP_CHAR_UTILITIES=>. Although depending on where you are inserting the ABAP code you do need to check if the attribute is public or private.
| Name | Level | Description | Initial Value | Type | Visability |
| ALIGN_AUTO_INT | Constant | ' | 3 | LIKE I | Protected |
| CONTROL_TREE | Instance Attribute | ' | LIKE IF_CONTROL_TREE_NODE | Protected | |
| CTX_EVENT_BASE | Instance Attribute | 'X': Basic Class Dispatched Last Context Menu Request | LIKE AS4FLAG | Protected | |
| CTX_MEN_REQ_NODE_KEY | Instance Attribute | Key Node of Last Context Menu Request | LIKE TV_NODEKEY | Private | |
| CTX_MEN_REQ_OBJECT | Instance Attribute | Object From Last Context Menu Request | LIKE I | Private | |
| CTX_MEN_REQ_OBJ_DEFAULT | Constant | Context Menu Request on Control Background | 2 | LIKE I | Private |
| CTX_MEN_REQ_OBJ_NODE | Constant | Context Menu Request on Node | 1 | LIKE I | Private |
| CTX_MEN_SELECT_SYSTEM | Instance Attribute | Context Menu Select Event System / Application | 'X' | LIKE AS4FLAG | Protected |
| EN_ENUM_NODE_SELECTION_MODE | Constant | ' | 'enum_node_selection_mode' | LIKE CC_NAME | Protected |
| EVENTID_DEF_CONTEXT_MENU_REQ | Constant | Context Menu on Control Background | 42 | LIKE I | Public |
| EVENTID_EXPAND_NO_CHILDREN | Constant | Node with EXPANDER Attribute Was Expanded | 18 | LIKE I | Public |
| EVENTID_NODE_CONTEXT_MENU_REQ | Constant | Context Menu for Node | 36 | LIKE I | Public |
| EVENTID_NODE_DOUBLE_CLICK | Constant | Double-Click Node | 25 | LIKE I | Public |
| EVENTID_NODE_KEYPRESS | Constant | Key Press On Selected Node | 40 | LIKE I | Public |
| EVENTID_ON_DROP_EXTERNAL_FILES | Constant | EventId for OnDropExternalFiles Event | 45 | LIKE I | Public |
| EVENTID_SELECTION_CHANGED | Constant | Selection Changed | 21 | LIKE I | Public |
| FILES_STR | Instance Attribute | String to Get Dropped Files | LIKE STRING | Private | |
| IMAGE | Static Attribute | ' | LIKE CL_GUI_OBJECT | Private | |
| ITEM | Static Attribute | ' | LIKE CL_GUI_OBJECT | Private | |
| KEY_COPY | Constant | CTRL-C Key | 7 | LIKE I | Public |
| KEY_CUT | Constant | CTRL-X Key | 6 | LIKE I | Public |
| KEY_DELETE | Constant | Delete Key | 2 | LIKE I | Public |
| KEY_ENTER | Constant | Enter Key | 5 | LIKE I | Public |
| KEY_F1 | Constant | F1 Key | 1 | LIKE I | Public |
| KEY_F4 | Constant | F4 Key | 4 | LIKE I | Public |
| KEY_INSERT | Constant | Insert Key | 3 | LIKE I | Public |
| KEY_PASTE | Constant | CTRL-V Key | 8 | LIKE I | Public |
| LEVEL | Static Attribute | ' | LIKE CL_GUI_OBJECT | Private | |
| NODE | Static Attribute | ' | LIKE CL_GUI_OBJECT | Private | |
| NODES | Static Attribute | ' | LIKE CL_GUI_OBJECT | Private | |
| NODE_SELECTION_MODE | Instance Attribute | Type of Node Selection | LIKE I | Protected | |
| NODE_SEL_MODE_MULTIPLE | Constant | Multiple Node Selection | 1 | LIKE I | Public |
| NODE_SEL_MODE_SINGLE | Constant | Single Node Selection | 0 | LIKE I | Public |
| PN_HIDE_SELECTION | Constant | Control Composite: Name | 'hide_selection' | LIKE CC_NAME | Protected |
| PN_NODE_SELECTION_MODE | Constant | Control Composite: Name | 'node_selection_mode' | LIKE CC_NAME | Protected |
| RELAT_FIRST_CHILD | Constant | ' | 4 | LIKE I | Public |
| RELAT_FIRST_SIBLING | Constant | ' | 5 | LIKE I | Public |
| RELAT_LAST_CHILD | Constant | ' | 6 | LIKE I | Public |
| RELAT_LAST_SIBLING | Constant | ' | 1 | LIKE I | Public |
| RELAT_NEXT_SIBLING | Constant | ' | 2 | LIKE I | Public |
| RELAT_PREV_SIBLING | Constant | ' | 3 | LIKE I | Public |
| SCROLL_DOWN_LINE | Constant | Scrolls Down One Line | 2 | LIKE I | Public |
| SCROLL_DOWN_PAGE | Constant | Scrolls Down One Page | 4 | LIKE I | Public |
| SCROLL_END | Constant | Scrolls Down to End | 6 | LIKE I | Public |
| SCROLL_HOME | Constant | Scrolls Up to Beginning | 5 | LIKE I | Public |
| SCROLL_UP_LINE | Constant | Scrolls Up One Line | 1 | LIKE I | Public |
| SCROLL_UP_PAGE | Constant | Scrolls Up One Page | 3 | LIKE I | Public |
| STRUCTURES | Static Attribute | ' | LIKE CL_GUI_OBJECT | Private | |
| STYLE_DEFAULT | Constant | ' | 1 | LIKE I | Public |
| STYLE_EMPHASIZED | Constant | ' | 7 | LIKE I | Public |
| STYLE_EMPHASIZED_A | Constant | COL_HEADING Intensified Off | 8 | LIKE I | Public |
| STYLE_EMPHASIZED_B | Constant | COL_KEY Intensified Off | 9 | LIKE I | Public |
| STYLE_EMPHASIZED_C | Constant | COL_GROUP Intensified Off | 10 | LIKE I | Public |
| STYLE_EMPHASIZED_NEGATIVE | Constant | ' | 5 | LIKE I | Public |
| STYLE_EMPHASIZED_POSITIVE | Constant | ' | 6 | LIKE I | Public |
| STYLE_INACTIVE | Constant | ' | 3 | LIKE I | Public |
| STYLE_INHERITED | Constant | Apply Style from Parent Object | 0 | LIKE I | Public |
| STYLE_INTENSIFD_CRITICAL | Constant | ' | 4 | LIKE I | Public |
| STYLE_INTENSIFIED | Constant | ' | 2 | LIKE I | Public |
| THIS_CLASS_NAME | Constant | Name of Class | 'CL_TREE_CONTROL_BASE' | LIKE CHAR80 | Private |
Events of Class CL_TREE_CONTROL_BASE
Events are created within your class using special event handler methods. These must be registered at runtime for the event and can then be triggered using the ABAP syntax: RAISE EVENT EXPOTING... DEFAULT_CONTEXT_MENU_REQUEST - Context Menu Request for Control BackgroundDEFAULT_CONTEXT_MENU_SELECT - Context Menu Entry Selected
EXPAND_NO_CHILDREN - Node with EXPANDER Attribute Was Expanded
NODE_CONTEXT_MENU_REQUEST - Context Menu Request for a Node
NODE_CONTEXT_MENU_SELECT - Context Menu Entry Selected
NODE_DOUBLE_CLICK - Double-Click Node
NODE_KEYPRESS - Key Pressed, Node Was Selected
ON_DROP - Object Dropped
ON_DROP_EXTERNAL_FILES - One/several files were dropped from the Explorer
ON_DROP_GET_FLAVOR - There is More Than One Possible Flavor For a Drop
SELECTION_CHANGED - Selection Has Changed
Links to Related Class(s)
CL_TREE_...Full list of available SAP object classes
Search for further information about these or an SAP related objects