org.appcelerator.kroll.annotations
Annotation Type Kroll.getProperty


@Documented
@Retention(value=SOURCE)
@Target(value=METHOD)
public static @interface Kroll.getProperty

Declares a method as a property getter of this Kroll.proxy or Kroll.module.

Getter methods must return a value, and may optionally have a KrollInvocation as the first argument, and optional arguments when they are also exposed as methods

See Also:
name(), nativeConverter(), javascriptConverter(), runOnUiThread(), KrollInvocation, @Kroll.method, Kroll.argument.optional()

Optional Element Summary
 java.lang.Class<? extends KrollJavascriptConverter> javascriptConverter
          Converter of Rhino/Javascript objects to Java objects suitable for use in Titanium
 java.lang.String name
          The name of this property in the API.
 java.lang.Class<? extends KrollNativeConverter> nativeConverter
          Converter of Java objects to Javascript objects suitable for use by the Rhino runtime
 boolean runOnUiThread
          When set to true, this property getter will only be executed on the UI thread.
 

name

public abstract java.lang.String name
The name of this property in the API.

Default Value:
The method name stripped of "get", and lower-camel-cased or the method name itself.
Default:
"__default_name__"

nativeConverter

public abstract java.lang.Class<? extends KrollNativeConverter> nativeConverter
Converter of Java objects to Javascript objects suitable for use by the Rhino runtime

The value should be the fully qualified name of a class that implements KrollNativeConverter. The class must also implement a static instance getter called getInstance().

See Also:
KrollNativeConverter
Default:
org.appcelerator.kroll.KrollConverter.class

javascriptConverter

public abstract java.lang.Class<? extends KrollJavascriptConverter> javascriptConverter
Converter of Rhino/Javascript objects to Java objects suitable for use in Titanium

The value should be the fully qualified name of a class that implements KrollJavascriptConverter. The class must also implement a static instance getter called getInstance().

See Also:
KrollJavascriptConverter
Default:
org.appcelerator.kroll.KrollConverter.class

runOnUiThread

public abstract boolean runOnUiThread
When set to true, this property getter will only be executed on the UI thread.

Default:
false


Copyright © 2010 Appcelerator, Inc. Licensed under the Apache License 2.0