Show TOC

 IF_WD_SELECT_OPTIONSLocate this document in the navigation structure

The IF_WD_SELECT_OPTIONS interface is used for integrating selection options on a selection screen in application components.

Methods

Methods for Selection Fields

ADD_SELECTION_FIELD

Central method for inserting a field into a selection screen.

Parameters

Parameter Name

Description

I_ID

ID of the selection field. This ID is needed for retrieving the data later. This parameter is the only mandatory parameter.

I_WITHIN_BLOCK

The selection field is located within a block

I_DESCRIPTION

Description text for the field. If you do not enter a description, the data element description from the ABAP Dictionary is used automatically.

I_IS_AUTO_DESCRIPTION

Indicates whether the description of the field has been added automatically. Default value: TRUE

IT_RESULT

You can enter a reference to a range table. You can also use CREATE_RANGE_TABLE to create the range table, or you can define it yourself. You have to enter the type name.

If you do not specify a range table, you have to specify one later before the first rendering.

I_OBLIGATORY

Determines whether the field is mandatory (standard value: FALSE).

I_COMPLEX_RESTRICTIONS

Restricts what is allowed and what is not, for example, no angle brackets allowed.

To specify options you can use the RSOPTIONS Dictionary structure for including and excluding options.

I_USE_COMPLEX_RESTRICTION

Specifies whether I_COMPLEX_RESTRICTIONS is to be used.

Default value: FALSE or not set

I_NO_COMPLEX_RESTRICTIONS

Complex restrictions are not displayed at all, that is, they do not exist.

Default value: FALSE or not set

I_VALUE_HELP_TYPE

Type of input help specified as type IF_WD_VALUE_HELP_HANDLER.

Note that only ABAP Dictionary-based input help and OVS input help are supported; freely programmable input help is not supported.

I_VALUE_HELP_ID

ID of the input help, for example, you can specify the ID of an OVS (object value selection) search help (reference type WDY_VALUE_HELP_ID)

I_VALUE_HELP_MODE

Activates/deactivates the input help (reference type WDY_MD_VALUE_HELP_MODE_ENUM)

I_VALUE_HELP_STRUCTURE und I_VALUE_HELP_STRUCTURE_FIELD

With multiple select option fields and search help links across multiple fields (for example, town and country), the select options cannot recognize that these fields belong together. For this reason you can specify structure and fields. This ensures that all fields with the same structure names are associated together.

I_HELP_REQUEST_HANDLER

For future enhancements

I_LOWER_CASE

For future enhancements

I_MEMORY_ID

For future enhancements

I_NO_EXTENSION

No multiple selection

I_NO_INTERVALS

No interval (from - to) is possible in the display; there is only one field. Note that you can reactivate intervals using I_NO_EXTENSION.

I_AS_CHECKBOX und I_AS_DROPDOWN

Determines whether the field is to be displayed as a checkbox or as a dropdown. You can enter a value set, or the associated data element has a value set in its domain.

IT_VALUE_SET

Value set for I_AS_CHECKBOX or I_AS_DROPDOWN, reference type WDY_KEY_VALUE_TABLE

I_READ_ONLY

Specifies whether the field is read-only. The enhanced options enable you to display the field contents.

I_DONT_CARE_VALUE

If there is already an initial value set for I_AS_CHECKBOX or I_AS_DROPDOWN (the part of the value set), you can enter a "don't care" value.

I_EXPLANATION

Explanation text; more information: Help Texts for Web Dynpro Applications

I_TOOLTIP

Tooltip

ADD_SELECTION_FIELDS

Adds multiple fields to a selection screen

GET_SELECTION_FIELD

Returns the data of a field on a selection screen

GET_SELECTION_FIELDS

Returns the data of all fields on a selection screen

RESET_SELECTION_FIELD

Resets the range table for a selection field

RESET_ALL_SELECTION_FIELDS

Resets the range table for all selection fields

CHECK_ALL_SELECTION_FIELDS

Checks the input of all selection fields is correct

UPD_SELECTION_FIELD

Updates the settings of a selection field

GET_RANGE_TABLE_OF_SEL_FIELD

Reads a range table

SET_RANGE_TABLE_OF_SEL_FIELD

Sets a range table

Layout Methods

The following methods are provided to insert layout elements:

  • ADD_HORIZONTAL_DIVIDER and GET_HORIZONTAL_DIVIDER

    Adds and returns data of a horizontal divider to the selection screen

  • ADD_HORIZONTAL_DIVIDERS and GET_HORIZONTAL_DIVIDERS

    Adds and returns data of multiple horizontal dividers to the selection screen

  • ADD_TEXT_LINE and GET_TEXT_LINE

    Adds and returns data of a text line (as a string) to the selection screen. All the designs permitted for a TextView are permitted.

  • ADD_TEXT_LINES and GET_TEXT_LINES

    Adds and returns data of multiple text lines (as strings) to the selection screen

Methods for Blocks

The following methods are provided for working with blocks:

  • ADD_BLOCK
  • ADD_BLOCKS
  • GET_BLOCK
  • GET_BLOCKS

You can implement blocks using the UI elements Group , Tray or TransparentContainer .

Parameters of ADD_BLOCK and GET_BLOCK

Parameter

Description

I_ID

ID of the block

E_WITHIN_BLOCK

The ID of the enclosing block is specified by the block. The sequence they are entered is also the sequence in which they appear. If nothing is specified, a predefined block is used.

E_BLOCK_TYPE

Type of block, see reference type T_BLOCK_TYPE

E_TITLE

You can specify a title for Groups and Trays. With a TransparentContainer the title is the accessibilityDescription.

E_HIDE_IF_EMPTY

If a block is empty, it is removed from the display.

Methods for Parameters

These methods correspond to the methods for selection fields specified above, with the difference that these ones are based on the parameters:

  • ADD_PARAMETER_FIELD
  • ADD_PARAMETER_FIELDS
  • GET_PARAMETER_FIELD
  • GET_PARAMETER_FIELDS
  • SET_VALUE_OF_PARAMETER_FIELD
  • GET_VALUE_OF_PARAMETER_FIELD
  • RESET_PARAMETER_FIELD
  • RESET_ALL_PARAMETER_FIELDS
  • CHECK_ALL_PARAMETER_FIELDS

Methods for Standard Structures

  • GET_SELECTION_SCREEN_ITEM
  • GET_SELECTION_SCREEN_ITEMS
  • ADD_SELECTION_SCREEN_ITEM
  • ADD_SELECTION_SCREEN_ITEMS
  • REMOVE_SELECTION_SCREEN_ITEM

    Removes an element from the selection screen

    The only parameter here is the ID of the field to be removed (I_ID).

  • REMOVE_ALL_SEL_SCREEN_ITEMS

    Removes all elements from the selection screen. If there is one block, the complete block together with its contents is removed from the display.

Help Methods

CREATE_RANGE_TABLE

Method for creating a range table dynamically

SET_GLOBAL_OPTIONS

Specifies which buttons are to be visible