SAP CL_GUI_ALV_TREE OO Class - ALV Tree Control









CL_GUI_ALV_TREE 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_GUI_ALV_TREE 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_GUI_ALV_TREE is CL_ALV_TREE_BASE

Method list of CL_GUI_ALV_TREE 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_NODEAdd Node KeyPublic
CALL METHOD cl_gui_alv_tree=>ADD_NODE...more details

CHANGE_ITEMChange Item, Only Update when ChangedPublic
CALL METHOD cl_gui_alv_tree=>CHANGE_ITEM...more details

CHANGE_NODEChange Line, Update Changed Line OnlyPublic
CALL METHOD cl_gui_alv_tree=>CHANGE_NODE...more details

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

CONSTRUCTORConstructorPublic
CALL METHOD cl_gui_alv_tree=>CONSTRUCTOR...more details

DELETE_SUBTREEDeletes NodePublic
CALL METHOD cl_gui_alv_tree=>DELETE_SUBTREE...more details

ENSURE_NODES_VISIBLENode on Frontend, Implicit Call of FRONTEND_UPDATEPublic
CALL METHOD cl_gui_alv_tree=>ENSURE_NODES_VISIBLE...more details

EXPAND_NODEExpands one NodePublic
CALL METHOD cl_gui_alv_tree=>EXPAND_NODE...more details

EXPAND_NODESExpands Several NodesPublic
CALL METHOD cl_gui_alv_tree=>EXPAND_NODES...more details

GET_CHECKED_ITEMSReturns Items in Which Checkbox is SelectedPublic
CALL METHOD cl_gui_alv_tree=>GET_CHECKED_ITEMS...more details

GET_CHILDRENReturns Children of Tree ModelPublic
CALL METHOD cl_gui_alv_tree=>GET_CHILDREN...more details

GET_EXPANDED_NODESReturns Selected NodesPublic
CALL METHOD cl_gui_alv_tree=>GET_EXPANDED_NODES...more details

GET_FIRST_CHILDReturns the First Child NodePublic
CALL METHOD cl_gui_alv_tree=>GET_FIRST_CHILD...more details

GET_LAST_CHILDReturns the Last Child NodePublic
CALL METHOD cl_gui_alv_tree=>GET_LAST_CHILD...more details

GET_NEXT_SIBLINGReturns the Next NodePublic
CALL METHOD cl_gui_alv_tree=>GET_NEXT_SIBLING...more details

GET_OUTTAB_LINEGet Data From ModelPublic
CALL METHOD cl_gui_alv_tree=>GET_OUTTAB_LINE...more details

GET_PARENTReturns Parent of one Node in Tree ModelPublic
CALL METHOD cl_gui_alv_tree=>GET_PARENT...more details

GET_PREV_SIBLINGReturns the Preceding NodePublic
CALL METHOD cl_gui_alv_tree=>GET_PREV_SIBLING...more details

GET_SELECTED_ITEMReturns Item SelectedPublic
CALL METHOD cl_gui_alv_tree=>GET_SELECTED_ITEM...more details

GET_SELECTED_NODESReturns Selected NodesPublic
CALL METHOD cl_gui_alv_tree=>GET_SELECTED_NODES...more details

GET_SUBTREEReturns all Nodes of Subtree of NodePublic
CALL METHOD cl_gui_alv_tree=>GET_SUBTREE...more details

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

HANDLE_BUTTON_CLICKPushbutton ClickedPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_BUTTON_CLICK...more details

HANDLE_CHECKBOX_CHANGEhandle_CHECKBOX_CHANGEPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_CHECKBOX_CHANGE...more details

HANDLE_EXPAND_NChandle_EXPAND_NCPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_EXPAND_NC...more details

HANDLE_HEADER_CLICKhandle_HEADER_CLICKPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_HEADER_CLICK...more details

HANDLE_ITEM_CONTEXT_MENU_RQhandle_ITEM_CONTEXT_MENU_REQUESTPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_ITEM_CONTEXT_MENU_RQ...more details

HANDLE_ITEM_CONTEXT_MENU_SELhandle_ITEM_CONTEXT_MENU_SELECTPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_ITEM_CONTEXT_MENU_SEL...more details

HANDLE_ITEM_DOUBLE_CLICKhandle_ITEM_DOUBLE_CLICKPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_ITEM_DOUBLE_CLICK...more details

HANDLE_ITEM_KEYPRESSHANDLE_ITEM_KEYPRESSPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_ITEM_KEYPRESS...more details

HANDLE_LINK_CLICKhandle_LINK_CLICKPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_LINK_CLICK...more details

HANDLE_NODE_CONTEXT_MENU_RQhandle_node_context_menu_rqPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_NODE_CONTEXT_MENU_RQ...more details

HANDLE_NODE_CONTEXT_MENU_SELHandle NODE_CONTEXT_MENU_SELECTPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_NODE_CONTEXT_MENU_SEL...more details

HANDLE_NODE_DOUBLE_CLICKhandle_NODE_DOUBLE_CLICKPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_NODE_DOUBLE_CLICK...more details

HANDLE_NODE_KEYPRESSHANDLE_ITEM_KEYPRESSPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_NODE_KEYPRESS...more details

