Interface PreRenderCallback
-
public interface PreRenderCallbackAn interface that allows for a callback from the server prior to the plugin specific user interface screen being rendered. The current configuration data is passed with the call which allows the plugin some opportunity to change the interface components based on values entered by the user.- Since:
- 6.6
- See Also:
GuiConfigDescriptor.addPreRenderCallback(PreRenderCallback)
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default voidcallback(List<FieldDescriptor> fields, List<FieldDescriptor> advancedFields, List<TableDescriptor> tables, Configuration config)This method will be invoked by the PingFederate server just prior to rendering the custom user interface screen for the plugin which gives the plugin an opportunity to update the UI components based on the configuration data at the given time.default voidsummaryPageCallback(List<ReadOnlyDescriptor> summaryDescriptors, Configuration config)This method will be invoked by the PingFederate server just prior to rendering the custom user interface summary screen for the plugin which gives the plugin an opportunity to update the UI components based on the configuration data at the given time.
-
-
-
Method Detail
-
callback
default void callback(List<FieldDescriptor> fields, List<FieldDescriptor> advancedFields, List<TableDescriptor> tables, Configuration config)
This method will be invoked by the PingFederate server just prior to rendering the custom user interface screen for the plugin which gives the plugin an opportunity to update the UI components based on the configuration data at the given time.
Changing the option values in a select box based on the value from another field, for example, is something that can be done via this callback.
The order and even the presence of fields and tables can also be changed. Names are used to uniquely identify the descriptors of the user interface elements.- Parameters:
fields- The list of descriptors that make up the main configuration elements of the screen. Changes to the list (adding, removing or reordering) will be reflected in the UI screen.advancedFields- The list of descriptors that make up the advanced configuration elements of the screen. Changes to the list (adding, removing or reordering) will be reflected in the UI screen.tables- The list of descriptors that make up the main table elements of the screen. Changes to the list (adding, removing or reordering) will be reflected in the UI screen.config- the most recent configuration data from the user interface screen or, when first loading a previously saved configuration instance, data from disk that will be used to populate the user interface screen. Note that the data may be incomplete because this can be invoked prior to all form data being entered and before full page validation has been applied.- Since:
- 6.6
-
summaryPageCallback
default void summaryPageCallback(List<ReadOnlyDescriptor> summaryDescriptors, Configuration config)
This method will be invoked by the PingFederate server just prior to rendering the custom user interface summary screen for the plugin which gives the plugin an opportunity to update the UI components based on the configuration data at the given time.
The order and even the presence of descriptors can also be changed. Names are used to uniquely identify the descriptors of the user interface elements.- Parameters:
summaryDescriptors- The list of descriptors that make up the summary elements of the screen. Changes to the list (adding, removing or reordering) will be reflected in the UI screen.config- the most recent configuration data from the user interface screen or, when first loading a previously saved configuration instance, data from disk that will be used to populate the user interface screen.- Since:
- 9.1
-
-