Uses of Interface
com.sapportals.admin.wizardframework.api.IWizardContext

Packages that use IWizardContext

com.sap.portal.admin.studio
com.sap.portal.admin.wizard
com.sap.portal.admin.wizard.handlers
com.sap.portal.admin.wizard.panes
com.sap.portal.admin.wizard.validators
com.sapportals.admin.wizardframework
com.sapportals.admin.wizardframework.api
com.sapportals.admin.wizardframework.components
com.sapportals.admin.wizardframework.components.localization
com.sapportals.admin.wizardframework.components.tableview
com.sapportals.admin.wizardframework.templates
com.sapportals.admin.wizardframework.util

Uses of IWizardContext in com.sap.portal.admin.studio

Methods in com.sap.portal.admin.studio with parameters of type IWizardContext

Component	PropertyEditorComponent.getDisplay(IWizardContext context)
void	PropertyEditorComponent.setObjectId(String objectId, IWizardContext context)
int	PropertyEditorComponent.getWidth(IWizardContext context) Get the width for the property editor
void	PropertyEditorComponent.processInput(IWizardContext context)
protected IPropertyEditor	PropertyEditorComponent.getPropertyEditor(IWizardContext context) Get the property editor

Uses of IWizardContext in com.sap.portal.admin.wizard

Methods in com.sap.portal.admin.wizard with parameters of type IWizardContext

String	IBasicObjectCreationService.getBundleString(String key, IWizardContext context) Gets a string from the resource bundle.
String	IBasicObjectCreationService.getAttributeValueFromTarget(String attrId, IWizardContext context) Gets an attribute value from the target object (template or portal component), in order to retain the concept of inheritance (e.g description, locale, etc).
String	IBasicObjectCreationService.getMetaAttributeValueFromTarget(String attrId, String metaAttrId, IWizardContext context) Gets a meta-attribute value from the target object (template or portal component), in order to retain the concept of inheritance.
void	IBasicObjectCreationService.setComponentAsAttribute(AbstractInputComponent component, String attrId, boolean addAsSummary, IWizardContext context) Set the specified component's value to be an attribute for the object.
void	IBasicObjectCreationService.setSummaryCaption(String attrId, String caption, IWizardContext context) Sets the summary caption resource bundle key.
Map	IBasicObjectCreationService.getAttributes2SummariesMap(IWizardContext context) Returns a map that holds the following entries: Key = attribute id (String), value = Pair{summary caption, value}.
String	IBasicObjectCreationService.getDefaultHandlerKey(IWizardContext context)
String	IBasicObjectCreationService.getSaveLocationParam(IWizardContext context) Gets the object's save location (where parameter from Portal Content Catalog).
String	IBasicObjectCreationService.getTargetIdParam(IWizardContext context) Gets the target object id (what parameter from Portal Content Catalog), implying the template/par id.
String	IBasicObjectCreationService.getObjectTypeParam(IWizardContext context) Gets the new object's type (ComponentType or com.sap.portal.ComponentType parameter from Portal Content Catalog).
String	IBasicObjectCreationService.getCreateModeParam(IWizardContext context) Gets the object's OCLASS (oClass parameter from Portal Content Catalog), implying whether it is based on a template or a par.
String	IBasicObjectCreationService.getEditorIdParam(IWizardContext context) Gets the editor id param(editorID parameter from Portal Content Catalog).
void	IBasicObjectCreationService.setPPLogger(String subCategoryName, String locationName, IWizardContext context) Deprecated. wizards will not be able to set their logger using the toolkit, they would have to maintain their logger internally.
PPLogger	IBasicObjectCreationService.getPPLogger(IWizardContext context) Deprecated. wizards will not be able to get their logger from the toolkit, they would have to maintain their logger internally.
void	AbstractPCMWizard.initWizardSession(IWizardContext context) Checks if there are any strings that the wizard developer has override, by calling AbstractPCMWizard.setUIStrings(Map), and puts them in the session.
void	AbstractPCMWizard.finalizeSummaries(Map summaries, IWizardContext context) Finalizes the summaries.
void	AbstractPCMWizard.finalizeDescriptor(Map attributes, Object descriptor, IWizardContext context) Finalizes the descriptor before saving.
void	AbstractPCMWizard.finalizeObject(IWizardContext context) Finalize the new saved object.

