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_CONTROL

Interface 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_SUPPORT

Interface Implementation

This OO class is an Interface Implementation, which means it will implement its own version of the methods from implementation class IF_DRAGDROP

Method 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 NameDescriptionVisability
ADD_KEY_STROKEDefine Key That Triggers KEYPRESS EventPublic
CALL METHOD cl_tree_control_base=>ADD_KEY_STROKE...more details

ADD_STYLE_INFOAccessibility: Sets Info Text to One StylePublic
CALL METHOD cl_tree_control_base=>ADD_STYLE_INFO...more details

CC_INTERNAL_ERRORHandle Internal ErrorProtected
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_INFOSAccessibility: Deletes the Info Texts of All StylesPublic
CALL METHOD cl_tree_control_base=>CLEAR_ALL_STYLE_INFOS...more details

CLEAR_STYLE_INFOAccessibility: Deletes the Info Text for One StylePublic
CALL METHOD cl_tree_control_base=>CLEAR_STYLE_INFO...more details

COLLAPSE_ALL_NODESCollapses all Branches of TreePublic
CALL METHOD cl_tree_control_base=>COLLAPSE_ALL_NODES...more details

COLLAPSE_NODESCollapse nodesPublic
CALL METHOD cl_tree_control_base=>COLLAPSE_NODES...more details

COLLAPSE_SUBTREECollapses all Branches of a Part of the TreePublic
CALL METHOD cl_tree_control_base=>COLLAPSE_SUBTREE...more details

CONSTRUCTORCreates ControlPublic
CALL METHOD cl_tree_control_base=>CONSTRUCTOR...more details

DELETE_ALL_NODESDeletes all nodes of the treePublic
CALL METHOD cl_tree_control_base=>DELETE_ALL_NODES...more details

DELETE_NODEDeletes one node of the treePublic
CALL METHOD cl_tree_control_base=>DELETE_NODE...more details

DELETE_NODESDelete Several NOdesPublic
CALL METHOD cl_tree_control_base=>DELETE_NODES...more details

DRAG_ACCEPT_FILESEnable GridView to Accept Dragged Files (e.g. from Explorer)Public
CALL METHOD cl_tree_control_base=>DRAG_ACCEPT_FILES...more details

ENSURE_VISIBLEEnsures That One Node Is Visible in ControlPublic
CALL METHOD cl_tree_control_base=>ENSURE_VISIBLE...more details

EXPAND_NODEExpand Node (Subtree)Public
CALL METHOD cl_tree_control_base=>EXPAND_NODE...more details

EXPAND_NODESExpand NodesPublic
CALL METHOD cl_tree_control_base=>EXPAND_NODES...more details

EXPAND_ROOT_NODESExpands all Root NodesPublic
CALL METHOD cl_tree_control_base=>EXPAND_ROOT_NODES...more details

GET_DROPPED_EXTERNAL_FILESGet Dropped FilesPublic
CALL METHOD cl_tree_control_base=>GET_DROPPED_EXTERNAL_FILES...more details

GET_EXPANDED_NODESReads Expanded NodesPublic
CALL METHOD cl_tree_control_base=>GET_EXPANDED_NODES...more details

GET_ITEMGets Item ObjectProtected
CALL METHOD cl_tree_control_base=>GET_ITEM...more details

GET_NODE_BY_KEYGet Node ObjectProtected
CALL METHOD cl_tree_control_base=>GET_NODE_BY_KEY...more details

GET_NODE_KEY_TABLEGet Table Using Keys from PropertyProtected
CALL METHOD cl_tree_control_base=>GET_NODE_KEY_TABLE...more details

GET_SELECTED_NODEReturns the Key of the Selected NodePublic
CALL METHOD cl_tree_control_base=>GET_SELECTED_NODE...more details

GET_SELECTED_NODESReads the selected nodesPublic
CALL METHOD cl_tree_control_base=>GET_SELECTED_NODES...more details

GET_TOP_NODEReturns the Key of the Node at Top of ControlPublic
CALL METHOD cl_tree_control_base=>GET_TOP_NODE...more details

