This is used to display information relating to a dataset. It is implemented using the Web Dynpro componentFPM_QUICKVIEW_DATASET.
A quickview can be assigned to a particular element of a generic UI building block (GUIBB) component inside an FPM application. For example, a quickview could be assigned to a particular column in a table (implemented using a list component). As the user hovers the mouse over the rows in this column, the same quickview is displayed for each row, but the data inside the quickview changes.
The information displayed in a quickview at runtime is determined both by the feeder class assigned to the configuration of the Web Dynpro components mentioned above, and by the settings inside the FPM configuration editor, FLUID.
Quickviews can be exchanged with other quickviews dynamically. Therefore, quickviews that were not assigned to a particular GUIBB at configuration may still appear on that GUIBB at runtime.
Dataset Quickview
You configure a dataset quickview component using the FPM configuration editor, FLUID.
IF_FPM_GUIBB_QV_DATASET Interface
The following tables describe the methods (and their attributes) of the IF_FPM_GUIBB_QV_DATASET interface.
If your application does not need a particular method, implement an empty method, otherwise this will cause a system dump.
You must implement at least the following methods: GET_DEFINITION
GET_DATA GET_DEFINITION:
Allows the feeder to provide all necessary information for configuring a Dataset Quickview: the list of available fields and their properties and the list of actions (FPM events).
Parameter Description
EO_FIELD_CATALOG Is of type CL_ABAP_TABLEDESCR. The components of this object are the available fields. The simplest way to provide a field catalog is to create a table of a flat DDIC structure containing all fields and then get the field catalog via
eo_field_catalog ?=
CL_ABAP_TABLEDESCR=>describe_by_name( <name> ) The Dataset Quickview supports only flat
structures. When using deep structures, only the highest level fields are available.
ET_FIELD_DESCRIPTION Here you can provide the additional information needed to create the Dataset Quickview, for example a link reference, LINK_REF
EV_STATELESS_ENABLED Set feeder to stateless, so that it can be used in stateless scenario (UI5)
ES_MESSAGE A list of messages which shall be displayed in the message region.
INITIALIZE:
Called at runtime when the Dataset Quickview is created. It is the first feeder method which is called from FPM.
Parameter Description
IT_PARAMETER Contains a list of the feeder parameters and
the values for them specified in the configuration.
IO_APP_PARAMETER Application parameter
IV_COMPONENT_NAME Web Dynpro: Component Name
IS_CONFIG_KEY Key Components of Configuration Tables
IV_INSTANCE_ID Instance ID
FLUSH:
The first feeder method which is called during an event loop. Whenever an FPM event is triggered (this includes all round trips caused by the Dataset Quickview itself) this method is called. Use it to forward changed Dataset Quickview data to other components in the same application.
Parameter Description
IT_CHANGE_LOG Lists all changes made by the user.
IS_DATA Is a structure containing the changed data
PROCESS_EVENT:
Called within the FPM event loop, it forwards the FPM PROCESS_EVENT to the feeder class. Here the event processing can take place and this is where the event can be canceled or deferred.
Parameter Description
IO_EVENT The FPM event which is to be processed
IV_RAISED_BY_OWN_UI ABAP_TRUE in case the event is raised by own UI
EV_RESULT The result of the event processing. There are 3 possible values: EV_RESULT = IF_FPM_CONSTANTS=>GC_EVENT_RESULT-OK EV_RESULT = IF_FPM_CONSTANTS=>GC_EVENT_RESULT- FAILED. EV_RESULT = IF_FPM_CONSTANTS=>GC_EVENT_RESULT-DEFER ET_MESSAGES A list of messages which shall be displayed in the
message region.
GET_DATA:
Called within the FPM event loop and forwards the FPM PROCESS_BEFORE_OUTPUT event to the feeder class. Here you specify the Quickview data after the event has been processed.
Parameter Description
IT_SELECTED_FIELDS The list of fields necessary for the Quickview rendering. Provide only the data for the fields listed in this table; all other fields are neither visible at runtime nor used as reference for visible fields.
IV_RAISED_BY_OWN_UI ABAP_TRUE in case the event is raised by own UI
IV_KEY Serialized key for the Quickview
ET_MESSAGES A list of messages which shall be displayed
in the message area.
EV_DATA_CHANGED For performance reasons, the GUIBB adjusts the data in the Quickview only if the data has been changed. To indicate this, set this flag whenever you change the data to be
displayed within this feeder.
CS_DATA The Quickview data to be changed.
GET_DEFAULT_CONFIG:
Call this if you want to have a default configuration. Use it to call pre-configured Quickview configurations when a user starts the FPM Configuration Editor. This avoids the user, who uses a feeder class to create a Quickview, having to create it from the beginning.
Parameter Description
IO_CONFIG Of type
IF_FPM_GUIBB_QV_DATASET_CONFIG: This object provides the API to create a default configuration
CHECK_CONFIG:
Call this if you want to make your own application-specific checks on the configuration in the FPM Configuration Editor immediately before saving.
Parameter Description
IO_CONFIG Of type IF_FPM_GUIBB_QV_DATASET_CONFIG
This object provides the API to read the configuration to be saved.
ET_MESSAGES A list of messages which shall be displayed
in the message region.