The frameworkFormHandler interface contains the following properties, which correspond to the properties contained by a framework action:
Property | Description |
|---|---|
| Property that identifies the next steps menu to render for the action |
| Array property that lists the panels to refresh for the action |
| Array property that lists the panel stacks to refresh for the action |
| Property that specifies a tab change for actions that require a tab change |
| Array property that lists the tree tables to refresh for the action |
Any custom form handler that needs to perform framework-level actions should implement the frameworkFormHandler interface (or extend frameworkBaseFormHandler) and register itself in formHandlerDefinitions.jsp to become framework-enabled. The formHandlerDefinitions.jsp page performs the following tasks:
registers all framework-enabled form handlers for the application
determines the active form handler for the current request when executed
sets the active framework-enabled form handler to the request-scoped
frameworkFormHandlervariable
A framework-enabled form handler defines (or inherits) the following subsets of properties:
framework properties implemented from the
frameworkFormHandlerinterface and processed byframework.jspand other framework-aware pages to render the frameworkcustom properties processed internally by the specific panels targeted by the action
All framework actions are handled by framework.jsp, which should be identified in the successUrl attribute for any framework action. The framework.jsp page includes the following framework definitions:
the panel stack definitions in
panelStackDefinitions.jspthe panel definitions in
panelDefinitions.jspthe framework-enabled form handler definitions in
formHandlerDefinitions.jspthe next steps definitions in
nextStepsDefinitions.jsp
