com.webmethods.portal.framework.propertyeditor

Interface IPropertyEditor

All Superinterfaces:

IComponent, IHandler, IInitializable, ISystemHandler

public interface IPropertyEditor
extends IHandler

Renders a specific type of form field, such as text box, radio button group, or selection dropdown.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_ATTRIBUTE_DHTML True if browser supports DHTML(defaults to true).
static String	CONTEXT_ATTRIBUTE_FORM Form name.
static String	CONTEXT_ATTRIBUTE_UNIQUE_ID Random, unique script-safe ID [a-z,A-Z,0-9,_].
static String	PARAMETER_DHTML True if browser supports DHTML (defaults to true).
static String	PARAMETER_DISABLED True if field is disabled initially (defaults to false).
static String	PARAMETER_FORM Form name.
static String	PARAMETER_NAMESPACE Restful Form namespace
static String	PARAMETER_ONCHANGE JavaScript to execute when input value changes.
static String	PARAMETER_READ_ONLY True if field is read-only (defaults to false).
static String	PARAMETER_STYLE Picker CSS class (defaults to "medium").
static String	PARAMETER_UNIQUE_ID Random, unique script-safe ID [a-z,A-Z,0-9,_].
static String	PARAMETER_VALIDATION_REGEXP Client-side validation regular expression.
static String	PARAMETER_VALIDATION_REGEXP_MSG Message to display if the client-side validation regular expression does not match exactly.

Method Summary

Modifier and Type	Method and Description
IPropertyEditorDescriptor	getDescriptor(IContext context) Descriptor for property-editor features.
void	render(IContext context, Writer out, String name, Object value, Map<String,?> parameters) Renders this property-editor with given name, value, and property-editor-specific parameters.

Methods inherited from interface com.webmethods.portal.framework.IHandler

getConfigElem, getHandlerBean, getName, getPerfToken, initialize, postInitialize, shutdown

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init

Field Detail

CONTEXT_ATTRIBUTE_FORM

static final String CONTEXT_ATTRIBUTE_FORM

Form name.

See Also:

Constant Field Values

CONTEXT_ATTRIBUTE_UNIQUE_ID

static final String CONTEXT_ATTRIBUTE_UNIQUE_ID

Random, unique script-safe ID [a-z,A-Z,0-9,_].

See Also:

Constant Field Values

CONTEXT_ATTRIBUTE_DHTML

static final String CONTEXT_ATTRIBUTE_DHTML

True if browser supports DHTML(defaults to true).

See Also:

Constant Field Values

PARAMETER_FORM

static final String PARAMETER_FORM

Form name.

See Also:

Constant Field Values

PARAMETER_UNIQUE_ID

static final String PARAMETER_UNIQUE_ID

Random, unique script-safe ID [a-z,A-Z,0-9,_].

See Also:

Constant Field Values

PARAMETER_DHTML

static final String PARAMETER_DHTML

True if browser supports DHTML (defaults to true).

See Also:

Constant Field Values

PARAMETER_READ_ONLY

static final String PARAMETER_READ_ONLY

True if field is read-only (defaults to false).

See Also:

Constant Field Values

PARAMETER_DISABLED

static final String PARAMETER_DISABLED

True if field is disabled initially (defaults to false).

See Also:

Constant Field Values

PARAMETER_VALIDATION_REGEXP

static final String PARAMETER_VALIDATION_REGEXP

Client-side validation regular expression. If this attribute is specified and not empty, the picker value is valid only if it matches the regular expression exactly.

See Also:

Constant Field Values

PARAMETER_VALIDATION_REGEXP_MSG

static final String PARAMETER_VALIDATION_REGEXP_MSG

Message to display if the client-side validation regular expression does not match exactly.

See Also:

Constant Field Values

PARAMETER_STYLE

static final String PARAMETER_STYLE

Picker CSS class (defaults to "medium").

See Also:

Constant Field Values

PARAMETER_ONCHANGE

static final String PARAMETER_ONCHANGE

JavaScript to execute when input value changes.

See Also:

Constant Field Values

PARAMETER_NAMESPACE

static final String PARAMETER_NAMESPACE

Restful Form namespace

See Also:

Constant Field Values

Method Detail

render

void render(IContext context,
            Writer out,
            String name,
            Object value,
            Map<String,?> parameters)
     throws IllegalPropertyEditorNameException,
            IllegalPropertyEditorParameterException,
            DHTMLRequiredByPropertyEditorException,
            PortalException,
            IOException

Renders this property-editor with given name, value, and property-editor-specific parameters.

Parameters:

context - Portal context.

out - Rendering output stream.

name - Form field name.

value - Default value. May be null.

parameters - Property-editor-specific parameters. Never null.

Throws:

IllegalPropertyEditorNameException

IllegalPropertyEditorParameterException

DHTMLRequiredByPropertyEditorException

PortalException

IOException

getDescriptor

IPropertyEditorDescriptor getDescriptor(IContext context)
                                 throws PortalException

Descriptor for property-editor features.

Throws:

PortalException