com.adobe.idp.dsc.propertyeditor
Interface PropertySheet

public interface PropertySheet

A PropertySheet provides an abstraction for working with a set of related properties that are being edited and/or viewed. It acts as a container for a set of related properties providing meta-data describing those properties.

Method Summary

java.lang.ClassLoader	getClassLoader() Retrieves the class loader to use as the parent for all PropertyEditorComponent class loaders.
java.util.List	getProperties() Retrieves a list of related properties contained within the PropertySheet.
Property	getProperty(java.lang.String aPropName) Retrieves a specific Property object by name.
com.adobe.idp.dsc.propertyeditor.PropertyEditorFilterMode	getPropertyEditorFilterMode() Returns the current property editor filter mode of the container of this property editor.
com.adobe.idp.dsc.propertyeditor.PropertyEditorMode	getPropertyEditorMode() returns the current mode of the container of this property editor.
void	setClassLoader(java.lang.ClassLoader aClassLoader) Sets the class loader to use as the parent for all PropertyEditorComponent class loaders.

Method Detail

setClassLoader

void setClassLoader(java.lang.ClassLoader aClassLoader)

Sets the class loader to use as the parent for all PropertyEditorComponent class loaders.

Parameters:

aClassLoader - The class loader.

getClassLoader

java.lang.ClassLoader getClassLoader()

Retrieves the class loader to use as the parent for all PropertyEditorComponent class loaders.

Returns:

The class loader.

getProperties

java.util.List getProperties()

Retrieves a list of related properties contained within the PropertySheet.

Returns:

a list of related properties contained within the PropertySheet.

getProperty

Property getProperty(java.lang.String aPropName)

Retrieves a specific Property object by name.

Parameters:

aPropName - The name of the Property object.

Returns:

The Property object.

getPropertyEditorMode

com.adobe.idp.dsc.propertyeditor.PropertyEditorMode getPropertyEditorMode()

returns the current mode of the container of this property editor. the container is usually workbench. The mode is one of: EDIT - edit mode; user is expected to input values; features like 'browse file' buttons should be enabled READ_ONLY - read only mode; user is not allowed to make changes; 'browse file' buttons should be disabled VIEW_OUTPUT - the editor is in 'view output' mode; UI should be changed to show its values; no user input allowed, e.g. features like 'browse file' buttons should be changed to 'Save..' buttons

Returns:

the mode in which this property sheet is running in

getPropertyEditorFilterMode

com.adobe.idp.dsc.propertyeditor.PropertyEditorFilterMode getPropertyEditorFilterMode()

Returns the current property editor filter mode of the container of this property editor. The container is usually Workbench.

Returns:

Filter Mode in which this property editor is running or NULL if no filter mode is set.