Customizing the Finish Pane

When the administrator clicks Finish in the wizard toolbar, the Finish pane is displayed if the useFinishPane() method returns a FinishPaneController object.

If null is returned, the Finish pane is not displayed, and the wizard closes.

Finish Pane Options

By default, the following options are displayed to the administrator in the Finish pane:

Open: Opens the newly created object. The location of the object is specified by the saveLocationParam context attribute and the object ID is specified by the objectID context attribute.
Restart: Restarts the wizard.
Close: Closes the wizard.

The following are the options displayed in the Finish pane:

This graphic is explained in the accompanying text.

Default Finish Pane

To display the default Finish pane, create a FinishPaneController object using the default constructor, and return this object in the useFinishPane() method, as follows:

Syntax Syntax

publiccom.sap.portal.adminstudio.wizardfwapi.FinishPaneController useFinishPane()
{
  //@@begin useFinishPane()
  FinishPaneController finishPaneController = newFinishPaneController();
  returnfinishPaneController;
  //@@end
}

End of the code.

Custom Finish Pane

To customize the Finish pane, call configuration methods on the FinishPaneController object before returning it.

The following example creates a Finish pane that displays the Restart and Close options, but hides the Open option.

Syntax Syntax

publiccom.sap.portal.adminstudio.wizardfwapi.FinishPaneController useFinishPane( )  {
  //@@begin useFinishPane()
  FinishPaneController finishPaneController = newFinishPaneController();
  finishPaneController.setUseOpenEditorOption(false);
  finishPaneController.setUseCloseWizardOption(true);
  finishPaneController.setUseRestartWizardOption(true);
  returnfinishPaneController; 
   //@@end
}

End of the code.

The following are the options displayed in the Finish pane:

This graphic is explained in the accompanying text.

Note Note

If you did not include the Finish pane in your wizard, it is not displayed and one of the two happens:

If there are still panes in the wizard, the road map control automatically moves to the last step and the wizard developer should trigger the navigation to its last pane, for consistency with the road map control,
If the last step is reached, the road map and the toolbar control disappear, so you need to provide means for closing the wizard.

End of the note.