未完待续

main.aly 文件 table Map

本页内容

• 事件说明
  • onCreate(savedInstanceState) 生命周期
  • onCreateOptionsMenu(menu)
  • onOptionsItemSelected(item)
  • onKeyShortcut(keyCode, event)
  • onConfigurationChanged(config)
  • onResume() 生命周期
  • onPause() 生命周期 v5.1.1+
  • onStart() 生命周期 v5.0.4+
  • onStop() 生命周期 v5.0.4+
  • onDestroy() 生命周期
  • onResult(name, action, content)
  • refreshMenusState()
• 管理器、工具 API
  • EditorsManager table Manager
  • FilesBrowserManager table Manager
  • FilesTabManager table Manager
  • ProjectManager table Manager
  • LuaEditorHelper table Manager
• 其他 API
  • 快速检查文件是否相同
  • 颜色类
  • editorLayouts table Map
  • showSnackBar(text)
  • openFileITPS(path)
  • runLuaFile(file,code)
  • showSnackBar(text)
  • getTableIndexList(mTable)
  • authorizeHWApplicationPermissions(uri) v5.1.0+
  • safeLoadLayout(path,parent) v5.1.1+
  • copyFilesFromDocumentFile(documentFile,targetPath) v5.1.1+
  • runInTermux(cmd,args,config) v5.1.1+
  • path2DocumentUri(path) v5.1.1+

config/events/main.aly : 主页面事件存放文件

事件说明

onCreate(savedInstanceState) 生命周期

Activity 生命周期：onCreate()

这是页面创建时候执行的事件
此时软件即将自动打开上一次或者传入的工程，以及刷新 toggle 状态

参数	说明
savedInstanceState	Bundle: 如果 Activity 在先前被关闭后被重新初始化，那么这个 Bundle 包含它最近在 onSaveInstanceState(Bundle) 中提供的数据。注意：默认值为 nil。

返回类型	说明
boolean	如果返回 true 则停止执行接下来的操作（如：自动打开工程等）。 v5.0.3+

代码执行顺序：

调用插件事件 - 判断返回值，检测并打开项目 - 同步 toggle 状态

注意

在 v5.0.3(50399) 之前，代码执行顺序为：

检测并打开项目 - 调用插件事件 - 同步 toggle 状态

onCreateOptionsMenu(menu)

这是创建菜单时执行的事件

参数	说明
menu	Menu: 你在其中放置项目的选项菜单。

代码执行顺序：

添加自带菜单 - 执行插件事件

onOptionsItemSelected(item)

这是菜单被点击时执行的事件

参数	说明
item	MenuItem: 被选中的菜单项。此值不能为空。

代码执行顺序：

添加自带菜单 - 调用插件事件 - 标记 LoadedMenu 为 true - 刷新菜单状态

警告

Aide Lua 未使用标准的菜单更新方式，因此您使用 activity.invalidateOptionsMenu() 无法刷新菜单显示。相反，您应该使用 refreshMenusState() 来刷新菜单显示。

onKeyShortcut(keyCode, event)

按键被按 当一个快捷键事件没有被 Activity 中的任何视图处理时被调用。覆盖此方法以实现 Activity 的全局按键快捷方式。按键快捷方式也可以通过设置菜单项的快捷方式属性来实现。

参数	说明
keyCode	int: event.getKeyCode() 中的值。
event	KeyEvent: 按键事件的描述。

返回类型	说明
boolean	如果返回 true 则停止执行接下来的操作（响应自带快捷键）。 v5.0.4+

代码执行顺序：

调用插件事件 - 判断返回值，响应自带快捷键事件

注意

在 v5.0.4(50499) 之前，代码执行顺序为：

响应自带快捷键事件 - 调用插件事件

onConfigurationChanged(config)

配置文件发生改变，常见于屏幕旋转

参数	说明
config	Configuration:新设备配置。此值不能为 nil

onResume() 生命周期

Activity 生命周期：onResume()

常见于返回到页面

onPause() 生命周期 v5.1.1+

Activity 生命周期：onPause()

Activity 暂停时执行，常见于切到后台

onStart() 生命周期 v5.0.4+

Activity 生命周期：onStart()

Activity 开始时执行，常见于回到页面

onStop() 生命周期 v5.0.4+

Activity 生命周期：onStop()

Activity 停止时执行，常见于切到后台

onDestroy() 生命周期

Activity 生命周期：onDestroy()

Activity 销毁时执行，常见于关闭页面

onResult(name, action, content)

有返回参数时执行，这里一般都是Lua页面返回的。

参数	说明
name	页面名称，Androlua 自动赋的值，多半为 main，不要管
action	事件名称，如 project_created_successfully
content	返回的内容，目前只能接收一个内容

提示

在新Lua页面中返回参数：

activity.result({<action>，<content>})

refreshMenusState()

刷新菜单状态

管理器、工具 API

EditorsManager table Manager

