Show TOC

Providing Help for UsersLocate this document in the navigation structure

Use

You have various options of providing help to users of your application. You can use the following types of help for your ALV output:

  • accessibilityDescription

    If the user has activated accessibility, the text assigned here is added to the quick info. This description is to provide more information about the ALV output or column. The description is only read by the screen reader when the user moves the focus to the ALV output.

  • Tooltip

    Quick info text that appears when the user passes the mouse pointer over the UI element in the toolbar or over a cell. If screen readers are supported, accessibilityDescription is added automatically as additional text for the quick info, to support accessibility.

  • Explanation

    Various UI elements in the toolbar or list have the explanation property. If the user has switched on the help mode, the text for this property is displayed in a box when the user moves the cursor over the UI element.

    The text for the explanation property is displayed independently of the tooltip.

    For more information, see Explanation Property .

  • Web Dynpro input help

    You can use the following input help in the ALV output:

    • ABAP Dictionary Search Help

    • OVS Value Help

    • Freely Programmed Input Help

    For more information, see Input Help .

accessibilityDescription

accessibilityDescription is a property of the following areas:

  • Entire ALV output

    The accessibilityDescription is displayed with the tooltip for the header of the ALV output. To enter it, you use the methods of interface class IF_SALV_WD_TABLE_SETTINGS (implementing class CL_SALV_WD_CONFIG_TABLE):

accessibilityDescription of the ALV Output

Function

Method

Specify accessibilityDescription

SET_ACC_DESCRIPTION

Get accessibilityDescription

GET_ACC_DESCRIPTION

  • Column

    The accessibilityDescription is displayed with the tooltip of the column header. To enter it, you use the methods of class CL_SALV_WD_COLUMN:

Methods for entering accessibilityDescription

Function

Method

Specify accessibilityDescription

SET_ACCESSIBILITY_DESCR

Get accessibilityDescription

GET_ACCESSIBILITY_DESCR

Tooltip

You can specify tooltips for the following elements of your ALV output:

  • Header of ALV output

  • Column Headers

  • User-defined functions (using the UI element used)

  • Cell editors (using the UI element used)

Classes and methods for tooltips

Tooltip

Class

Method

For the header of the ALV output

IF_SALV_WD_TABLE_SETTINGS

SET_TOOLTIP and GET_TOOLTIP

For user-defined functions

CL_SALV_WD_FE_<UI element>

For cell editors

CL_SALV_WD_UIE_<UI element>

Explanation

You can specify an explanation for the following elements of your ALV output:

  • Column

  • User-defined functions (using the UI element used)

    • Button

    • Dropdown list box (index and key)

    • Input field

  • Cell editors (using the UI element used)

    • Button

    • Checkbox and TriState checkbox

    • Dropdown list box (index and key)

    • Input Field

    • FileUpload

Classes and methods for the explanation

Tooltip

Class

Method

For the column

CL_SALV_WD_COLUMN

SET_EXPLANATION and GET_EXPLANATION

For user-defined functions

CL_SALV_WD_FE_BUTTON

CL_SALV_WD_FE_DROPDOWN_BY_IDX

CL_SALV_WD_FE_DROPDOWN_BY_KEY

CL_SALV_WD_FE_INPUT_FIELD

For cell editors

CL_SALV_WD_UIE_BUTTON

CL_SALV_WD_UIE_CHECKBOX

CL_SALV_WD_UIE_CHECKBOX_TRI

CL_SALV_WD_UIE_DROPDOWN_BY_IDX

CL_SALV_WD_UIE_DROPDOWN_BY_KEY

CL_SALV_WD_UIE_FILE_UPLOAD

CL_SALV_WD_UIE_INPUT_FIELD