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

Deprecated. Use Admin Studio Wizard Framework, as described in Creating Administration Interfaces (Web Dynpro) on the Help Portal documentation (help.sap.com).

public class FinishPane
extends HTMLScriptComponent

The class that represents a finish pane displayed after a new object is created by a wizard.
The finish pane provides the following options:

• Open the editor for the new object.
• Rerun the wizard to create another object using the same template or PAR.
• Close the wizard and perform no other actions.

The finish pane also does the following:

• Displays to the end-user a completion message.
• Updates the tab caption in the pane.
• Refreshes the catalog node with the new object created.
• Saves the object.

Nested Class Summary

static class	FinishPane.FinishMessageType Deprecated. Use Admin Studio Wizard Framework, as described in Creating Administration Interfaces (Web Dynpro) on the Help Portal documentation (help.sap.com).
static class	FinishPane.FinishOptions Deprecated. Use Admin Studio Wizard Framework, as described in Creating Administration Interfaces (Web Dynpro) on the Help Portal documentation (help.sap.com).
static class	FinishPane.UIStrings Deprecated. Use Admin Studio Wizard Framework, as described in Creating Administration Interfaces (Web Dynpro) on the Help Portal documentation (help.sap.com).

Field Summary

static String	CHANGE_LIST Deprecated.
static String	FINISH_PANE_KEY Deprecated. The pane key used by the wizard in the state machine.

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

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Constructor Summary

FinishPane()
Deprecated. A blank constructor.

FinishPane(FinishPane.FinishOptions defaultValue)
Deprecated.

Method Summary

com.sapportals.htmlb.Component	getDisplay(IWizardContext context) Deprecated. Gets the HTMLB component that wraps the pane for display.
String	getScript(IWizardContext context) Deprecated. Gets a script from the wizard 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 String FINISH_PANE_KEY

Deprecated.

The pane key used by the wizard in the state machine.

See Also:

Constant Field Values

CHANGE_LIST

public static final String CHANGE_LIST

Deprecated.

See Also:

Constant Field Values

Constructor Detail

FinishPane

public FinishPane()

Deprecated.

A blank constructor.

FinishPane

public FinishPane(FinishPane.FinishOptions defaultValue)

Deprecated.

A constructor that creates a finish pane with the specified default value for the finish options. The finish options are:

• openEditor: Open the object's editor.
• rerunWizard: Run the wizard again to create another object using the same template.
• closeWizard: Close the wizard.

For example:

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

Parameters:

defaultValue - a default value

Method Detail

getScript

public String getScript(IWizardContext context)

Deprecated.

Description copied from class: HTMLScriptComponent

Gets a script from the wizard context.

Overrides:

getScript in class HTMLScriptComponent

Parameters:

context - the current wizard context

Returns:

the JavaScript script

getDisplay

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

Deprecated.

Gets the HTMLB component that wraps the pane for display.

• Shows a completion message and refreshes the content catalog node.
• Displays a radio button selection list for the end-user to select the action from the finish options.
• Sends the selected client event.

Specified by:

getDisplay in interface IWizardComponent

Overrides:

getDisplay in class HTMLScriptComponent

Parameters:

context - the current wizard context

Returns:

the component

See Also:

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

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/admin/api	api	EP-PIN