Packagecom.adobe.idp.dsc.propertyeditor
Interfacepublic interface Property

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



Public Methods
 MethodDefined By
  
ClassLoader getClassLoader()
Retrieves the ClassLoader that will be used to load this Property object's property editor.
Property
  
String getHint()
Retrieves the current help hint.
Property
  
String getID()
Retrieves the unique identifier of this property.
Property
  
String getName()
Retrieves the name of a property.
Property
  
Retrieves the com.adobe.idp.dsc.registry.infomodel.PropertyEditorComponent PropertyEditorComponent associated with this property.
Property
  
Retrieves the com.adobe.idp.dsc.propertyeditor.PropertySheet PropertySheet associated with this property.
Property
  
Retrieves the com.adobe.idp.dsc.registry.infomodel.ServiceConfiguration ServiceConfiguration associated with this property.
Property
  
String getTitle()
Retrieves the title of a property, or null if none is available.
Property
  
String getType()
Retrieves the type for this property.
Property
  
Object getValue()
Retrieves the value of a property.
Property
  
Retrieves the value of a property using the specified text value (string).
Property
  
void setHint(String aNewHint)
Sets the current help hint.
Property
  
void setValue(Object aValue)
Sets the value of a property.
Property
  
void setValueAsText(String aValue)
Sets the value of a property using the specified text value (string).
Property
Method Detail
getClassLoader()
public 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.
getHint() 
public String getHint()

Retrieves the current help hint.

Returns
getID() 
public 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.
getName() 
public String getName()

Retrieves the name of a property.

Returns
The name of a property.
getPropertyEditorComponent() 
public PropertyEditorComponent getPropertyEditorComponent()

Retrieves the PropertyEditorComponent associated with this property.

Returns
the PropertyEditorComponent associated with this property.
getPropertySheet() 
public PropertySheet getPropertySheet()

Retrieves the PropertySheet associated with this property.

Returns
The PropertySheet associated with this property.
getServiceConfiguration() 
public ServiceConfiguration getServiceConfiguration()

Retrieves the ServiceConfiguration associated with this property.

Returns
The ServiceConfiguration associated with this property.
getTitle() 
public String getTitle()

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

Returns
The title of a property.
getType() 
public String getType()

Retrieves the type for this property.

Returns
The type for this property.
getValue() 
public Object getValue()

Retrieves the value of a property.

Returns
The property value.
getValueAsText() 
public String getValueAsText()
Deprecated: Use 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.
setHint() 
public void setHint(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.

setValue() 
public void setValue(Object aValue)

Sets the value of a property.

Parameters

aValue — The property value.

setValueAsText() 
public void setValueAsText(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.





 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/idp/dsc/propertyeditor/Property.html