HANDLE_BASE_EVENTDispatches Basic EventsPrivate
CALL METHOD cl_tree_control_base=>HANDLE_BASE_EVENT...more details

HANDLE_ERROR_IN_TABLEAnalyze Error in Passed TableProtected
CALL METHOD cl_tree_control_base=>HANDLE_ERROR_IN_TABLE...more details

HANDLE_EVENTVirtual MethodProtected
CALL METHOD cl_tree_control_base=>HANDLE_EVENT...more details

HANDLE_EVENT_NODE_KEYPRESSHandle Event NODE_KEYPRESSPrivate
CALL METHOD cl_tree_control_base=>HANDLE_EVENT_NODE_KEYPRESS...more details

HANDLE_NODE_KEY_EVENTHandle Events With Form EVENT(NODE_KEY)Private
CALL METHOD cl_tree_control_base=>HANDLE_NODE_KEY_EVENT...more details

HANDLE_ON_DROP_EXTERNAL_FILESHandle Event ON_DROP_EXTERNAL_FILESPrivate
CALL METHOD cl_tree_control_base=>HANDLE_ON_DROP_EXTERNAL_FILES...more details

INIT_TREEInitialize ControlPrivate
CALL METHOD cl_tree_control_base=>INIT_TREE...more details

INTERNAL_ERRORHandle Internal ErrorProtected
CALL METHOD cl_tree_control_base=>INTERNAL_ERROR...more details

MOVE_NODEMove Node in TreePublic
CALL METHOD cl_tree_control_base=>MOVE_NODE...more details

NODE_SET_DISABLEDSets Whether a Node Can Be SelectedPublic
CALL METHOD cl_tree_control_base=>NODE_SET_DISABLED...more details

NODE_SET_DRAGDROPIDSets the DRAGDROPID Property of a NodePublic
CALL METHOD cl_tree_control_base=>NODE_SET_DRAGDROPID...more details

NODE_SET_EXPANDERSets the EXPANDER Property for a NodePublic
CALL METHOD cl_tree_control_base=>NODE_SET_EXPANDER...more details

NODE_SET_EXP_IMAGESets the Folder Symbol to ExpandedPublic
CALL METHOD cl_tree_control_base=>NODE_SET_EXP_IMAGE...more details

NODE_SET_HIDDENSets Visibility of a NodePublic
CALL METHOD cl_tree_control_base=>NODE_SET_HIDDEN...more details

NODE_SET_IS_FOLDERSets the IS_FOLDER Property of a NodePublic
CALL METHOD cl_tree_control_base=>NODE_SET_IS_FOLDER...more details

NODE_SET_NO_BRANCHSets Whether The Control Draws Hierarchy Line for a NodePublic
CALL METHOD cl_tree_control_base=>NODE_SET_NO_BRANCH...more details

NODE_SET_N_IMAGESets Leaf Symbol / Closed Folder SymbolPublic
CALL METHOD cl_tree_control_base=>NODE_SET_N_IMAGE...more details

NODE_SET_STYLESets the STYLE Property of a NodePublic
CALL METHOD cl_tree_control_base=>NODE_SET_STYLE...more details

RELEASE_HANDLEReleases a Handle After an ErrorProtected
CALL METHOD cl_tree_control_base=>RELEASE_HANDLE...more details

REMOVE_ALL_KEY_STROKESRomve All Definitions of ADD_KEY_STROKEPublic
CALL METHOD cl_tree_control_base=>REMOVE_ALL_KEY_STROKES...more details

SCROLLScrolls Tree ControlPublic
CALL METHOD cl_tree_control_base=>SCROLL...more details

SELECT_NODESSelect Nodes (Only With Multiple Node Selection)Public
CALL METHOD cl_tree_control_base=>SELECT_NODES...more details

SET_COLUMN_PROPERTIESSets Attributes of a Column in the ControlProtected
CALL METHOD cl_tree_control_base=>SET_COLUMN_PROPERTIES...more details

