已定稿
感谢Dcloud等1人做出了贡献
常见问题 我要提意见 赞(446)

nativeUI

nativeUI管理系统原生界面,可用于弹出系统原生提示对话框窗口、时间日期选择对话框、等待对话框等。

方法:

对象:

回调方法:

actionSheet

弹出系统选择按钮框

void plus.nativeUI.actionSheet( actionsheetStyle, actionsheetCallback );

说明:

从底部动画弹出系统样式选择按钮框,可设置选择框的标题、按钮文字等。 弹出的提示框为非阻塞模式,用户点击选择框上的按钮后关闭,并通过actionsheetCallback回调函数通知用户选择的按钮。

参数:

返回值:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>nativeUI Example</title>
		<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	// 弹出系统选择按钮框
	plus.nativeUI.actionSheet( {title:"Plus is ready!",cancel:"取消",buttons:[{title:"1"},{title:"2"}]}, function(e){
		console.log( "User pressed: "+e.index );
	} );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
		</script>
	</head>
	<body>
	弹出系统选择按钮框
	</body>
</html>

alert

弹出系统提示对话框

void plus.nativeUI.alert( message, alertCB, title, buttonCapture );

说明:

创建并显示系统样式提示对话框,可设置提示对话框的标题、内容、按钮文字等。 弹出的提示对话框为非阻塞模式,用户点击提示对话框上的按钮后关闭,并通过alertCB回调函数通知对话框已关闭。

参数:

返回值:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>nativeUI Example</title>
		<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	// 弹出系统提示对话框
	plus.nativeUI.alert( "Plus is ready!", function(){
		console.log( "User pressed!" );
	}, "nativeUI", "OK" );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
		</script>
	</head>
	<body>
	弹出系统提示对话框
	</body>
</html>

confirm

弹出系统确认对话框

void plus.nativeUI.confirm( message, confirmCB, title, buttons );

说明:

创建并显示系统样式确认对话框,可设置确认对话框的标题、内容、按钮数目及其文字。 弹出的确认对话框为非阻塞模式,用户点击确认对话框上的按钮后关闭,并通过confirmCB回调函数通知用户点击的按钮索引值。

参数:

返回值:

平台支持:

Android : 2.2+

对话框上最多只能支持三个按钮,buttons参数超过三个的值则忽略。

iOS : 4.5+

WP : 7.5+

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>nativeUI Example</title>
		<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	// 弹出提示信息对话框
	plus.nativeUI.confirm( "Are you sure ready?", function(e){
		console.log( (e.index==0)?"Yes!":"No!" );
	}, "nativeUI", ["Yes","No"] );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
		</script>
	</head>
	<body>
	弹出系统确认对话框
	</body>
</html>

closeWaiting

关闭系统等待对话框

void plus.nativeUI.closeWaiting();

说明:

关闭已经显示的所有系统样式等待对话框,触发Waiting对象的onclose事件。

返回值:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>nativeUI Example</title>
		<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	// 弹出系统等待对话框
	plus.nativeUI.showWaiting( "等待中..." );
	setTimeout( function(){
		plus.nativeUI.closeWaiting();
	}, 5000 );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
		</script>
	</head>
	<body>
	显示系统等待对话框
	5S后自动关闭
	</body>
</html>

showWaiting

显示系统等待对话框

Waiting plus.nativeUI.showWaiting( title, options );

说明:

创建并显示系统样式等待对话框,并返回等待对话框对象Waiting,显示后需调用其close方法进行关闭。

参数:

返回值:

Waiting对象

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>nativeUI Example</title>
		<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	// 弹出系统等待对话框
	var w = plus.nativeUI.showWaiting( "等待中..." );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
		</script>
	</head>
	<body>
	显示系统等待对话框
	</body>
</html>

pickDate

弹出系统日期选择对话框

void plus.nativeUI.pickDate( successCB, errorCB, options );

说明:

创建并显示系统样式日期选择对话框,可进行日期的选择。 用户操作确认后通过successCB回调函数返回用户选择的日期,若用户取消选择则通过errorCB回调。