键	类型	说明
editor	View	编辑器视图
editorConfig	table (map)	编辑器配置
editorType	string	编辑器名称（有时也叫做编辑器类型）
actions	table (map)	编辑器事件映射
actionsWithEditor v5.1.1+	table (map)	编辑器事件映射，支持指定编辑器
openNewContent(filePath,fileType,decoder)	function	打开新内容 filePath (string): 文件路径 fileType (string): 文件扩展名 decoder (metatable(map)): 文件解析工具
startSearch()	function	启动搜索
save2Tab()	function	保存到标签
checkEditorSupport(name)	function	检查编辑器是否支持功能 name (string): 功能名称
isEditor()	function	是不是可编辑的编辑器
switchPreview(state)	function	切换预览 state (boolean): 状态
switchLanguage(language)	function	切换语言 language (Object): 语言
switchEditor(editorType)	function	切换编辑器 editorType (string): 编辑器类型
symbolBar	table (map)	符号栏
typefaceChangeListeners v5.0.4+	table (list)	编辑器字体监听器
sharedDataChangeListeners v5.1.0+	table (map)	软件配置监听器
refreshEditorScrollState()	function	刷新编辑器滚动状态，包括阴影。
magnifier v5.1.0+	table (map)	放大镜管理器

已废除

键	类型	说明
keyWordsList	忘了	编辑器提示词列表
keyWords	String[]	编辑器默认提示词列表
jesse205KeyWords	String[]	Jesse205库提示词列表
fileType2Language	忘了	文件类型转语言索引列表

EditorsManager.typefaceChangeListeners table List Listener v5.0.4+

编辑器字体监听器

格式：

{
    function(typeface, boldTypeface, italicTypeface)
        -- typeface: 支持字体
        -- boldTypeface: 粗体
        -- italicTypeface: 斜体 (意大利体)

        -- 这里开始写你的代码
    end,
    -- ...
}

提示

在编辑器初始化时，一般不需要您刻意地把 onTypefaceChangeListener 添加到此列表。因为 EditorsManager 会自动帮您完成添加。

EditorsManager.sharedDataChangeListeners table Map Listener v5.1.0+

编辑器字体监听器

格式：

{
    key1={
      function(newValue)
        -- newValue: 新值
        -- 这里开始写你的代码
      end,
      -- ...
    },
    key2={
      function(newValue)
        -- newValue: 新值
        -- 这里开始写你的代码
      end,
      -- ...
    }
    -- ...
}

提示

在编辑器初始化时，一般不需要您刻意地把 onSharedDataChangeListeners 添加到此列表。因为 EditorsManager 会自动帮您完成添加。

EditorsManager.actions table Map

键	类型	返回类型	说明
undo()	function	/	撤销
redo()	function	/	重做
format()	function	/	格式化
commented()	function	/	注释
getText()	function	string	获取编辑器文字内容
setText()	function	/	设置编辑器文字内容
check(show)	function	/	代码查错 show (string): 展示结果
paste(text)	function	/	粘贴文字内容 text (string): 文字内容
setTextSize(size)	function	/	设置文字大小 size (number): 文字大小
search(text,gotoNext)	function	/	搜索 text (number): 搜索内容 gotoNext (boolean): 是否搜索下一个
getSelectedText()	function	string	获取已选择的文字
...	function	...	此 table 已设置为 metatable，因此您可以像调用 View 一样调用编辑器

提示

如果调用 getXxx 类型以外的 API 时，第一个返回值为编辑器是否支持该功能的 Boolean 值

对于编辑器插件开发者，您需要在自定义事件内返回 true ，表示编辑器支持此功能

EditorsManager.actionsWithEditor table Map v5.1.1+

和 EditorsManager.actions 差不多，唯一的区别是他的方法们首个参数为 editorConfig ，以指定编辑器。

EditorsManager.symbolBar table Map

键	类型	说明
getReallPasteText(view) v5.1.0+	function	获取符号栏要粘贴到文字
onButtonClickListener(view) v5.1.0+	function (listener)	符号栏按钮点击时输入符号
onButtonLongClickListener(view) 仅 v5.1.0	function (listener)	符号栏按钮长按时显示预览
psButtonClick(view) v5.1.0 废除	function (listener)	符号栏按钮点击时输入符号点击事件
newPsButton(text,config)	function	初始化一个符号栏按钮 config (table): 按钮配置 v5.1.0+
refresh(state)	function	刷新符号栏状态 state (boolean): 开关状态
symbols v5.1.0+	table (list)	按钮配置

EditorsManager.magnifier table Map v5.1.0+

• 类型：MagnifierManager

FilesBrowserManager table Manager

这是文件浏览器管理器（侧滑）

未完待续

键	类型	说明
providers	table (map)	提供者映射
highlightIndex	number	高亮显示的项目索引（从 0 开始）
openState	boolean	侧滑打开状态
directoryFile	File	当前文件浏览器文件夹，未打开工程时为 nil

方法	说明
isModuleRootPath(path) v5.1.1+	判断是不是模块根路径
getNowModuleDirName(fileRelativePath) v5.1.1+	获取当前模块目录名称，如果当前路径不在模块内，则返回主模块名称 fileRelativePath (string): 相对与项目的路径

