DJI Mobile SDK Documentation
      包:dji.open.pilot.client.interfaces
      classSince MSDK 5.20.1

      IRemoteViewPageManager

      服务端自定义布局管理器。

      Package dji.open.pilot.client.interfacesAndroid · Java / Kotlin

      服务端自定义布局管理器。

      MSDK 5.20.1开始支持

      成员

      40 个成员

      监听

      2

      方法

      11

      枚举

      14

      Class

      13
      method

      setPageLayoutParam

      Since MSDK 5.20.1
      OperationResult setPageLayoutParam(ViewPageType viewPageType, LayoutParam param)

      设置页面布局参数,当前只支持 ViewPageType.FLOATING_BOX。

      参数

      名称类型说明
      viewPageTypeViewPageType 页面类型。
      paramLayoutParam 布局参数。

      返回值

      类型说明
      OperationResult操作结果。
      method
      method

      addView

      Since MSDK 5.20.1
      OperationResult addView(ViewPageType viewPageType, RemoteView remoteView)

      添加新视图到布局。

      参数

      名称类型说明
      viewPageTypeViewPageType 页面类型。
      remoteViewRemoteView 远程视图对象。

      返回值

      类型说明
      OperationResult操作结果。
      method
      method

      addView

      Since MSDK 5.20.1
      OperationResult addView(ViewPageType viewPageType, RemoteView remoteView, String parentId, WidgetLayoutParam layoutParam)

      批量添加视图到指定父容器。

      参数

      名称类型说明
      viewPageTypeViewPageType 页面类型。
      remoteViewRemoteView 远程视图对象。
      parentIdString 父容器ID(null表示根布局)。
      layoutParamWidgetLayoutParam 布局参数(包含margin、weight、layoutGravity等)。

      返回值

      类型说明
      OperationResult操作结果。
      method

      setConstraints

      Since MSDK 5.20.1
      OperationResult setConstraints(ViewPageType viewPageType, String viewId, String targetId, ViewSide viewDirection, ViewSide targetDirection, int margin)

      设置视图约束。

      参数

      名称类型说明
      viewPageTypeViewPageType 页面类型。
      viewIdString 视图ID。
      targetIdString 目标视图ID。
      viewDirectionViewSide 视图方向。
      targetDirectionViewSide 目标方向。
      marginint 边距。

      返回值

      类型说明
      OperationResult操作结果。
      method

      setConstraints

      Since MSDK 5.20.1
      OperationResult setConstraints(ViewPageType viewPageType,String layoutId, String viewId, String targetId, ViewSide viewDirection, ViewSide targetDirection, int margin)

      在指定父布局下设置视图约束。

      参数

      名称类型说明
      viewPageTypeViewPageType 页面类型。
      layoutIdString 父布局ID。
      viewIdString 视图ID。
      targetIdString 目标视图ID。
      viewDirectionViewSide 视图方向。
      targetDirectionViewSide 目标方向。
      marginint 边距。

      返回值

      类型说明
      OperationResult操作结果。
      method

      updateView

      Since MSDK 5.20.1
      OperationResult updateView(ViewPageType viewPageType, String viewId, RemoteViewProperty property, String value)

      更新视图属性。

      参数

      名称类型说明
      viewPageTypeViewPageType 页面类型。
      viewIdString 视图ID。
      propertyRemoteViewProperty 属性类型。
      valueString 属性值。颜色类属性(TEXT_COLOR / BACKGROUND_COLOR / PROGRESS_COLOR / SPINNER_DROPDOWN_BG_COLOR / SPINNER_DROPDOWN_TEXT_COLOR / SPINNER_SELECTED_TEXT_COLOR / SPINNER_ICON_COLOR)的 value 请传颜色 Int 值对应的十进制字符串,例如 String.valueOf(Color.RED) 或 color.toString()。不支持 "#RRGGBB" / "0xAARRGGBB" / "R.color.xxx" 等字符串格式。

      返回值

      类型说明
      OperationResult操作结果。
      method

      updateView

      Since MSDK 5.20.1
      OperationResult updateView(ViewPageType viewPageType, String viewId, Map<RemoteViewProperty, String> propertyMap)

      批量更新视图属性。

      参数

      名称类型说明
      viewPageTypeViewPageType 页面类型。
      viewIdString 视图ID。
      propertyMapMap<RemoteViewProperty, String> 属性Map(key为RemoteViewProperty,value为属性值)。

      返回值

      类型说明
      OperationResult操作结果。
      method
      method

      queryView

      Since MSDK 5.20.1
      List<RemoteView> queryView(ViewPageType viewPageType)

      查询所有的View。

      参数

      名称类型说明
      viewPageTypeViewPageType 页面类型。

      返回值

      类型说明
      List<RemoteView>远程视图列表。
      method

      clearLayout

      Since MSDK 5.20.1
      OperationResult clearLayout(ViewPageType viewPageType)

      清除所有视图。

      参数

      名称类型说明
      viewPageTypeViewPageType 页面类型。

      返回值

      类型说明
      OperationResult操作结果。
      method

      clearLayout

      Since MSDK 5.20.1
      OperationResult clearLayout(ViewPageType viewPageType,String viewId)

      清除某个布局下的子视图。

      参数

      名称类型说明
      viewPageTypeViewPageType 页面类型。
      viewIdString 视图ID。

      返回值

      类型说明
      OperationResult操作结果。
      method

      addActivityLifecycleListener

      Since MSDK 5.20.1
      void addActivityLifecycleListener(IRemoteActivityLifecycleListener listener)

      注册Remote Activity生命周期监听器。

      参数

      名称类型说明
      listenerIRemoteActivityLifecycleListener Remote Activity生命周期监听器。
      method

      removeActivityLifecycleListener

      Since MSDK 5.20.1
      void removeActivityLifecycleListener(IRemoteActivityLifecycleListener listener)

      注销Remote Activity生命周期监听器。

      参数

      名称类型说明
      listenerIRemoteActivityLifecycleListener Remote Activity生命周期监听器。
      method

      setActivityInfo

      Since MSDK 5.20.1
      OperationResult setActivityInfo(ActivityConfig activityInfo)

      设置Remote Activity的配置信息。

      参数

      名称类型说明
      activityInfoActivityConfig Remote Activity配置信息。

      返回值

      类型说明
      OperationResult操作结果。
      class

      ActivityConfig

      Since MSDK 5.20.1
      class ActivityConfig implements Parcelable

      全屏视图配置。

      class

      DividerConfig

      Since MSDK 5.20.1
      @Keep
      class DividerConfig

      列表分割线配置,定义 VERTICAL_LIST_VIEW 分割线的样式。通过 Gson 序列化/反序列化在 Client 与 Server 之间传输。

      enum

      EllipsizeType

      Since MSDK 5.20.1

      文本截断方式枚举。当文本超出 maxLines 时,控制超出部分的显示方式。

      枚举成员

      名称说明
      UNKNOWN未知(不设置截断,文本超出时直接裁剪)。
      START在文本开头截断,以省略号替代(…text)。
      MIDDLE在文本中间截断,以省略号替代(te…xt)。
      END在文本末尾截断,以省略号替代(text…)。
      MARQUEE跑马灯效果,文本滚动显示。
      enum

      FontStyleType

      Since MSDK 5.20.1

      字体样式枚举。

      枚举成员

      名称说明
      UNKNOWN未知字体样式(默认值或未识别值)。
      NORMAL正常样式(非粗体、非斜体)。
      BOLD粗体样式。
      ITALIC斜体样式。
      BOLD_ITALIC粗体 + 斜体样式。
      enum

      GravityType

      Since MSDK 5.20.1

      对齐方式枚举。

      枚举成员

      名称说明
      UNKNOWN未知对齐类型(默认值或未识别值)。
      NO_GRAVITY不对齐。
      TOP顶部对齐(内容在容器顶部)。
      BOTTOM底部对齐(内容在容器底部)。
      LEFT左对齐(兼容旧版本布局方向 LTR)。
      RIGHT右对齐(兼容旧版本布局方向 LTR)。
      CENTER_HORIZONTAL水平居中(内容在水平方向居中)。
      CENTER_VERTICAL垂直居中(内容在垂直方向居中)。
      CENTER完全居中(水平+垂直居中)。
      START起始对齐(基于布局方向,LTR 为左对齐,RTL 为右对齐)。
      END结束对齐(基于布局方向,LTR 为右对齐,RTL 为左对齐)。
      class

      IRemoteViewOnCheckedChangeListener

      Since MSDK 5.20.1
      @Keep
      interface IRemoteViewOnCheckedChangeListener

      视图选中状态变化监听器。

      class

      IRemoteViewOnClickListener

      Since MSDK 5.20.1
      @Keep
      interface IRemoteViewOnClickListener

      视图点击事件监听器。

      class

      IRemoteViewOnItemSelectedListener

      Since MSDK 5.20.1
      @Keep
      interface IRemoteViewOnItemSelectedListener

      下拉框选项选中事件监听器。

      class

      IRemoteViewTextWatcher

      Since MSDK 5.20.1
      @Keep
      interface IRemoteViewTextWatcher

      视图文本变化监听器。

      enum

      InputType

      Since MSDK 5.20.1

      EditText 键盘输入类型枚举,对应 Android InputType 常量。决定弹出的软键盘类型及输入限制。

      枚举成员

      名称说明
      UNKNOWN未知(默认,使用系统默认输入类型)。
      TEXT普通文本输入(默认文本键盘)。
      TEXT_MULTI_LINE多行文本输入。
      NUMBER整数数字输入(数字键盘)。
      NUMBER_DECIMAL带小数点的数字输入。
      NUMBER_SIGNED可带符号(正负号)的数字输入。
      PHONE电话号码输入(拨号键盘)。
      EMAIL_ADDRESS电子邮件地址输入(带 @ 符号的文本键盘)。
      PASSWORD密码输入(文本内容以圆点遮罩显示)。
      NUMBER_PASSWORD数字密码输入(纯数字,以圆点遮罩显示)。
      class

      LayoutParam

      Since MSDK 5.20.1
      class LayoutParam implements Parcelable

      服务端布局参数。

      class

      ListItemData

      Since MSDK 5.20.1
      @Keep
      class ListItemData

      列表Item数据模型,描述 VERTICAL_LIST_VIEW 中单个Item的内容。通过 Gson 序列化/反序列化在 Client 与 Server 之间传输。

      class

      ListItemOperation

      Since MSDK 5.20.1
      @Keep
      class ListItemOperation

      列表Item增量操作数据,用于 INSERT / UPDATE 操作的序列化传输。包含操作目标位置和Item数据,通过 Gson 序列化/反序列化在 Client 与 Server 之间传输。

      enum

      ListItemType

      Since MSDK 5.20.1

      列表Item类型枚举,定义 VERTICAL_LIST_VIEW 支持的预定义Item布局类型。

      枚举成员

      名称说明
      TEXT纯文本Item。
      ICON_TEXT图标+标题Item。
      ICON_TWO_LINE图标+双行文本Item(标题+副标题)。
      enum

      OperationResult

      Since MSDK 5.20.1

      远端View操作结果。

      枚举成员

      名称说明
      UNKNOWN结果未知。
      SUCCESS成功。
      NO_SUCH_VIEW_ID该ID不存在。
      EXECUTION_FAILED执行失败。
      SERVICE_NOT_FOUND服务已断连。
      INVALID_PROPERTY服务端异常。
      INVALID_VIEW_PAGE_TYPE无效页面类型。
      INVALID_ACTIVITY_LIFECYCLE_STATE无效的服务端activity状态。
      NOT_SUPPORTED暂时不支持。
      DIALOG_ALREADY_EXISTS对话框已存在,请勿重复添加。
      DIALOG_NOT_SUPPORTED_ON_CURRENT_PAGE当前页面不支持弹出Dialog。
      NO_SUCH_PARENT_VIEW_ID该父类ID不存在。
      REMOTE_VIEWS_LIMIT_EXCEEDED当前页面的 RemoteView 缓存已达上限,请调用 clearLayout(viewPageType) 全量清空该页面后再重新添加视图。
      enum

      ProgressStatusType

      Since MSDK 5.20.1

      圆形进度条状态枚举。

      枚举成员

      名称说明
      NORMAL正常状态,圆心显示文字。
      SUCCESS成功状态,圆心显示成功图标,隐藏文字。
      FAIL失败状态,圆心显示失败图标,隐藏文字。
      class

      RemoteView

      Since MSDK 5.20.1
      class RemoteView implements Parcelable

      服务端View。

      enum

      RemoteViewProperty

      Since MSDK 5.20.1

      远程视图属性枚举(定义可动态修改的视图属性类型)。

      枚举成员

      名称说明
      UNKNOWN未知属性类型(默认值或未定义属性)。
      TEXT文本内容属性(适用于TextView/Button/EditText等文本控件)。
      BACKGROUND_COLOR背景颜色属性(ARGB格式的颜色值)。
      WEB_VIEW_URLWebView加载地址(指定要渲染的网页URL)。
      PROGRESS进度值属性(设置ProgressBar等组件的当前进度百分比)。
      IMAGE图像资源属性(设置ImageView的位图或资源ID)。
      TEXT_SIZE文字大小(单位:sp)。
      TEXT_COLOR文字颜色。
      EDIT_TEXT_CURSOR_POSITION光标位置。
      GRAVITY文本对齐方式。
      FONT_STYLE_TYPE字体样式枚举。
      SCALE_TYPE图片填充方式。
      VERTICAL_SCROLLABLE文本是否支持竖向滚动。仅对 TextView 类控件生效。
      EDIT_TEXT_HINTEditText 的 hint 文本。
      EDIT_TEXT_GROUPINGEditText 分组。
      SPINNER_ITEMS下拉框选项列表(使用 RemoteView.ITEMS_SEPARATOR 分隔每个选项)。
      SPINNER_SELECTED_INDEX下拉框当前选中项索引。
      SPINNER_DROPDOWN_BG_COLOR下拉列表弹出层背景颜色(ARGB格式)。
      SPINNER_DROPDOWN_TEXT_COLOR下拉列表选项字体颜色(ARGB格式)。
      CHECKEDCompoundButton(CheckBox / Switch / ToggleButton)的选中状态(true / false)。仅对 CHECK_BOX / SWITCH / TOGGLE_BUTTON 有效。
      VISIBILITY控件可见性(VISIBLE / INVISIBLE / GONE)。适用于所有控件。
      ENABLED控件启用/禁用状态(true / false)。适用于所有控件,禁用后控件不可交互且显示禁用样式。
      PADDING控件内边距,格式为 "left,top,right,bottom"(单位 dp)。适用于所有控件。
      MAX_LINES文本最大显示行数(正整数)。仅对 TEXT_VIEW / BUTTON / EDIT_TEXT 有效。
      ELLIPSIZE文本截断方式,超出 maxLines 时生效。值使用 EllipsizeType 枚举的 value 字符串。仅对 TEXT_VIEW / BUTTON / EDIT_TEXT 有效。
      INPUT_TYPEEditText 键盘输入类型(文本 / 数字 / 密码 / 邮箱等)。值使用 InputType 枚举的 value 字符串。仅对 EDIT_TEXT 有效。
      MAX_LENGTHEditText 最大输入字符数(正整数)。仅对 EDIT_TEXT 有效。
      PROGRESS_MAXProgressBar 的最大值(正整数,默认为 100)。仅对 PROGRESS_BAR 有效。
      BACKGROUND_SHAPE背景形状样式。适用于所有控件。
      LIST_DATA列表全量数据(JSON数组格式)。仅对 VERTICAL_LIST_VIEW 有效。
      LIST_INSERT_ITEM列表插入单条数据(JSON格式,包含position和item数据)。仅对 VERTICAL_LIST_VIEW 有效。
      LIST_REMOVE_ITEM列表删除单条数据(值为position字符串)。仅对 VERTICAL_LIST_VIEW 有效。
      LIST_UPDATE_ITEM列表更新单条数据(JSON格式,包含position和item数据)。仅对 VERTICAL_LIST_VIEW 有效。
      LIST_DIVIDER_CONFIG列表分割线配置(JSON格式,包含height/color/paddingLeft/paddingRight/showLastDivider)。仅对 VERTICAL_LIST_VIEW 有效。
      LIST_ITEM_CLICK_ENABLED列表Item点击事件是否启用("true"/"false")。仅对 VERTICAL_LIST_VIEW 有效。
      PROGRESS_COLOR进度条颜色(ARGB 格式整型)。仅对进度条有效。
      PROGRESS_TEXT_SIZE圆形进度条中心文字大小(单位:sp,正整数)。仅对 CIRCULAR_PROGRESS_BAR 有效。
      PROGRESS_STATUS圆形进度条状态(正常 / 成功 / 失败)。值使用 ProgressStatusType 枚举的 value 字符串。处于 SUCCESS / FAIL 状态时,圆心隐藏文字,显示对应图标。仅对 CIRCULAR_PROGRESS_BAR 有效。
      ALPHA控件透明度(float,范围 0.0 ~ 1.0,0.0 完全透明,1.0 完全不透明)。适用于所有控件。
      SINGLE_LINE文本单行模式("true" / "false")。仅对 TEXT_VIEW / BUTTON / EDIT_TEXT 有效。
      LINE_SPACING文本行间距,JSON 格式 {"extra":float,"multiplier":float}。extra 单位 dp(额外间距),multiplier 为行距倍数。示例:{"extra":4.0,"multiplier":1.2}。仅对 TEXT_VIEW / BUTTON 有效。
      TEXT_DECORATION文本装饰(下划线、删除线)。值使用 TextDecorationType 枚举的 value 字符串。仅对 TEXT_VIEW / BUTTON 有效。
      HINT_TEXT_COLOREditText 提示文字颜色(ARGB 格式整型)。仅对 EDIT_TEXT 有效。
      SWITCH_THUMB_COLORSwitch 滑块颜色(ARGB 格式整型)。仅对 SWITCH 有效。
      SWITCH_TRACK_COLORSwitch 轨道颜色(ARGB 格式整型)。仅对 SWITCH 有效。
      CHECKBOX_TINTCheckBox 勾选框着色(ARGB 格式整型)。未选中态:边框变为目标颜色;选中态:边框和填充都变为目标颜色,勾保持白色。仅对 CHECK_BOX 有效。
      MIN_SIZE控件最小尺寸,格式为 "minWidth,minHeight"(单位 dp)。适用于所有控件。
      LETTER_SPACING文本字间距(float,单位 em,如 0.1 表示每个字符间增加 0.1em 间距)。仅对 TEXT_VIEW / BUTTON 有效。
      IMAGE_TINTImageView 图片着色(ARGB 格式整型)。常用于图标的颜色切换。仅对 IMAGE_VIEW 有效。
      SPINNER_SELECTED_TEXT_COLOR下拉框当前选中项文本颜色(ARGB格式)。
      SPINNER_ICON_COLOR下拉框图标颜色(ARGB格式)。
      enum

      ScaleType

      Since MSDK 5.20.1

      图片缩放类型枚举(用于标识 ImageView 的 ScaleType 模式)。

      枚举成员

      名称说明
      UNKNOWN未知缩放类型(默认值或未识别值)。
      MATRIX使用矩阵(Matrix)控制缩放和位置。
      FIT_XY拉伸图片以匹配视图边界(不保持宽高比例)。
      FIT_START保持比例缩放至视图大小,图片顶端对齐。
      FIT_CENTER保持比例缩放至视图大小,图片居中。
      FIT_END保持比例缩放至视图大小,图片底端对齐。
      CENTER原始大小居中显示,超出部分裁剪。
      CENTER_CROP居中缩放图片,填满视图并保持比例,可能会裁剪。
      CENTER_INSIDE居中缩放图片至可见范围,保持比例,不裁剪。
      class

      ShapeDescriptor

      Since MSDK 5.20.1
      class ShapeDescriptor

      背景形状描述符,封装圆角、描边、填充色等背景样式。

      enum

      TextDecorationType

      Since MSDK 5.20.1

      文本装饰类型枚举(下划线、删除线)。用于 TEXT_DECORATION 属性。

      枚举成员

      名称说明
      NONE无装饰(清除下划线和删除线)。
      UNDERLINE下划线。
      STRIKE_THROUGH删除线。
      UNDERLINE_AND_STRIKE_THROUGH下划线 + 删除线。
      class

      TextSpanSeparatorConfig

      Since MSDK 5.20.1
      class TextSpanSeparatorConfig implements Parcelable

      文本分组分隔符配置,用于按固定分组间隔在文本中插入分隔字符。groupSize 为分组大小(0 表示不分组),separatorChar 为分隔字符(默认为空格)。

      enum

      ViewPageType

      Since MSDK 5.20.1

      视图页面类型。

      枚举成员

      名称说明
      UNKNOWN未知类型。
      FLOATING_BOX浮窗类型。宽度固定为 140dp,默认高度 200dp(可通过 LayoutParam.setHeight(int) 修改高度,单位 dp)。
      ACTIVITY全屏类型。
      enum

      ViewSide

      Since MSDK 5.20.1

      约束布局视图方向。

      枚举成员

      名称说明
      UNKNOWN布局未知方向。
      START布局起始方向。
      END布局结束方向。
      TOP布局顶部方向。
      BOTTOM布局底部方向。
      enum

      ViewType

      Since MSDK 5.20.1

      视图类型枚举(标识远程视图的UI组件类型)。

      枚举成员

      名称说明
      UNKNOWN未知视图类型(默认值或未识别类型)。
      TEXT_VIEW文本视图(显示静态文本内容)。
      BUTTON按钮控件(支持点击交互操作)。
      TOGGLE_BUTTON切换按钮(具有开/关两种状态的按钮)。
      SWITCH开关控件(可视化状态切换组件)。
      WEB_VIEW网页视图(用于渲染网页内容)。
      EDIT_TEXT文本编辑框(支持用户输入文本)。
      CHECK_BOX复选框(支持多项选择的勾选框)。
      IMAGE_VIEW图片视图(显示位图或矢量图像)。
      PROGRESS_BAR进度条(展示任务进度状态)。
      LINEAR_LAYOUT_HORIZONTAL水平线性布局容器(子View水平排列)。
      LINEAR_LAYOUT_VERTICAL垂直线性布局容器(子View垂直排列)。
      CONSTRAINT_LAYOUT约束布局容器(支持复杂约束关系)。
      SPINNER下拉框控件(支持单项选择的下拉列表)。
      VERTICAL_LIST_VIEW垂直列表视图(支持垂直滚动的列表控件,内置多种预定义Item类型)。
      CIRCULAR_PROGRESS_BAR圆形进度条(以圆弧形式展示确定进度,支持 PROGRESS / PROGRESS_COLOR / TEXT / TEXT_COLOR 属性)。
      enum

      VisibilityType

      Since MSDK 5.20.1

      控件可见性枚举,对应 Android View.VISIBLE / View.INVISIBLE / View.GONE。

      枚举成员

      名称说明
      UNKNOWN未知(默认值)。
      VISIBLE可见(控件正常显示,占用布局空间)。
      INVISIBLE不可见(控件隐藏,但仍占用布局空间)。
      GONE完全隐藏(控件隐藏且不占用布局空间)。
      class

      WidgetLayoutParam

      Since MSDK 5.20.1
      class WidgetLayoutParam implements Parcelable

      Widget布局参数(用于子View在父容器中的布局配置)。