SET_CTX_MENU_SELECT_EVENT_APPLSets the Context Menu Selection EventsPublic
CALL METHOD cl_tree_control_base=>SET_CTX_MENU_SELECT_EVENT_APPL...more details

SET_DEFAULT_DROPStandard Drop for Free Area in ControlPublic
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 selectPublic
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_IMAGEPublic
CALL METHOD cl_tree_control_base=>SET_FOLDER_SHOW_EXP_IMAGE...more details

SET_HAS_3D_FRAME' ': Display Control Without 3D Frame; 'X': Display WithPublic
CALL METHOD cl_tree_control_base=>SET_HAS_3D_FRAME...more details

SET_ITEM_PROPERTYSets Property of an ItemProtected
CALL METHOD cl_tree_control_base=>SET_ITEM_PROPERTY...more details

SET_NODE_KEY_TABLESet Table with Key Derived from PropertyProtected
CALL METHOD cl_tree_control_base=>SET_NODE_KEY_TABLE...more details

SET_NODE_PROPERTYSet Property of a NodeProtected
CALL METHOD cl_tree_control_base=>SET_NODE_PROPERTY...more details

SET_NODE_TABLE_COLUMN_NAMESPass Names of Columns in Node Table to ControlPrivate
CALL METHOD cl_tree_control_base=>SET_NODE_TABLE_COLUMN_NAMES...more details

SET_SCREEN_UPDATEControls When Control is RedrawnPublic
CALL METHOD cl_tree_control_base=>SET_SCREEN_UPDATE...more details

SET_SELECTED_NODESets Selected Node in Single SelectionPublic
CALL METHOD cl_tree_control_base=>SET_SELECTED_NODE...more details

SET_TOP_NODESets Node That Appears at Top of ControlPublic
CALL METHOD cl_tree_control_base=>SET_TOP_NODE...more details

SET_WEB_GUI_LOCAL_EXPANDWEB GUI: Local Open/Close for FoldersPublic
CALL METHOD cl_tree_control_base=>SET_WEB_GUI_LOCAL_EXPAND...more details

UNSELECT_ALLDeselects EverythingPublic
CALL METHOD cl_tree_control_base=>UNSELECT_ALL...more details

UNSELECT_NODESDeselects 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.