Uses of IWizardContext in com.sap.portal.admin.wizard.handlers

Methods in com.sap.portal.admin.wizard.handlers with parameters of type IWizardContext

Object	SystemHandler.createObjectDescriptor(String targetId, CreateMethod method, IWizardContext context)
Object	ProducerPortalHandler.createObjectDescriptor(String targetId, CreateMethod method, IWizardContext context)
Object	PageHandler.createObjectDescriptor(String targetId, CreateMethod method, IWizardContext context)
Object	LayoutHandler.createObjectDescriptor(String targetId, CreateMethod method, IWizardContext context)
Object	IViewHandler.createObjectDescriptor(String targetId, CreateMethod method, IWizardContext context)
Object	IObjectTypeHandler.createObjectDescriptor(String targetId, CreateMethod method, IWizardContext context) Creates a new object descriptor that is in charge of storing the object data.
void	IObjectTypeHandler.saveObject(Object descriptor, IWizardContext context) Saves the object in the persistence layer.
void	AbstractObjectTypeHandler.saveObject(Object descriptor, IWizardContext context)

Uses of IWizardContext in com.sap.portal.admin.wizard.panes

Methods in com.sap.portal.admin.wizard.panes with parameters of type IWizardContext

Component	WriteProtectPane.getDisplay(IWizardContext context) Creates the UI containing the Write Protect message
String	WriteProtectPane.getScript(IWizardContext context) Creates the script to close the Wizard
protected void	SummaryPane.mySetupComponent(IWizardContext context)
protected Component	SummaryPane.getSummariesGrid(IWizardContext context) Gets the summaries map from the session, sorts it alphabetically and returns htmlb component containing the summaries.
String	SummaryPane.getTitle(IWizardContext context)
void	SavePane.doAfterSubmit(IWizardContext context) Saves the new object into the persistence, using the registered handler, in 5 steps: Gets the handler from the session.
void	InitPane.doAfterSubmit(IWizardContext context) Sets the wizard's title.
String	InfoPane.getTitle(IWizardContext context)
protected void	InfoPane.mySetupComponent(IWizardContext context)
protected void	InfoPane.myProcessInput(IWizardContext context)
List	InfoPane.getErrorMessages(IWizardContext context)
String	FinishPane.getScript(IWizardContext context)
Component	FinishPane.getDisplay(IWizardContext context) Setting pane's display and script section: show completion message and refresh content catalog node.

Uses of IWizardContext in com.sap.portal.admin.wizard.validators

Methods in com.sap.portal.admin.wizard.validators with parameters of type IWizardContext

boolean	ObjectIdValidator.isValid(Object key, IWizardContext context) Performs 2 checks for the object ID: Does the same ID (including prefix) already exist under the same folder.
boolean	ObjectIdValidator.isValid(String prefix, String id, IWizardContext context) Performs separate id check for the prefix and the id, allowing dots in the prefix and forbidding them in the ID.
List	ObjectIdValidator.getErrorKeyList(IWizardContext context)
protected boolean	ObjectIdValidator.idExists(String id, IWizardContext context) Checks if the provided ID already exists in the specified location (including the prefix).
boolean	IValidator.isValid(Object key, IWizardContext context) Checks to see if the required field/input/key/value is valid/correct/any other check.
List	IValidator.getErrorKeyList(IWizardContext context) Gets a list that holds the resource bundle keys for the collected errors in case the validity check failed.

Uses of IWizardContext in com.sapportals.admin.wizardframework

Methods in com.sapportals.admin.wizardframework with parameters of type IWizardContext

void	AbstractStaticWizard.initWizardSession(IWizardContext ctx) Deprecated.
void	AbstractDynamicWizard.initWizardSession(IWizardContext ctx)

Uses of IWizardContext in com.sapportals.admin.wizardframework.api

Methods in com.sapportals.admin.wizardframework.api with parameters of type IWizardContext