HANDLE_ON_DRAGHandle on_dragPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_ON_DRAG...more details

HANDLE_ON_DRAG_MULTIPLEHandle on_dragPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_ON_DRAG_MULTIPLE...more details

HANDLE_ON_DROPHandle on_drop-eventPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_ON_DROP...more details

HANDLE_ON_DROP_COMPLETEHandle ON_DROP_COMPLETEPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_ON_DROP_COMPLETE...more details

HANDLE_ON_DROP_COMPLETE_MULTHandle ON_DROP_COMPLETEPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_ON_DROP_COMPLETE_MULT...more details

HANDLE_ON_DROP_EXTERNAL_FILESHandle on_drop_external_filesPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_ON_DROP_EXTERNAL_FILES...more details

HANDLE_ON_DROP_GET_FLAVORHandle ON_DROP_GET_FLAVORPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_ON_DROP_GET_FLAVOR...more details

HANDLE_SELECTION_CHANGEDHandle_SELECTION_CHANGEDPrivate
CALL METHOD cl_gui_alv_tree=>HANDLE_SELECTION_CHANGED...more details

MOVE_NODEMove a Node Within TreePublic
CALL METHOD cl_gui_alv_tree=>MOVE_NODE...more details

REFRESH_TABLE_DISPLAYRedraw TreePrivate
CALL METHOD cl_gui_alv_tree=>REFRESH_TABLE_DISPLAY...more details

REMOVE_ALL_KEY_STROKESFor internal use onlyProtected
CALL METHOD cl_gui_alv_tree=>REMOVE_ALL_KEY_STROKES...more details

SEARCH_IN_EXTERNAL_FORMATSearches for StringPublic
CALL METHOD cl_gui_alv_tree=>SEARCH_IN_EXTERNAL_FORMAT...more details

SEARCH_IN_INTERNAL_FORMATSearches for Data in a ColumnPublic
CALL METHOD cl_gui_alv_tree=>SEARCH_IN_INTERNAL_FORMAT...more details

SET_FUNCTION_CODESets Function CodePublic
CALL METHOD cl_gui_alv_tree=>SET_FUNCTION_CODE...more details

SET_HANDLERSSets Event Handlers for Column Tree ControlPrivate
CALL METHOD cl_gui_alv_tree=>SET_HANDLERS...more details

SET_HIERARCHY_HEADERSets Hierarchy HeaderPublic
CALL METHOD cl_gui_alv_tree=>SET_HIERARCHY_HEADER...more details

SET_SELECTED_ITEMSets Selected ItemPublic
CALL METHOD cl_gui_alv_tree=>SET_SELECTED_ITEM...more details

SET_SELECTED_NODESSets Selected NodesPublic
CALL METHOD cl_gui_alv_tree=>SET_SELECTED_NODES...more details

SET_TABLE_FOR_FIRST_DISPLAYSets Table for First DisplayPublic
CALL METHOD cl_gui_alv_tree=>SET_TABLE_FOR_FIRST_DISPLAY...more details

SET_TOP_NODESets Top Node, Implicit Frontend Update!Public
CALL METHOD cl_gui_alv_tree=>SET_TOP_NODE...more details

UNSELECT_NODESDeselect NodesPublic
CALL METHOD cl_gui_alv_tree=>UNSELECT_NODES...more details



CL_GUI_ALV_TREE 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
C_DEFAULT_HIER_WIDTHConstantDefault6LIKE
I
Protected
MT_EXCEPT_QINFOInstance AttributeTable for Exception QuickinfoLIKE
LVC_T_QINF
Protected
M_FCAT_COMPLETEInstance AttributeField Catalog is CompleteLIKE
SAP_BOOL
Private


Events of Class CL_GUI_ALV_TREE

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... BUTTON_CLICK - Button Click
CHECKBOX_CHANGE - CheckboxChange
EXPAND_NC - Expand on No Children (Expander)
HEADER_CLICK - Header Click
HEADER_CONTEXT_MENU - User Command in Header Context Menu (not yet Implemented)
ITEM_CONTEXT_MENU_REQUEST - Application May Change Context Menu
ITEM_CONTEXT_MENU_SELECTED - User Command in Item Context Menu
ITEM_DOUBLE_CLICK - ItemDoubleClick
ITEM_KEYPRESS - Key Pressed, Node Was Selected
LINK_CLICK - LinkClick
NODE_CONTEXT_MENU_REQUEST - Application May Change Context Menu
NODE_CONTEXT_MENU_SELECTED - User Command in Node Context Menu
NODE_DOUBLE_CLICK - NodeDoubleClick
NODE_KEYPRESS - Key Pressed, Node Was Selected
ON_DRAG - Event for Filling Drag and Drop Data Object
ON_DRAG_MULTIPLE - Event for Filling Drag and Drop Data Object
ON_DROP - One Object Dropped
ON_DROP_COMPLETE - Drop Event Processed Successfully
ON_DROP_COMPLETE_MULTIPLE - Drop Event Processed Successfully
ON_DROP_EXTERNAL_FILES - Result for Filling the Drag Drop of External Files
ON_DROP_GET_FLAVOR - There is More Than One Possible Flavor For a Drop
SELECTION_CHANGED - Selection Changed

Links to Related Class(s)

CL_GUI_A...
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!