参数:

返回值:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>nativeUI Example</title>
		<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
// 选择日期
function pickDate(){
	plus.nativeUI.pickDate( function(e){
		var d=e.date;
		console.log( "选择的日期:"+d.getFullYear()+"-"+(d.getMonth()+1)+"-"+d.getDate() );
	},function(e){
		console.log( "未选择日期:"+e.message );
	});
}
		</script>
	</head>
	<body>
	弹出系统日期选择对话框
	<br/>
	<button onclick="pickDate()">选择日期</button>
	</body>
</html>

pickTime

弹出系统时间选择对话框

void plus.nativeUI.pickTime( successCB, errorCB, options );

说明:

创建并弹出系统样式时间选择对话框,可进行时间的选择。 用户操作确认后通过successCB回调函数返回用户选择的时间,若用户取消选择则通过errorCB回调。

参数:

返回值:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>nativeUI Example</title>
		<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
// 选择时间
function pickTime(){
	plus.nativeUI.pickTime( function(e){
		var d=e.date;
		console.log( "选择的时间:"+d.getHours()+":"+d.getMinutes() );
	},function(e){
		console.log( "未选择时间:"+e.message );
	});
}
		</script>
	</head>
	<body>
	弹出系统时间选择对话框
	<br/>
	<button onclick="pickTime()">选择时间</button>
	</body>
</html>

prompt

弹出系统输入对话框

void plus.nativeUI.prompt( message, promptCB, title, tip, buttons );

说明:

创建并显示系统样式输入对话框,可设置输入对话框的标题、内容、提示输入信息、按钮数目及其文字。 弹出的输入对话框为非阻塞模式,其中包含编辑框供用户输入内容,用户点击输入对话框上的按钮后自动关闭,并通过promptCB回调函数返回用户点击的按钮及输入的内容。

参数:

返回值:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>nativeUI Example</title>
		<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	// 弹出输入对话框
	plus.nativeUI.prompt( "Input your name: ", function(e){
		console.log( ((e.index==0)?"OK: ":"Cancel")+e.value );
	},"nativeUI", "your name", ["OK","Cancel"]);
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
		</script>
	</head>
	<body>
	弹出系统输入对话框
	</body>
</html>

toast

显示自动消失的提示消息

void plus.nativeUI.toast( message, options );

说明:

创建并显示系统样式提示消息,弹出的提示消息为非阻塞模式,显示指定时间后自动消失。 提示消息显示时间可通过options的duration属性控制,长时间提示消息显示时间约为3.5s,短时间提示消息显示时间约为2s。

参数:

返回值:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>nativeUI Example</title>
		<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	// 显示自动消失的提示消息
	plus.nativeUI.toast( "I'am toast information!");
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
		</script>
	</head>
	<body>
	显示自动消失的提示消息
	</body>
</html>

ActionButtonStyle

JSON对象,原生选择按钮框上按钮的样式参数

属性:

ActionSheetStyle

JSON对象,原生选择按钮框的样式参数

属性:

PickDateOption

JSON对象,日期选择对话框的参数

属性:

PickTimeOption

JSON对象,时间选择对话框的参数

属性:

Waiting

系统等待对话框对象

说明:

可通过plus.nativeUI.showWaiting方法创建,用于控制系统样式等待对话框的操作,如关闭、设置标题内容等。

方法:

事件:

setTitle

设置等待对话框上显示的文字内容

wobj.setTitle( title );

说明:

在调用plus.nativeUI.showWaiting方法时设置等待对话框初始显示的文字内容,显示后可通过此方法动态修改等待对话框上显示的文字,设置后文字内容将立即更新。

参数:

返回值:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>nativeUI Example</title>
		<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	// 弹出系统等待对话框
	var w = plus.nativeUI.showWaiting( "等待中..." );
	// 2秒后更新
	setTimeout( function(){
			w.setTitle( "正在更新" );
	}, 2000 );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
		</script>
	</head>
	<body>
	显示系统等待对话框<br/>
	设置等待对话框上显示的文字内容
	</body>
</html>

close

关闭显示的系统等待对话框