IWizardComponent	IWizardStructure.getComponent(String componentPath, IWizardContext ctx) Get a component of from the structure of this wizard.
void	IWizardConfigurator.initWizardSession(IWizardContext context)
String	IWizardComponent.getTitle(IWizardContext ctx) Set the title of a pane - this function is relevant only for panes.
String	IWizardComponent.getDescription(IWizardContext ctx) Set the description of a pane - this function is relevant only for panes.
void	IWizardComponent.setupComponent(IWizardContext ctx) setup the component here. if this component is a container add all subcomponents here
boolean	IWizardComponent.isInitialized(IWizardContext context)
void	IWizardComponent.init(IWizardContext context) initialize this component.
void	IWizardComponent.doBeforeDisplay(IWizardContext context) Do any preparations, that may be needed before display.
Component	IWizardComponent.getDisplay(IWizardContext context) get the htmlb display for this component.
void	IWizardComponent.processInput(IWizardContext context) read the user input from the submitted form here and store it in the session.
void	IWizardComponent.doAfterSubmit(IWizardContext context) Actions performed after user input was collected should be placed into this function.
List	IWizardComponent.getErrorMessages(IWizardContext context)
Component	IWizardComponent.getControlInFocus(IWizardContext ctx)
void	IDependencyObject.wasChanged(IWizardContext context) classes implementing IDependencyObject should call this function each time the object state is changed (e.g. from all of their set...() methods)
void	IDependencyObject.clearIfInconsistent(String changedObjectKey, IWizardContext context) the framework will call this method when an object this object depends on was changed.
boolean	ICondition.isTrue(IWizardContext context) evaluate this condition against the given wizard context

Uses of IWizardContext in com.sapportals.admin.wizardframework.components

Methods in com.sapportals.admin.wizardframework.components with parameters of type IWizardContext

