com.ibm.itim.fesiextensions
Interface JSObjectFactory
- All Known Implementing Classes:
- JSAttributeValueFactory, JSDirectoryObjectFactory, JSGlobalObjectFactory, JSHashMapFactory, JSPropertiesFactory
- public interface JSObjectFactory
Defines an interface for converting JavaScript objects to and from Java
objects. It is optional to provide an implementation for converting
JavaScript objects to Java objects.
Field Summary |
static java.lang.String |
CLASS_NAME
Constant for the JSObject property that holds the class name of
the Java object the JSObject was converted from. |
CLASS_NAME
public static final java.lang.String CLASS_NAME
- Constant for the JSObject property that holds the class name of
the Java object the JSObject was converted from.
createScriptObject
public JSObject createScriptObject(JSGlobalObject go,
JSObject parent,
java.lang.String name,
java.lang.Object item)
throws JSException
- Creates a named object that can be used in the client's script. This
method differes from setContextItem in that it will translate the given
java object to an object that is compatible with the scripting language
implementation and the result can be used in the client scripts, not
just by the script engine extensions. The only requirement for the
JavaScript object returned is that it has a property that indicates the
Java class it was created from. The property is named CLASS_NAME and the
value is the name of the Java class.
- Parameters:
go
- JSGlobalObject as calling context.parent
- JSObject to be registered as a member of. Same as go if
global.name
- Name of the object in the scripting environmentitem
- Object that will be made available as a script object- Returns:
- JSObject representing the given object.
- Throws:
JSException
- when the object can not be converted
into a format that can be used within the script environment
createJavaObject
public java.lang.Object createJavaObject(java.lang.String name,
JSObject o)
throws JSException
- Creates a Java object from the specified JavaScript object. This method
is optional. If the factory does not implement it, it must throw an
UnsupportedOperationException.
- Parameters:
name
- Name of the JavaScript object. Can be empty.o
- JSObject to convert from.- Returns:
- Java object that represents the JSObject.
- Throws:
JSException
- if the specified JSObject is malformed or not
compatible with this factory.