nativeObj

nativeObj管理系统原生对象。

对象:

回调方法:

权限:

5+功能模块(permissions)

{
// ...
"permissions":{
	// ...
	"NativeObj": {
		"description": "原生对象"
	}
}
}
			

AnimationOptions

原生动画参数

interface AnimationOptions {
	attribute String type;
	attribute Number duration;
}				

说明:

指定动画的类型、持续时间等信息。

属性:

AnimationViewStyles

原生动画窗口样式

interface AnimationViewStyles {
	attribute Bitmap bitmap;
	attribute String text;
}				

说明:

指定动画窗口的样式,如背景图片,绘制的文字等。

属性:

Bitmap

原生图片对象

interface Bitmap {
	readonly attribute String id;

	static function Array[Bitmap] getItems();
	static function Bitmap getBitmapById( id );
	
	function void clear();
	function void load( path, successCallback, errorCallback );
	function void loadBase64Data( data, successCallback, errorCallback );
	function void save( path, options, successCallback, errorCallback );
	function String toBase64Data();
}				

说明:

原生图片对象会占用较大的内存资源,在使用时需谨慎管理,当图片不再使用时应该及时调用clear方法进行销毁。

构造:

属性:

方法:

BitmapSaveOptions

JSON对象,保存图片的参数

interface BitmapSaveOptions {
	attribute Boolean overwrite;
	attribute String format;
	attribute Number quality;
	attribute Rect clip;
}				

属性:

ImageSlider

原生图片轮播控件对象

interface ImageSlider extends View {
	function void addImages(images);
	function Number currentImageIndex();
	function void setImages(images);
}
				

说明:

原生图片轮播控件对象从原生View控件(plus.nativeObj.View)继承而来,用于绘制图片轮播内容。

构造:

方法:

ImageSliderStyles

图片轮播控件样式

interface ImageSliderStyles extends ViewStyles {
	attribute Boolean autoplay;
	attribute Array<ImageSliderImageStyles> images;
	attribute Boolean loop;
	attribute Boolean fullscreen;
}				

说明:

从ViewStyles继承而来,扩展支持轮播图片等配置。

属性:

ImageSliderImageStyles

图片轮播控件中图片项配置参数

说明:

用于指定图片地址等信息。

属性:

InputStyles

输入框样式

interface InputStyles{
	attribute String type;
	attribute String placeholder;
	attribute String fontSize;
	attribute String borderWidth;
	attribute String borderColor;
	attribute String borderRadius;
	attribute function onComplete;
	attribute function onFocus;
	attribute function onBlur;
}
				

说明:

用于定义输入框的显示样式,如字体大小,提示内容等信息。 输入文本内容在指定区域水平居左,垂直居中显示。

属性:

Rect

区域信息对象

interface Rect {
	attribute String top;
	attribute String left;
	attribute String width;
	attribute String height;
}				

说明:

包括位置、大小等信息。

属性:

RectStyles

绘制区域样式对象

interface RectStyles {
	attribute String color;
	attribute String radius;
	attribute String borderColor;
	attribute String borderWidth;
}				

说明:

用于定义矩形区域的显示样式,如空心/实心样式、圆角等信息。

属性:

RichTextStyles

富文本样式

interface RichTextStyles{
	attribute String align;
	attribute String family;
	attribute String fontSrc;
	attribute Function onClick;
}
				

说明:

用于定义富文本使用的默认使用的字体名称、字体文件路径等信息。

属性:

Position

区域信息对象

interface Position {
	attribute String top;
	attribute String left;
	attribute String width;
	attribute String height;
	attribute String bottom;
	attribute String right;
}				

说明:

包括位置、大小等信息。

属性:

TextStyles

绘制文本样式对象

interface TextStyles {
	attribute String align;
	attribute String color;
	attribute String family;
	attribute String size;
	attribute String style;
	attribute String weight;
	attribute String fontSrc;
	attribute String overflow;
}				

说明:

用于定义文本的显示样式,如字体大小、字体颜色、字体粗细、字体样式、字体名称等信息。

属性:

View

原生控件对象

interface View {
	readonly attribute String id;

	static function void startAnimation(options, view, otherview, callback);
	static function void clearAnimation(type);
	static function View getViewById(id);

