com.sap.portal.admin.wizard.panes
Class FinishPane

java.lang.Object
  |
  +--com.sapportals.admin.wizardframework.components.AbstractWizardComponent
        |
        +--com.sapportals.admin.wizardframework.components.HTMLScriptComponent
              |
              +--com.sap.portal.admin.wizard.panes.FinishPane

All Implemented Interfaces:

IDependencyObject, IWizardComponent

public class FinishPane

extends HTMLScriptComponent

FinishPane contains info message that informs the end-user that the object was created, and displays 3 Radio Buttons that offers finish actions:

1. Open object editor - opens the new object's editor in place of the wizard.
2. Restart the wizard starts the wizard again using the same template or par. (go back to the first pane after the template selection, i.e. the target object input is maintained).
3. Close the wizard - do neither of the first 2 options, just close the wizard.

In addition, it sends the appdesigner client events through the EPCM interface:

• Display to the end-user a completion message.
• Update the tab caption.
• Refresh the catalog node with the new object.
• Save.

Inner Class Summary

static class	FinishPane.FinishOptions Enum that holds the options to be performed after the wizard completion.
static class	FinishPane.UIStrings UIStrings holds constants pointing to the pane's bundle keys.

Field Summary

static java.lang.String

FINISH_PANE_KEY pane path key

Fields inherited from class com.sapportals.admin.wizardframework.components.AbstractWizardComponent

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Constructor Summary

FinishPane()
Constructor

FinishPane(FinishPane.FinishOptions defaultValue)
Constructor Used to set the default value of the radio button list after object creation.

Method Summary

com.sapportals.htmlb.Component	getDisplay(IWizardContext context) Setting pane's display and script section: show completion message and refresh content catalog node.
java.lang.String	getScript(IWizardContext context)

Methods inherited from class com.sapportals.admin.wizardframework.components.HTMLScriptComponent

setScript

Methods inherited from class com.sapportals.admin.wizardframework.components.AbstractWizardComponent

clearIfInconsistent, doAfterSubmit, doBeforeDisplay, getControlInFocus, getDescription, getErrorMessages, getPath, getProperty, getTitle, init, isComplete, isInitialized, isMandatory, processInput, setMandatory, setPath, setProperty, setTempProperty, setupComponent, wasChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FINISH_PANE_KEY

public static final java.lang.String FINISH_PANE_KEY

pane path key

Constructor Detail

FinishPane

public FinishPane()

Constructor

FinishPane

public FinishPane(FinishPane.FinishOptions defaultValue)

Constructor Used to set the default value of the radio button list after object creation. The optional values are:

1. Open the object's editor - "openEditor".
2. Run the wizard again to create another object of the same template - "rerunWizard".
3. Close the wizard - "closeWizard".

Usage example:

 public void setupWizard(IConfigurableWizard wizard, IPortalComponentProfile profile) {
 		Object[] finishPaneArgs = new Object[] { FinishPane.FinishOptions.Open4Edit };
  	wizard.addPane(FinishPane.FINISH_PANE_KEY, FinishPane.class.getName(), infoPaneArgs);
		<The rest of the code>
 }
 

Parameters:

defaultValue - default value to be set, defined by the enum class.

Method Detail

getScript

public java.lang.String getScript(IWizardContext context)

Overrides:

getScript in class HTMLScriptComponent

getDisplay

public com.sapportals.htmlb.Component getDisplay(IWizardContext context)

Setting pane's display and script section:

• show completion message and refresh content catalog node.
• radio button selection list from where the end-user would select the action
• send the selected client event.

Overrides:

getDisplay in class HTMLScriptComponent

See Also:

IWizardComponent.getDisplay(com.sapportals.admin.wizardframework.api.IWizardContext)