com.adobe.idp.dsc.propertyeditor
Interface Property

public interface Property

A Property object provides access to the underling value to be manipulated by the a property editor's UIComponent implementation.

Method Summary

void	addChangeListener(com.adobe.idp.dsc.propertyeditor.PropertyChangeListener aChangeListener) adds a listener to be notified if this property changes.
java.lang.ClassLoader	getClassLoader() Retrieves the ClassLoader that will be used to load this Property object's property editor.
java.lang.String	getHint() Retrieves the current help hint.
java.lang.String	getID() Retrieves the unique identifier of this property.
java.lang.String	getName() Retrieves the name of a property.
PropertyEditorComponent	getPropertyEditorComponent() Retrieves the PropertyEditorComponent associated with this property.
PropertySheet	getPropertySheet() Retrieves the PropertySheet associated with this property.
ServiceConfiguration	getServiceConfiguration() Retrieves the ServiceConfiguration associated with this property.
java.lang.String	getTitle() Retrieves the title of a property, or null if none is available.
java.lang.String	getType() Retrieves the type for this property.
java.lang.Object	getValue() Retrieves the value of a property.
java.lang.String	getValueAsText() Deprecated. Use Property.getValue() with an object of the property editor's expected configuration type.
void	removeChangeListener(com.adobe.idp.dsc.propertyeditor.PropertyChangeListener aChangeListener) removes a property change listener.
void	setHint(java.lang.String aNewHint) Sets the current help hint.
void	setValue(java.lang.Object aValue) Sets the value of a property.
void	setValueAsText(java.lang.String aValue) Deprecated. Use #setValue() with an object of the property editor's expected configuration type.

Method Detail

getClassLoader

java.lang.ClassLoader getClassLoader()

Retrieves the ClassLoader that will be used to load this Property object's property editor.

Returns:

The ClassLoader that will be used to load this Property object's property editor.

getName

java.lang.String getName()

Retrieves the name of a property.

Returns:

The name of a property.

getTitle

java.lang.String getTitle()

Retrieves the title of a property, or null if none is available.

Returns:

The title of a property.

setValue

void setValue(java.lang.Object aValue)

Sets the value of a property.

Parameters:

aValue - The property value.

getValue

java.lang.Object getValue()

Retrieves the value of a property.

Returns:

The property value.

setValueAsText

void setValueAsText(java.lang.String aValue)

Deprecated. Use #setValue() with an object of the property editor's expected configuration type.

Sets the value of a property using the specified text value (string). A property editor's associated TextSerializer implementation converts the string to its object value.

Parameters:

aValue - The string representation of the property value.

getValueAsText

java.lang.String getValueAsText()

Deprecated. Use Property.getValue() with an object of the property editor's expected configuration type.

Retrieves the value of a property using the specified text value (string). A property editor's associated TextSerializer implementation converts the underlying object value to text.

Returns:

The string representation of the property value.

getID

java.lang.String getID()

Retrieves the unique identifier of this property. The identifier is used to find a property within a PropertySheet to support custom layout.

Returns:

The unique identifier of this property.

getType

java.lang.String getType()

Retrieves the type for this property.

Returns:

The type for this property.

getServiceConfiguration

ServiceConfiguration getServiceConfiguration()

Retrieves the ServiceConfiguration associated with this property.

Returns:

The ServiceConfiguration associated with this property.

getPropertySheet

PropertySheet getPropertySheet()

Retrieves the PropertySheet associated with this property.

Returns:

The PropertySheet associated with this property.

getPropertyEditorComponent

PropertyEditorComponent getPropertyEditorComponent()

Retrieves the PropertyEditorComponent associated with this property.

Returns:

the PropertyEditorComponent associated with this property.

getHint

java.lang.String getHint()

Retrieves the current help hint.

setHint

void setHint(java.lang.String aNewHint)

Sets the current help hint.

Parameters:

aNewHint - A string containing the new help hint. If it is null, the hint is set to the value specified in the component.xml file.

addChangeListener

void addChangeListener(com.adobe.idp.dsc.propertyeditor.PropertyChangeListener aChangeListener)

adds a listener to be notified if this property changes.

Parameters:

aChangeListener - the listener to be notified if this property's value changes

removeChangeListener

void removeChangeListener(com.adobe.idp.dsc.propertyeditor.PropertyChangeListener aChangeListener)

removes a property change listener. property change listeners should be removed when the property editor widget is disposed.

Parameters:

aChangeListener - the listener to remove.