	function void addEventListener(event, listener, capture);
	function void animate(options, callback);
	function void close();
	function void clearRect(position, id);
	function void draw(tags);
	function void drawBitmap(src, sprite, position, id);
	function void drawRect(color, position, id);
	function void drawText(text, position, styles, id);
	function void drawRichText(text, position, styles, id);
	function void drawInput(position, styles, id);
	function Boolean getInputFocusById(id);
	function String getInputValueById(id);
	function void reset();
	function void restore();
	function void show();
	function void setInputFocusById(id, focusable);
	function void setStyle(styles);
	function void setTouchEventRect(rect);
	function void hide();
	function void interceptTouchEvent(intercept);
	function Boolean isVisible();
}
				

说明:

原生控件对象可用于在屏幕上绘制图片或文本内容,当控件不再使用时需要调用close方法销毁控件。 NView不支持zindex,后显示的覆盖先显示的; 调用Webview窗口对象的append方法添加到Webview中,显示在父窗口所有子Webview的上面;不添加到Webview窗口对象,显示在所有Webview的上面。

构造:

属性:

方法:

ViewAnimationOptions

View控件动画参数

interface ViewAnimationOptions {
	attribute String type;
	attribute Number duration;
	attribute Number frames;
	attribute Rect region;
}				

说明:

指定动画的类型、持续时间等信息。

属性:

ViewDrawTagStyles

View控件绘制元素参数

interface ViewDrawTagStyles {
	attribute String id;
	attribute String tag;
	attribute String color;
	attribute InputStyles inputStyles;
	attribute Position position;
	attribute RectStyles rectStyles;
	attribute String src;
	attribute Position sprite;
	attribute String text;
	attribute TextStyles textStyles;
	attribute RichTextStyles richTextStyles;
}				

说明:

指定绘制图片、矩形区域、文本内容等信息。

属性:

ViewEvents

View控件事件

常量:

ViewStatusbarStyles

JSON对象,View控件的系统状态栏区域样式

说明:

仅在应用设置为沉浸式状态栏样式下有效,非沉浸式状态栏样式下忽略此属性。

属性:

ViewStyles

View控件样式

interface ViewStyles {
	attribute String backgroundColor;
	attribute String left;
	attribute String top;
	attribute String bottom;
	attribute String height;
	attribute String width;
	attribute String dock;
	attribute Number opacity;
	attribute String position;
	attribute ViewStatusbarStyles statusbar;
}				

说明:

包括位置、大小等信息等,其中位置信息相对于父容器控件进行计算。

属性:

BitmapSaveSuccessCallback

图片保存操作成功回调接口

void onSuccess( Event event ){
	// Code here
	var target = event.target; // 保存后的图片url路径,以"file://"开头
	var size = event.size; // 保存后图片的大小,单位为字节(Byte)
	var width = event.width; // 保存后图片的实际宽度,单位为px
	var height = event.height; // 保存后图片的实际高度,单位为px
}
				

参数:

返回值:

void : 无

InputCompleteCallback

输入框完成输入回调函数

void onComplete(Event event){
	// Code here
	var text = event.text; // 保存用户输入的内容
}
				

说明:

弹出软键盘完成输入后,点击软键盘上的“完成”、“前往”按钮时触发。

参数:

返回值:

void : 无

InputEventCallback

输入框事件回调函数

void onEvent(Event event){
	// Code here
	var id = event.id; // 编辑框的标识
}
				

说明:

输入框获取/失去焦点时触发。

参数:

返回值:

void : 无

RichTextClickedCallback

富文本区域点击事件回调函数

void onEvent(Event event){
	// Event handled code.
	var tagName = event.tagName;
	var href = event.href;
	var src = event.src;
}
				

说明:

用户点击RichText区域时触发,如果点击RichText的a标签则回调函数event参数中包含tagName(值为"a")和href属性; 如果点击RichText的img标签则回调函数event参数中包含tagName(值为"img")和src属性; 如果点击其它区域则回调函数event参数中包含tagName(值为"")。

参数:

返回值:

void : 无

TouchEventCallback

触屏事件的回调函数

void onEvent(Event e){
	// Event handled code.
	var clientX = e.clientX;
	var clientY = e.clientY;
	var pageX = e.pageX;
	var pageY = e.pageY;
	var screenX = e.screenX;
	var screenY = e.screenY;
	var target = e.target;
	var imageIndex = e.currentImageIndex;
}
				

参数:

返回值:

void : 无

NativeObjSuccessCallback

操作成功回调函数接口

void onSuccess(){
	// Code here
}
				

参数:

返回值:

void : 无

NativeObjErrorCallback

操作错误回调函数接口

function void onError( Exception error ) {
	// Error.
	var code = error.code; // 错误编码
	var message = error.message; // 错误描述信息
}
				

参数:

返回值:

void : 无