boolean	WizardComponentContainer.isInitialized(IWizardContext context)
void	WizardComponentContainer.init(IWizardContext context)
void	WizardComponentContainer.doBeforeDisplay(IWizardContext context)
void	WizardComponentContainer.processInput(IWizardContext context)
void	WizardComponentContainer.doAfterSubmit(IWizardContext context)
Component	WizardComponentContainer.getDisplay(IWizardContext context)
void	WizardComponentContainer.wasChanged(IWizardContext context)
void	WizardComponentContainer.clearIfInconsistent(String changedObjectKey, IWizardContext context)
List	WizardComponentContainer.getErrorMessages(IWizardContext context)
boolean	TextInputComponent.isInitialized(IWizardContext ctx)
void	TextInputComponent.init(IWizardContext ctx)
void	TextInputComponent.setValue(String newValue, IWizardContext context)
void	TextInputComponent.processInput(IWizardContext context) Store the value from the htmlb display in the session.
void	TextInputComponent.doAfterSubmit(IWizardContext context)
void	TextInputComponent.wasChanged(IWizardContext context)
void	TextInputComponent.clearIfInconsistent(String changedObject, IWizardContext ctx)
Component	TextInputComponent.getControlInFocus(IWizardContext ctx)
void	RadioButtonSelectionComponent.processInput(IWizardContext context) reads the new value from the submitted form and stores it in the session
String	RadioButtonSelectionComponent.getValue(IWizardContext context)
String	RadioButtonSelectionComponent.getValueTitle(IWizardContext context)
boolean	RadioButtonSelectionComponent.setValue(String newValue, IWizardContext context) set this component's value to newValue
void	ProgressBarComponent.doBeforeDisplay(IWizardContext ctx)
Component	ProgressBarComponent.getDisplay(IWizardContext ctx)
void	ProgressBarComponent.processInput(IWizardContext ctx)
String	ProgressBarComponent.getTitle(IWizardContext ctx)
void	ProgressBarComponent.doAfterSubmit(IWizardContext ctx)
void	MultiSelectionComponent.mySetupComponent(IWizardContext ctx)
Component	MultiSelectionComponent.getDisplay(IWizardContext ctx) Sorry, no documentation comment here
void	MultiSelectionComponent.myProcessInput(IWizardContext ctx) Store the value from the htmlb display in the session.
void	MultiSelectionComponent.doAfterProcess(IWizardContext ctx)
boolean	MultiSelectionComponent.isComplete(IWizardContext context)
List	MultiSelectionComponent.getErrorMessages(IWizardContext context) Get the error messages for this component.
void	MultiSelectionComponent.clearIfInconsistent(String changedObjectKey, IWizardContext ctx)
void	MultilineInputComponent.setValue(String newValue, IWizardContext context)
void	MultilineInputComponent.processInput(IWizardContext context) Store the value from the htmlb display in the session.
void	MultilineInputComponent.doAfterSubmit(IWizardContext context)
void	MultilineInputComponent.wasChanged(IWizardContext context)
Component	MultilineInputComponent.getControlInFocus(IWizardContext ctx)
void	ListSelectionComponent.processInput(IWizardContext context) reads the new value from the submitted form and stores it in the session
List	ListSelectionComponent.getValue(IWizardContext context)
boolean	ListSelectionComponent.setValue(List newValue, IWizardContext context) set this component's value to newValue
Group	ListDisplayComponent.getGroupComponent(IWizardContext ctx)
Component	ListDisplayComponent.getDisplay(IWizardContext ctx)
void	ListDisplayComponent.clearIfInconsistent(String changedObject, IWizardContext ctx)
Component	HTMLScriptComponent.getDisplay(IWizardContext ctx)
void	HTMLScriptComponent.setScript(String newScript, IWizardContext ctx)
String	HTMLScriptComponent.getScript(IWizardContext ctx)
Component	HtmlbComponentWrapper.getDisplay(IWizardContext ctx)
Component	HtmlbComponentWrapper.getSubmittedComponent(IWizardContext ctx)
Group	Group.getGroup(IWizardContext ctx)
Component	Group.getDisplay(IWizardContext ctx)
void	Group.clearIfInconsistent(String changedObjectKey, IWizardContext ctx)
void	GridContainer.setupComponent(IWizardContext context)
protected void	GridContainer.delegateSetupComponent(IWizardContext context)
protected void	GridContainer.mySetupComponent(IWizardContext context)
boolean	GridContainer.isInitialized(IWizardContext context)
void	GridContainer.init(IWizardContext context)
void	GridContainer.doBeforeDisplay(IWizardContext context)
protected void	GridContainer.delegateDoBeforeDisplay(IWizardContext context)
protected void	GridContainer.myDoBeforeDisplay(IWizardContext ctx)
void	GridContainer.processInput(IWizardContext ctx)
protected void	GridContainer.delegateProcessInput(IWizardContext ctx)
protected void	GridContainer.myProcessInput(IWizardContext ctx)
void	GridContainer.doAfterSubmit(IWizardContext context)
GridLayout	GridContainer.getGrid(IWizardContext ctx)
GridLayoutCell	GridContainer.getCell(int row, int column, IWizardContext ctx)
Component	GridContainer.getDisplay(IWizardContext context)
void	GridContainer.wasChanged(IWizardContext context)
void	GridContainer.clearIfInconsistent(String changedObjectKey, IWizardContext context)
List	GridContainer.getErrorMessages(IWizardContext context)
Component	GridContainer.getControlInFocus(IWizardContext ctx)
void	FlowContainer.setupComponent(IWizardContext context)
protected void	FlowContainer.delegateSetupComponent(IWizardContext context)
protected void	FlowContainer.mySetupComponent(IWizardContext context)
boolean	FlowContainer.isInitialized(IWizardContext context)
void	FlowContainer.init(IWizardContext context)
void	FlowContainer.doBeforeDisplay(IWizardContext context)
protected void	FlowContainer.delegateDoBeforeDisplay(IWizardContext context)
protected void	FlowContainer.myDoBeforeDisplay(IWizardContext ctx)
void	FlowContainer.processInput(IWizardContext ctx)
protected void	FlowContainer.delegateProcessInput(IWizardContext ctx)
protected void	FlowContainer.myProcessInput(IWizardContext ctx)
void	FlowContainer.doAfterSubmit(IWizardContext context)
Component	FlowContainer.getDisplay(IWizardContext context)
void	FlowContainer.wasChanged(IWizardContext context)
void	FlowContainer.clearIfInconsistent(String changedObjectKey, IWizardContext context)
List	FlowContainer.getErrorMessages(IWizardContext context)
Component	FlowContainer.getControlInFocus(IWizardContext ctx)
DropdownListBox	DropdownSelectionComponent.getListComponent(IWizardContext context)
void	DropdownSelectionComponent.processInput(IWizardContext context) reads the new value from the submitted form and stores it in the session
String	DropdownSelectionComponent.getValue(IWizardContext context)
String	DropdownSelectionComponent.getValueTitle(IWizardContext context)
boolean	DropdownSelectionComponent.setValue(String newValue, IWizardContext context) set this component's value to newValue
Component	DropdownSelectionComponent.getControlInFocus(IWizardContext ctx)
void	CheckboxSelectionComponent.processInput(IWizardContext context)
List	CheckboxSelectionComponent.getValue(IWizardContext context)
void	CheckboxChoiceComponent.setSelected(boolean selected, IWizardContext context) Deprecated. - use setValue(...) instead
void	CheckboxChoiceComponent.setValue(boolean selected, IWizardContext context)
boolean	CheckboxChoiceComponent.getValue(IWizardContext context)
void	CheckboxChoiceComponent.processInput(IWizardContext context)
void	AlignedInputComponentList.setupComponent(IWizardContext context)
protected void	AlignedInputComponentList.delegateSetupComponent(IWizardContext context)
protected void	AlignedInputComponentList.mySetupComponent(IWizardContext context)
boolean	AlignedInputComponentList.isInitialized(IWizardContext context)
void	AlignedInputComponentList.init(IWizardContext context)
void	AlignedInputComponentList.doBeforeDisplay(IWizardContext context)
protected void	AlignedInputComponentList.delegateDoBeforeDisplay(IWizardContext context)
protected void	AlignedInputComponentList.myDoBeforeDisplay(IWizardContext ctx)
void	AlignedInputComponentList.processInput(IWizardContext ctx)
protected void	AlignedInputComponentList.delegateProcessInput(IWizardContext ctx)
protected void	AlignedInputComponentList.myProcessInput(IWizardContext ctx)
void	AlignedInputComponentList.doAfterSubmit(IWizardContext context)
Component	AlignedInputComponentList.getDisplay(IWizardContext context)
void	AlignedInputComponentList.wasChanged(IWizardContext context)
void	AlignedInputComponentList.clearIfInconsistent(String changedObjectKey, IWizardContext context)
List	AlignedInputComponentList.getErrorMessages(IWizardContext context)
Component	AlignedInputComponentList.getControlInFocus(IWizardContext ctx)
void	AbstractWizardComponent.setupComponent(IWizardContext ctx)
String	AbstractWizardComponent.getTitle(IWizardContext ctx)
String	AbstractWizardComponent.getDescription(IWizardContext ctx)
boolean	AbstractWizardComponent.isInitialized(IWizardContext context) always returns true - override this function if your component needs dynamic initialization
void	AbstractWizardComponent.init(IWizardContext context) the default implemention does nothing on init
void	AbstractWizardComponent.doBeforeDisplay(IWizardContext context) the default implemention does nothing before display
Component	AbstractWizardComponent.getDisplay(IWizardContext context) the default implementation returns null - if your component has a display it should inherit AbstractDisplayComponent or AbstractInputComponent.
void	AbstractWizardComponent.processInput(IWizardContext context) the default implemention does no input processing.
void	AbstractWizardComponent.doAfterSubmit(IWizardContext context) the default implemention does nothing
void	AbstractWizardComponent.wasChanged(IWizardContext context) this method should be called whenever a component is changed.
void	AbstractWizardComponent.clearIfInconsistent(String changedObject, IWizardContext context) the default implementtion clears all values from this component's branch in the session.
boolean	AbstractWizardComponent.isComplete(IWizardContext context) the default implemention returns true
List	AbstractWizardComponent.getErrorMessages(IWizardContext context) the default implemention returns null
Component	AbstractWizardComponent.getControlInFocus(IWizardContext ctx)
void	AbstractSelectionComponent.setChoices(List choices, IWizardContext context) Set the list of choices for this component.
void	AbstractSelectionComponent.setChoicesTitles(List titles, IWizardContext context) Set the list of titles for this component.
void	AbstractSelectionComponent.setChoicesTooltips(List tooltips, IWizardContext context) Set the list of tooltips for this component.
protected void	AbstractSelectionComponent.updateInputComponent(IWizardContext context)
abstract void	AbstractSelectionComponent.processInput(IWizardContext context)
protected boolean	AbstractSelectionComponent.setSingleValue(String selection, IWizardContext context)
protected boolean	AbstractSelectionComponent.setMultiValue(List selections, IWizardContext context)
protected String	AbstractSelectionComponent.getSingleValueTitle(IWizardContext context)
protected String	AbstractSelectionComponent.getSingleValueTooltip(IWizardContext context)
protected String	AbstractSelectionComponent.getRadioButtonInputValueFromForm(IWizardContext context)
protected List	AbstractSelectionComponent.getListBoxValuesFromForm(IWizardContext context)
protected String	AbstractSelectionComponent.getDropdownValueFromForm(IWizardContext context) Store the value from the htmlb display in the session.
protected List	AbstractSelectionComponent.getCheckboxGroupValuesFromForm(IWizardContext context)
boolean	AbstractSelectionComponent.isComplete(IWizardContext ctx)
void	AbstractInputComponent.setupComponent(IWizardContext ctx)
void	AbstractInputComponent.setValueGeneric(Object newValue, IWizardContext context)
String	AbstractInputComponent.getTooltip(IWizardContext context)
void	AbstractInputComponent.setCaption(String caption, IWizardContext context)
void	AbstractInputComponent.setTooltip(String tooltip, IWizardContext ctx)
Label	AbstractInputComponent.getCaptionComponent(IWizardContext context)
Component	AbstractInputComponent.getDisplay(IWizardContext context)
List	AbstractInputComponent.getErrorMessages(IWizardContext context) Get the error messages for this component.
void	AbstractInputComponent.clearIfInconsistent(String changedObject, IWizardContext ctx)
boolean	AbstractInputComponent.isComplete(IWizardContext ctx)
abstract void	AbstractInputComponent.processInput(IWizardContext ctx)
Component	AbstractActionComponent.getDisplay(IWizardContext ctx)

