com.adobe.idp.dsc.propertyeditor
Interface PropertyContext

public interface PropertyContext

The PropertyContext interface provides a UIComponent instance access to the context of the PropertySheet in which it is being rendered.

Method Summary

java.lang.String	browseForFilename(java.lang.String[] filter) Deprecated. Use ServiceClientfactory.createInstance() instead.
Service	browseForService() Browses for a service.
Operation	browseForServiceOperation() Browses for service operations.
java.lang.String	browseForXPathExpression() Deprecated. Do not use.
Property	getCurrentProperty() Retrieves the currently selected property object.
java.lang.String	getParameter(java.lang.String aParamName) Retrieves the value of specified parameter.
PropertySheet	getPropertySheet() Retrieves the common interface of the PropertySheet in which the currently selected property editor is running.
ServiceClientFactory	getServiceClientFactory() Deprecated. Do not use.
ServiceConfiguration	getServiceConfiguration() Retrieves the ServiceConfiguration with which this context is associtated.

Method Detail

getCurrentProperty

Property getCurrentProperty()

Retrieves the currently selected property object.

Returns:

The currently selected property object.

getPropertySheet

PropertySheet getPropertySheet()

Retrieves the common interface of the PropertySheet in which the currently selected property editor is running.

Returns:

The common interface of the PropertySheet in which the currently selected property editor is running.

getParameter

java.lang.String getParameter(java.lang.String aParamName)

Retrieves the value of specified parameter. If no such parameter exists, null is returned.

Parameters:

aParamName - The name of the parameter whose value is to be retrieved.

Returns:

The value of specified parameter.

getServiceConfiguration

ServiceConfiguration getServiceConfiguration()

Retrieves the ServiceConfiguration with which this context is associtated.

Returns:

The ServiceConfiguration instance associated with this context.

getServiceClientFactory

ServiceClientFactory getServiceClientFactory()

Deprecated. Do not use.

Retrieves a ServiceClientFactory, which custom property editors can use to connect to the LiveCycle ES server. In the IDE, the returned ServiceClientFactory is integrated into the IDE's single sign-on information.

Returns:

a ServiceClientFactory, which custom property editors can use to connect to the LiveCycle ES server.

browseForFilename

java.lang.String browseForFilename(java.lang.String[] filter)

Deprecated. Use ServiceClientfactory.createInstance() instead.

Opens a file browser and retrieves the selected resource.

Parameters:

filter - A list of wildcards on which to filter.

Returns:

The selected file or folder name, or null if the dialog was cancelled.

browseForService

Service browseForService()

Browses for a service.

Returns:

The selected document service, or null if the dialog was cancelled.

browseForServiceOperation

Operation browseForServiceOperation()

Browses for service operations.

Returns:

The selected operation, or null if the dialog was cancelled.

browseForXPathExpression

java.lang.String browseForXPathExpression()

Deprecated. Do not use.

Allows the user to construct an XPath expression from the orchestration template environment.

Returns:

A string containing an XPath expression, or null if the dialog was cancelled.