com.sap.portal.admin.studio
Class PropertyEditorComponent

java.lang.Object
  |
  +--com.sapportals.admin.wizardframework.components.AbstractWizardComponent
        |
        +--com.sap.portal.admin.studio.PropertyEditorComponent

All Implemented Interfaces:

IDependencyObject, IWizardComponent

public class PropertyEditorComponent

extends AbstractWizardComponent

Property Editor wizard component

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

HORIZONTAL_LAYOUT, VERTICAL_LAYOUT

Constructor Summary

PropertyEditorComponent(java.lang.String objectId, boolean readOnly, java.lang.String resetEventName)
Creates a new PropertyEditorComponent object.

Method Summary

com.sapportals.htmlb.Component	getDisplay(IWizardContext context) the default implementation returns null - if your component has a display it should inherit AbstractDisplayComponent or AbstractInputComponent.
java.lang.String	getObjectId()
static java.lang.String	getPEErrorMessage(IBasicEditingContext context)
static com.sap.portal.admin.propertyeditor.api.PEState	getPEState(IBasicEditingContext context) Get the state of the property editor that was saved on the context
protected com.sap.portal.admin.propertyeditor.api.IPropertyEditor	getPropertyEditor(IWizardContext context) Get the property editor
int	getWidth(IWizardContext context) Get the width for the property editor
boolean	isReadOnly()
void	processInput(IWizardContext context) the default implemention does no input processing.
void	setObjectId(java.lang.String objectId, IWizardContext context)
void	setReadOnly(boolean b)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyEditorComponent

public PropertyEditorComponent(java.lang.String objectId,
                               boolean readOnly,
                               java.lang.String resetEventName)

Creates a new PropertyEditorComponent object.

Parameters:

objectId - Object id

readOnly - indicates whether this property editor is read only (true)

resetEventName - the name of the event that triggers a reset

Method Detail

getDisplay

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

Description copied from class: AbstractWizardComponent

the default implementation returns null - if your component has a display it should inherit AbstractDisplayComponent or AbstractInputComponent.

Overrides:

getDisplay in class AbstractWizardComponent

setObjectId

public void setObjectId(java.lang.String objectId,
                        IWizardContext context)

Parameters:

objectId - the id of the object that this property editor edits.

getObjectId

public java.lang.String getObjectId()

Returns:

the id of the object that this property editor edits.

getPEErrorMessage

public static java.lang.String getPEErrorMessage(IBasicEditingContext context)

Parameters:

context -

Returns:

getPEState

public static com.sap.portal.admin.propertyeditor.api.PEState getPEState(IBasicEditingContext context)

Get the state of the property editor that was saved on the context

Parameters:

context - current context

Returns:

PEState or null if no property editor was defined

setReadOnly

public void setReadOnly(boolean b)

Parameters:

b - true if this property editor is read only

isReadOnly

public boolean isReadOnly()

Returns:

true if this property editor is read only

getWidth

public int getWidth(IWizardContext context)

Get the width for the property editor

Parameters:

context -

Returns:

processInput

public void processInput(IWizardContext context)

Description copied from class: AbstractWizardComponent

the default implemention does no input processing.

Overrides:

processInput in class AbstractWizardComponent

getPropertyEditor

protected com.sap.portal.admin.propertyeditor.api.IPropertyEditor getPropertyEditor(IWizardContext context)

Get the property editor

Parameters:

context - wizard context

Returns:

the IPropertyEditor object