Uses of IWizardContext in com.sapportals.admin.wizardframework.components.localization

Methods in com.sapportals.admin.wizardframework.components.localization with parameters of type IWizardContext

String

LanguageResourceKey.getLocalizedResource(IWizardContext context)

Uses of IWizardContext in com.sapportals.admin.wizardframework.components.tableview

Methods in com.sapportals.admin.wizardframework.components.tableview with parameters of type IWizardContext

Component	TableViewComponent.getDisplay(IWizardContext context)
void	TableViewComponent.processInput(IWizardContext context)
void	TableViewComponent.doBeforeDisplay(IWizardContext context)
protected int	TableViewColumns.getKeyColumnIndex(IWizardContext context)

Uses of IWizardContext in com.sapportals.admin.wizardframework.templates

Methods in com.sapportals.admin.wizardframework.templates with parameters of type IWizardContext

void	AbstractWizardPane.mySetupComponent(IWizardContext ctx)
protected abstract void	AbstractWizardPane.setupPane(IWizardContext ctx, FlowContainer pane)
abstract String	AbstractWizardPane.getTitle(IWizardContext ctx)
Component	AbstractWizardPane.getDescriptionComponent(IWizardContext ctx)
void	AbstractWizardPane.myDoBeforeDisplay(IWizardContext ctx)
void	AbstractWizardPane.myProcessInput(IWizardContext ctx)
abstract String	AbstractScriptState.getScript(IWizardContext ctx)
void	AbstractActionState.doBeforeDisplay(IWizardContext ctx)
protected abstract void	AbstractActionState.doAction(IWizardContext ctx)

Uses of IWizardContext in com.sapportals.admin.wizardframework.util

Methods in com.sapportals.admin.wizardframework.util with parameters of type IWizardContext

Component

RedirectComponent.getDisplay(IWizardContext ctx)