NameLevelDescriptionInitial ValueTypeVisability
ALIGN_AUTO_INTConstant'3LIKE
I
Protected
CONTROL_TREEInstance Attribute'LIKE
IF_CONTROL_TREE_NODE
Protected
CTX_EVENT_BASEInstance Attribute'X': Basic Class Dispatched Last Context Menu RequestLIKE
AS4FLAG
Protected
CTX_MEN_REQ_NODE_KEYInstance AttributeKey Node of Last Context Menu RequestLIKE
TV_NODEKEY
Private
CTX_MEN_REQ_OBJECTInstance AttributeObject From Last Context Menu RequestLIKE
I
Private
CTX_MEN_REQ_OBJ_DEFAULTConstantContext Menu Request on Control Background2LIKE
I
Private
CTX_MEN_REQ_OBJ_NODEConstantContext Menu Request on Node1LIKE
I
Private
CTX_MEN_SELECT_SYSTEMInstance AttributeContext Menu Select Event System / Application'X'LIKE
AS4FLAG
Protected
EN_ENUM_NODE_SELECTION_MODEConstant''enum_node_selection_mode'LIKE
CC_NAME
Protected
EVENTID_DEF_CONTEXT_MENU_REQConstantContext Menu on Control Background42LIKE
I
Public
EVENTID_EXPAND_NO_CHILDRENConstantNode with EXPANDER Attribute Was Expanded18LIKE
I
Public
EVENTID_NODE_CONTEXT_MENU_REQConstantContext Menu for Node36LIKE
I
Public
EVENTID_NODE_DOUBLE_CLICKConstantDouble-Click Node25LIKE
I
Public
EVENTID_NODE_KEYPRESSConstantKey Press On Selected Node40LIKE
I
Public
EVENTID_ON_DROP_EXTERNAL_FILESConstantEventId for OnDropExternalFiles Event45LIKE
I
Public
EVENTID_SELECTION_CHANGEDConstantSelection Changed21LIKE
I
Public
FILES_STRInstance AttributeString to Get Dropped FilesLIKE
STRING
Private
IMAGEStatic Attribute'LIKE
CL_GUI_OBJECT
Private
ITEMStatic Attribute'LIKE
CL_GUI_OBJECT
Private
KEY_COPYConstantCTRL-C Key7LIKE
I
Public
KEY_CUTConstantCTRL-X Key6LIKE
I
Public
KEY_DELETEConstantDelete Key2LIKE
I
Public
KEY_ENTERConstantEnter Key5LIKE
I
Public
KEY_F1ConstantF1 Key1LIKE
I
Public
KEY_F4ConstantF4 Key4LIKE
I
Public
KEY_INSERTConstantInsert Key3LIKE
I
Public
KEY_PASTEConstantCTRL-V Key8LIKE
I
Public
LEVELStatic Attribute'LIKE
CL_GUI_OBJECT
Private
NODEStatic Attribute'LIKE
CL_GUI_OBJECT
Private
NODESStatic Attribute'LIKE
CL_GUI_OBJECT
Private
NODE_SELECTION_MODEInstance AttributeType of Node SelectionLIKE
I
Protected
NODE_SEL_MODE_MULTIPLEConstantMultiple Node Selection1LIKE
I
Public
NODE_SEL_MODE_SINGLEConstantSingle Node Selection0LIKE
I
Public
PN_HIDE_SELECTIONConstantControl Composite: Name'hide_selection'LIKE
CC_NAME
Protected
PN_NODE_SELECTION_MODEConstantControl Composite: Name'node_selection_mode'LIKE
CC_NAME
Protected
RELAT_FIRST_CHILDConstant'4LIKE
I
Public
RELAT_FIRST_SIBLINGConstant'5LIKE
I
Public
RELAT_LAST_CHILDConstant'6LIKE
I
Public
RELAT_LAST_SIBLINGConstant'1LIKE
I
Public
RELAT_NEXT_SIBLINGConstant'2LIKE
I
Public
RELAT_PREV_SIBLINGConstant'3LIKE
I
Public
SCROLL_DOWN_LINEConstantScrolls Down One Line2LIKE
I
Public
SCROLL_DOWN_PAGEConstantScrolls Down One Page4LIKE
I
Public
SCROLL_ENDConstantScrolls Down to End6LIKE
I
Public
SCROLL_HOMEConstantScrolls Up to Beginning5LIKE
I
Public
SCROLL_UP_LINEConstantScrolls Up One Line1LIKE
I
Public
SCROLL_UP_PAGEConstantScrolls Up One Page3LIKE
I
Public
STRUCTURESStatic Attribute'LIKE
CL_GUI_OBJECT
Private
STYLE_DEFAULTConstant'1LIKE
I
Public
STYLE_EMPHASIZEDConstant'7LIKE
I
Public
STYLE_EMPHASIZED_AConstantCOL_HEADING Intensified Off8LIKE
I
Public
STYLE_EMPHASIZED_BConstantCOL_KEY Intensified Off9LIKE
I
Public
STYLE_EMPHASIZED_CConstantCOL_GROUP Intensified Off10LIKE
I
Public
STYLE_EMPHASIZED_NEGATIVEConstant'5LIKE
I
Public
STYLE_EMPHASIZED_POSITIVEConstant'6LIKE
I
Public
STYLE_INACTIVEConstant'3LIKE
I
Public
STYLE_INHERITEDConstantApply Style from Parent Object0LIKE
I
Public
STYLE_INTENSIFD_CRITICALConstant'4LIKE
I
Public
STYLE_INTENSIFIEDConstant'2LIKE
I
Public
THIS_CLASS_NAMEConstantName 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 Background
DEFAULT_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



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!