com.sap.portal.admin.wizard.panes

Class InfoPane

java.lang.Object
  com.sapportals.admin.wizardframework.components.AbstractWizardComponent
      com.sapportals.admin.wizardframework.components.GridContainer
          com.sap.portal.admin.wizard.panes.InfoPane

All Implemented Interfaces:

IDependencyObject, IWizardComponent, IWizardComponentContainer

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

public class InfoPane
extends GridContainer

The class that represents the info pane for entering general properties for the object. Provides a user interface to enable the administrator to enter standard fields for all objects. The properties include: name, ID, ID prefix, description, and master language.

Nested Class Summary

static class	InfoPane.OptionalControl Deprecated. Use Admin Studio Wizard Framework, as described in Creating Administration Interfaces (Web Dynpro) on the Help Portal documentation (help.sap.com).
static class	InfoPane.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

protected static String	INFO_COLLECTION_CONTROL_KEY Deprecated.
protected static String	INFO_DESCRIPTION_MULTILINE_KEY Deprecated.
protected static String	INFO_DOMAIN_CONTROL_KEY Deprecated.
protected static String	INFO_ID_NAMESPACE_TEXTBOX_KEY Deprecated.
protected static String	INFO_ID_TEXTBOX_KEY Deprecated.
protected static String	INFO_MASTER_LANGUAGE_SELECTION_KEY Deprecated.
protected static String	INFO_NAME_TEXTBOX_KEY Deprecated.
static String	INFO_PANE_KEY Deprecated. The pane key, which is used by the wizard in the state machine.

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

GRID

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

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Constructor Summary

InfoPane()
Deprecated. A blank constructor.

InfoPane(Hashtable optionalComponentsVals)
Deprecated. A constructor that creates an info pane with optional controls that are not included by default.

InfoPane(Hashtable optionalComponentsVals, int maxNameLength)
Deprecated. A constructor that creates an info pane with optional controls and sets a specified maximum length for the name field.

InfoPane(int maxNameLength)
Deprecated. A constructor that creates an info pane that sets a specified maximum length for the name field.

Method Summary

protected void	createDescriptionControl(int index, IWizardContext context) Deprecated. Creates description input field.
protected void	createIDControl(int index, IWizardContext context) Deprecated. Creates id input field.
protected void	createMasterLanguageControl(int index, IWizardContext context) Deprecated. Creates dropDown list to select the master language from.
protected void	createNameControl(int index, IWizardContext context) Deprecated. Creates name input field.
protected void	createNamespaceControl(int index, IWizardContext context) Deprecated. Creates prefix input field.
protected void	createOriginalLocaleControls(int index, String compKey, String attrId, IWizardContext context) Deprecated.
List	getErrorMessages(IWizardContext context) Deprecated. Validates the data for the pane.
String	getTitle(IWizardContext context) Deprecated. Gets a component title.
protected void	myProcessInput(IWizardContext context) Deprecated. Saves to the data model the data from any HTMLB controls created in the pane.
protected void	mySetupComponent(IWizardContext context) Deprecated. Implement this method to create your own setup for a component.

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

addComponent, addComponent, clearIfInconsistent, delegateDoBeforeDisplay, delegateProcessInput, delegateSetupComponent, doAfterSubmit, doBeforeDisplay, getCell, getComponent, getControlInFocus, getDisplay, getGrid, getPath, init, isInitialized, myDoBeforeDisplay, processInput, setPath, setSize, setupComponent, wasChanged

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

getDescription, getProperty, isComplete, isMandatory, setMandatory, setProperty, setTempProperty

Methods inherited from class java.lang.Object

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

Field Detail

INFO_PANE_KEY

public static final String INFO_PANE_KEY

Deprecated.

The pane key, which is used by the wizard in the state machine.

See Also:

Constant Field Values

INFO_ID_TEXTBOX_KEY

protected static final String INFO_ID_TEXTBOX_KEY

Deprecated.

See Also:

Constant Field Values

INFO_ID_NAMESPACE_TEXTBOX_KEY

protected static final String INFO_ID_NAMESPACE_TEXTBOX_KEY

Deprecated.

See Also:

Constant Field Values

INFO_NAME_TEXTBOX_KEY

protected static final String INFO_NAME_TEXTBOX_KEY

Deprecated.

See Also:

Constant Field Values

INFO_MASTER_LANGUAGE_SELECTION_KEY

protected static final String INFO_MASTER_LANGUAGE_SELECTION_KEY

Deprecated.

See Also:

Constant Field Values

INFO_DESCRIPTION_MULTILINE_KEY

protected static final String INFO_DESCRIPTION_MULTILINE_KEY

Deprecated.

See Also:

Constant Field Values

INFO_DOMAIN_CONTROL_KEY

protected static final String INFO_DOMAIN_CONTROL_KEY

Deprecated.

See Also:

Constant Field Values

INFO_COLLECTION_CONTROL_KEY

protected static final String INFO_COLLECTION_CONTROL_KEY

Deprecated.

See Also:

Constant Field Values

Constructor Detail

InfoPane

public InfoPane()

Deprecated.

A blank constructor.

InfoPane

public InfoPane(Hashtable optionalComponentsVals)

Deprecated.

A constructor that creates an info pane with optional controls that are not included by default.
For example:

 public void setupWizard(IConfigurableWizard wizard, IPortalComponentProfile profile) {
                HashMap infoOptionalMap = new HashMap();
                infoOptionalTemplateMap.put(InfoPane.OptionalControl.NameSpace, Boolean.FALSE);
                Object[] infoArgs = new Object[] { infoOptionalMap };
                wizard.addPane(InfoPane.INFO_PANE_KEY, InfoPane.class.getName(), infoArgs);
        //The rest of the code 
 }
 

Parameters:

optionalComponentsVals - a map that contains the optional controls

InfoPane

public InfoPane(int maxNameLength)

Deprecated.

A constructor that creates an info pane that sets a specified maximum length for the name field. This method should be used when there is a need to override the default value provided by ObjectCreationWizardConstants

Parameters:

maxNameLength - a maximum length for the name field

InfoPane

public InfoPane(Hashtable optionalComponentsVals,
                int maxNameLength)

Deprecated.

A constructor that creates an info pane with optional controls and sets a specified maximum length for the name field.

Parameters:

optionalComponentsVals - a map that contains the values of the optional controls

maxNameLength - a maximum length for the name field

Method Detail

getTitle

public String getTitle(IWizardContext context)

Deprecated.

Description copied from class: AbstractWizardComponent

Gets a component title.

Specified by:

getTitle in interface IWizardComponent

Overrides:

getTitle in class AbstractWizardComponent

Parameters:

context - the current wizard context

Returns:

the component title

mySetupComponent

protected void mySetupComponent(IWizardContext context)

Deprecated.

Description copied from class: GridContainer

Implement this method to create your own setup for a component.

Overrides:

mySetupComponent in class GridContainer

Parameters:

context - the current wizard context

createNameControl

protected void createNameControl(int index,
                                 IWizardContext context)

Deprecated.

Creates name input field.

Parameters:

index - row index

context - wizard context

createIDControl

protected void createIDControl(int index,
                               IWizardContext context)

Deprecated.

Creates id input field.

Parameters:

index - row index

context - wizard context

createNamespaceControl

protected void createNamespaceControl(int index,
                                      IWizardContext context)

Deprecated.

Creates prefix input field.

Parameters:

index - row index

context - wizard context

createMasterLanguageControl

protected void createMasterLanguageControl(int index,
                                           IWizardContext context)

Deprecated.

Creates dropDown list to select the master language from.

Parameters:

index - row index

context - wizard context

createDescriptionControl

protected void createDescriptionControl(int index,
                                        IWizardContext context)

Deprecated.

Creates description input field.

Parameters:

index - row index

context - wizard context

createOriginalLocaleControls

protected void createOriginalLocaleControls(int index,
                                            String compKey,
                                            String attrId,
                                            IWizardContext context)

Deprecated.

myProcessInput

protected void myProcessInput(IWizardContext context)

Deprecated.

Description copied from class: GridContainer

Saves to the data model the data from any HTMLB controls created in the pane.

Overrides:

myProcessInput in class GridContainer

Parameters:

context - the current wizard context

getErrorMessages

public List getErrorMessages(IWizardContext context)

Deprecated.

Description copied from class: GridContainer

Validates the data for the pane. If the data is valid, the method returns null. If the data is not valid, the method returns a list of error messages.

Specified by:

getErrorMessages in interface IWizardComponent

Overrides:

getErrorMessages in class GridContainer

Parameters:

context - the current wizard context

Returns:

a list of error messages

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