com.adobe.exm.expeval

Annotation Type LocalFunction

@Retention
 @Target
public @interface LocalFunction

Annotation to be placed on static methods which should be made available to the expression manager as local functions.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description A verbose description of the function.
String	displayName The human-readable name of the function.
boolean	enabled Whether the function is enabled.
String	familyId Returns the ID of the family the function belongs to.
String	flexClassName The fully qualified name of the ActionScript class which contains a method which is the equivalent client-side implementation of the local function.
String	flexMethodName The name of the method on the ActionScript class (as specified by the 'flexClassName' attribute value) which contains an equivalent client-side implementation of the local function.

Element Detail

enabled

public abstract boolean enabled

Whether the function is enabled. Functions which are not enabled will be ignored by the expression manager.

Returns:

Whether the function is enabled.

Default:

true

familyId

public abstract String familyId

Returns the ID of the family the function belongs to. If this attribute returns an empty String, the expression manager assumes the default family.

Returns:

The ID of the family the function belongs to.

Default:

""

displayName

public abstract String displayName

The human-readable name of the function. If this attribute returns an empty String, the expression manager constructs a default name using the function-prefix and method-name.

Returns:

The human-readable name of the function.

Default:

""

description

public abstract String description

A verbose description of the function. If this attribute returns an empty String, the expression manager constructs a default description using the function-prefix and method-name.

Returns:

A verbose description of the function.

Default:

""

flexClassName

public abstract String flexClassName

The fully qualified name of the ActionScript class which contains a method which is the equivalent client-side implementation of the local function. (used when the expression is evaluated on the client-side).

Returns:

The fully qualified name of the equivalent ActionScript class.

Default:

""

flexMethodName

public abstract String flexMethodName

The name of the method on the ActionScript class (as specified by the 'flexClassName' attribute value) which contains an equivalent client-side implementation of the local function.

Returns:

The name of the equivalent ActionScript method.

Default:

""