FilesTabManager table Manager

这是标签页管理器，兼职管理文件的读取与保存

方法	说明
getScrollDbKeyByPath(path) v5.1.1+	自动通过当前编辑器获取滚动的数据库的键

ProjectManager table Manager

这是项目管理器，只能管理单个项目，兼职提供文件路径的绝对路径转相对路径

方法	说明
refreshProjectsPath(autoFix)	刷新工程路径 autoFix (boolean): 是否自动修复路径错误，默认为 true

LuaEditorHelper table Manager

这是 LuaEditor 助手，可以方便处理很多东西

其他 API

快速检查文件是否相同

isSamePathFileByPath(filePath1,filePath2)

通过文件路径比较文件是否相同

参数	说明
filePath1	string: 第一个文件路径
filePath2	string: 第二个文件路径

isSamePathFile(file1,file2)

通过文件本身比较文件是否相同

参数	说明
file1	File: 第一个文件
file2	File: 第二个文件

颜色类

formatColor2Hex(color)

将 number 类型的颜色值转换为字符串的16进制

参数	说明
color	number: 颜色值

返回类型	说明
string	颜色值

getColorAndHex(text)

获取文字内颜色的数值和16进制

参数	说明
text	number: 待分析的文本

返回类型	说明
number	颜色值
string	颜色值

editorLayouts table Map

编辑器布局等配置

格式说明

EditorViewName={
  layout={ -- 编辑器布局
    -- ...
  },
  action={ -- 编辑器的各种事件
    undo="default",
    redo="default",
    format="default",
    search="default",
    getText="default",
    setText="default",
    -- ...
  },
  init=function(ids,config)
    -- 初始化事件
    -- ...
  end,
  onTypefaceChangeListener=function(ids,config,editor,typeface,boldTypeface,italicTypeface)
    -- typeface: 正常字体
    -- boldTypeface: 加粗字体
    -- italicTypeface: 意大利体（斜体）
    -- ...
  end,
  onSharedDataChangeListeners={
    editor_wordwrap=function(ids,config,editor,newValue)
      -- ...
    end,
    -- ...
  },
  supportScroll=false;-- 支持滚动
},

LuaEditor 说明

在 LuaEditor 下面，还有

---将要添加到LuaEditor的关键词列表
---更改后需要执行 application.set("luaeditor_initialized", false) ，以便在下次进入页面时更新
---使用 activity.recreate() 重启页面
---index 为方便更改内容，请使用 string 类型，当然 number 类型也能用
---@type table<string, String[]>
keywordsList={
  --一些常用但不自带的类
  annotationsWords=String{"class","type","alias","param","return","field","generic","vararg","language","example"},
  otherWords=String{"PhotoView","LuaLexerIteratorBuilder"},
},

---@type table<string, String[]>
---@see keywordsList
packagesList={
  --otherPackages=Map{hello=String{"world"},jesse205=String{"nb"}},
},

警告

除此之外还有jesse205Keywords与normalKeywords，这些是编辑器默认的关键字，您不应该动这些东西

showSnackBar(text)

显示 SnackBar (底部提示)

参数	说明
text	string: 显示的文字

openFileITPS(path)

用外部应用打开文件

参数	说明
path	string: 文件路径

runLuaFile(file,code)

在单独的页面运行Lua代码

参数	说明
file	File: 文件对象
code	string: 代码

注意

当 file 不为 nil ，并且此文件存在时，则直接运行此文件，否则运行 code 中的代码

showSnackBar(text)

智能根据侧滑栏打开状态显示 SnackBar

参数	说明
text	string: 提示的内容

getTableIndexList(mTable)

获取table的索引列表

参数	说明
mTable	table: 随便的 table

返回类型	说明
table (list)	mTable的索引列表

authorizeHWApplicationPermissions(uri) v5.1.0+

目的是兼容华为文件管理的拖拽功能。

授予 Action 为 android.intent.action.SEND 并且 Flag 为 268435456的所有应用、com.huawei.desktop.systemui 和 com.huawei.desktop.explorer uri 的权限（自动获取类型）。

safeLoadLayout(path,parent) v5.1.1+

安全加载 lua 布局，避免污染全局变量

参数	说明
path	string: 随便的 table
parent	ViewGroup: 父布局类

返回类型	说明
View	生成的视图

copyFilesFromDocumentFile(documentFile,targetPath) v5.1.1+

复制文件，从 DocumentFile 内。目前文件夹只能复制 DocumentUi 的 uri

参数	说明
documentFile	_DocumentFile: 原文件
targetPath	string: 目标文件夹

runInTermux(cmd,args,config) v5.1.1+

在 Termux 内运行代码

参数	说明
cmd	string: 运行的程序
args	table(string[]): 参数
config	table(map): 配置

path2DocumentUri(path) v5.1.1+

将路径转换为 DocumentUi的 uri

参数	说明
path	string: 路径