wobj.close();

说明:

调用plus.nativeUI.showWaiting方法创建并显示系统等待界后,可通过其close方法将原生等待控件关闭。 一个系统等待对话框只能关闭一次,多次调用将无任何作用。

返回值:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>nativeUI Example</title>
		<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	// 弹出系统等待对话框
	var w = plus.nativeUI.showWaiting( "等待中..." );
	// 2秒后关闭
	setTimeout( function(){
			w.close();
	}, 2000 );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
		</script>
	</head>
	<body>
	显示系统等待对话框<br/>
	关闭显示的系统等待对话框
	</body>
</html>

onclose

等待对话框关闭事件

wobj.onclose = function() {
	console.log( "Waiting closed!" );
};

说明:

等待框关闭时触发,当调用close方法或用户点击返回按钮导致等待框关闭时触发。

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>nativeUI Example</title>
		<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	// 弹出系统等待对话框
	var w = plus.nativeUI.showWaiting( "等待中..." );
	// 关闭事件
	w.onclose = function() {
		console.log( "Waiting onclose!" );
	}
	// 2秒后关闭
	setTimeout( function(){
			w.close();
	}, 2000 );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
		</script>
	</head>
	<body>
	显示系统等待对话框<br/>
	关闭显示的系统等待对话框
	</body>
</html>

WaitingOption

JSON对象,原生等待对话框的参数

属性:

ToastOption

JSON对象,系统提示消息框要设置的参数

属性:

ActionSheetCallback

系统选择按钮框的回调函数

void onActioned( Event event ){
	// actionsheet handled code.
	var index=event.index; // 用户关闭时点击按钮的索引值
}

说明:

系统选择按钮框的回调函数

参数:

平台支持:

Android : 不支持

iOS : 4.3+

用户只能通过点击选择按钮上的按钮进行关闭。

WP : 不支持

AlertCallback

系统提示框确认的回调函数

void onAlerted(){
	// Alert handled code.
}

说明:

系统提示框确认的回调函数

平台支持:

Android : 2.2+

用户点击设备“返回”按键导致提示对话框关闭,也会触发此回调函数。

iOS : 4.3+

用户只能通过点击提示对话框上的按钮进行关闭。

WP : 7.5+

用户点击设备“返回”按键导致提示对话框关闭,也会触发此回调函数。

ConfirmCallback

关闭确认对话框的回调函数

void onConfirmed( Event event ) {
	// Confirm handled code.
	var index=event.index; // 用户关闭确认对话框点击按钮的索引值
}

说明:

关闭确认对话框的回调函数

参数:

平台支持:

Android : 2.2+

用户点击设备“返回”按键导致确认对话框关闭,则回调函数中event的index属性值为-1。

iOS : 4.3+

用户只能通过点击确认对话框上的按钮进行关闭。

WP : 7.5+

用户点击设备“返回”按键导致确认对话框关闭,则回调函数中event的index属性值为-1。

PromptCallback

系统输入对话框关闭后的回调函数

function void onPrompted( Event event ) {
	// Prompt handled code.
	var index=event.index; // 用户关闭输入对话框点击按钮的索引值
	var value=event.value; // 用户输入的内容
}

说明:

系统输入对话框关闭后的回调函数

参数:

平台支持:

Android : 2.2+

用户点击设备“返回”按键导致输入对话框关闭,则回调函数中event的index属性值为-1,value值为空字符串。

iOS : 4.3+

用户只能通过点击输入对话框上的按钮进行关闭。

WP : 7.5+

用户点击设备“返回”按键导致输入对话框关闭,则回调函数中event的index属性值为-1,value值为空字符串。

PickDatetimeSuccessCallback

选择日期或时间操作成功的回调函数

function void onPickSuccess( Event event ) {
	// Date picked code.
	var date = event.date;// 用户选择的日期或时间
}

说明:

选择日期或时间操作成功的回调函数

参数:

PickDatetimeErrorCallback

选择日期或时间操作取消或失败的回调函数

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

说明:

选择日期或时间操作取消或失败的回调函数

参数: