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

public class InfoPane

extends GridContainer

InfoPane is a UI pane that contains the commonly shared input fields: name, ID, ID prefix, description, master language.

Inner Class Summary

static class	InfoPane.OptionalControl OptionalControl Enum that holds the keys for the controls which are optional to be displayed.
static class	InfoPane.UIStrings UIStrings holds constants pointing to the pane's bundle keys.

Field Summary

static java.lang.String

INFO_PANE_KEY pane path key

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()
Constructor fills the visibility map, which contains references to the input fields that are optional for the wizard developer(object dependent).

InfoPane(java.util.Hashtable optionalComponentsVals)
Constructor used when the wizard developer wants to add controls which are optional and not included as default.

InfoPane(java.util.Hashtable optionalComponentsVals, int maxNameLength)
Constructor

InfoPane(int maxNameLength)
Constructor sets the maximum length for the name field.

Method Summary

java.util.List	getErrorMessages(IWizardContext context) the default implemention returns null
java.lang.String	getTitle(IWizardContext context) Set the title of a pane - this function is relevant only for panes.
protected void	myProcessInput(IWizardContext context)
protected void	mySetupComponent(IWizardContext context)

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 java.lang.String INFO_PANE_KEY

pane path key

Constructor Detail

InfoPane

public InfoPane()

Constructor fills the visibility map, which contains references to the input fields that are optional for the wizard developer(object dependent). The scope of the optional components is defined by the OptionalComponent enum inner class.

InfoPane

public InfoPane(java.util.Hashtable optionalComponentsVals)

Constructor used when the wizard developer wants to add controls which are optional and not included as default.

Usage example:

 public void setupWizard(IConfigurableWizard wizard, IPortalComponentProfile profile) {
 		HashMap infoOptionalMap = new HashMap();
 		infoOptionalTemplateMap.put(InfoPane.OptionalComponent.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 - map that contains the values of the optional controls

InfoPane

public InfoPane(int maxNameLength)

Constructor sets the maximum length for the name field. Should be used when there is need to override the default value provided by ObjectCreationWizardConstants

Parameters:

maxNameLength - the maximum length allowed for the name field

InfoPane

public InfoPane(java.util.Hashtable optionalComponentsVals,
                int maxNameLength)

Constructor

See Also:

InfoPane(java.util.Hashtable), InfoPane(int)

Method Detail

getTitle

public java.lang.String getTitle(IWizardContext context)

Description copied from interface: IWizardComponent

Set the title of a pane - this function is relevant only for panes. It won't have any effect if used in subcomponents.

Overrides:

getTitle in class AbstractWizardComponent

mySetupComponent

protected void mySetupComponent(IWizardContext context)

Overrides:

mySetupComponent in class GridContainer

myProcessInput

protected void myProcessInput(IWizardContext context)

Overrides:

myProcessInput in class GridContainer

getErrorMessages

public java.util.List getErrorMessages(IWizardContext context)

Description copied from class: AbstractWizardComponent

the default implemention returns null

Overrides:

getErrorMessages in class GridContainer

Following copied from interface: com.sapportals.admin.wizardframework.api.IWizardComponent

Returns:

- If this component was not propperly filled by the user return a list of error messages indicating the missing fields or inconsistencies, otherwise return null;