Foxit PDF SDK for HarmonyOS  3.0
uiextensions.IMainFrame Class Reference

Public Member Functions

 addAttachBarItem (type, toolType, itemBean)
 
 addTab (tabType, title)
 
 getBottomBarImpl ()
 
 getCurTopBarTab ()
 
 getCustomBottomBar ()
 
 getCustomTopBar ()
 
 getFullScreenBottomBarImpl ()
 
 getTabTools ()
 
 getTopBarImpl ()
 
 hasTab (tabType)
 
 hideToolbars ()
 
 isFullScreen ()
 
 isSupportFullScreen ()
 
 isToolbarEnabled (position 'top'| 'bottom')
 
 isToolbarsVisible ()
 
 registerFullscreenStateChangedListener (listener)
 
 removeTab (tabType)
 
 setCurrentTab (tabType)
 
 setCustomBottomBar (bar)
 
 setCustomTopBar (bar)
 
 setFullScreen (fullScreen)
 
 setToolbarEnabled (position 'top'| 'bottom', enabled)
 
 showToolbars ()
 
 unregisterFullscreenStateChangedListener (listener)
 

Detailed Description

接口定义了PDF阅读器主框架,提供访问阅读器UI的入口。 例如:getTopBarImpl/getBottomBarImpl方法将提供PDF视图控制器的顶部栏和底部栏接口,可通过这些接口修改或自定义阅读器UI。

Member Function Documentation

◆ addAttachBarItem()

uiextensions.IMainFrame.addAttachBarItem ( type  ,
toolType  ,
itemBean   
)

在指定标签页的附加栏添加功能项

Parameters
type目标标签页类型 TOP_TOOL_BAR_TAB
toolType要添加的功能项类型 TOP_TOOL_ATTACH_BAR_ITEM
itemBean功能项配置对象(可选) ToolItemBean
Returns
返回创建的基础项实例IBaseItem或undefined

◆ addTab()

uiextensions.IMainFrame.addTab ( tabType  ,
title   
)

添加标签页

Parameters
tabType标签类型标识符
title标签显示文本资源

◆ getBottomBarImpl()

uiextensions.IMainFrame.getBottomBarImpl ( )

获取底部工具栏实现类

Returns
返回BottomBarImpl实例或undefined

◆ getCurTopBarTab()

uiextensions.IMainFrame.getCurTopBarTab ( )

获取当前顶部栏选中的标签页类型

Returns
返回当前选中的TOP_TOOL_BAR_TAB枚举值

◆ getCustomBottomBar()

uiextensions.IMainFrame.getCustomBottomBar ( )

获取当前自定义底部栏

Returns
返回FSBottomBar实例

◆ getCustomTopBar()

uiextensions.IMainFrame.getCustomTopBar ( )

获取当前自定义顶部导航栏

Returns
返回FSNavigationBar实例

◆ getFullScreenBottomBarImpl()

uiextensions.IMainFrame.getFullScreenBottomBarImpl ( )

获取全屏模式底部栏实现类

Returns
返回FullScreenBottomBarImpl实例或undefined

◆ getTabTools()

uiextensions.IMainFrame.getTabTools ( )

获取顶部栏中间标签页的功能项列表

Returns
返回MainCenterItemBean数组

◆ getTopBarImpl()

uiextensions.IMainFrame.getTopBarImpl ( )

获取顶部工具栏实现类

Returns
返回TopBarImpl实例或 undefined

◆ hasTab()

uiextensions.IMainFrame.hasTab ( tabType  )

检查是否存在指定类型的标签页

Parameters
tabType目标标签类型标识符 TOP_TOOL_BAR_TAB
Returns
返回true表示存在该标签页

◆ hideToolbars()

uiextensions.IMainFrame.hideToolbars ( )

隐藏所有工具栏

◆ isFullScreen()

uiextensions.IMainFrame.isFullScreen ( )

获取当前全屏状态

Returns
返回true表示处于全屏模式

◆ isSupportFullScreen()

uiextensions.IMainFrame.isSupportFullScreen ( )

检查是否支持全屏功能

Returns
返回true表示支持全屏

◆ isToolbarEnabled()

uiextensions.IMainFrame.isToolbarEnabled ( position 'top'| 'bottom'  )

检查工具栏启用状态

Parameters
position目标位置('top'或'bottom')
Returns
返回true表示已启用

◆ isToolbarsVisible()

uiextensions.IMainFrame.isToolbarsVisible ( )

检查工具栏可见状态

Returns
返回true表示工具栏可见

◆ registerFullscreenStateChangedListener()

uiextensions.IMainFrame.registerFullscreenStateChangedListener ( listener  )

注册全屏状态变化监听器

Parameters
listener实现IFullscreenStateListener接口的监听对象

◆ removeTab()

uiextensions.IMainFrame.removeTab ( tabType  )

移除标签页

Parameters
tabType要移除的标签类型标识符 TOP_TOOL_BAR_TAB

◆ setCurrentTab()

uiextensions.IMainFrame.setCurrentTab ( tabType  )

设置当前选中的标签页

Parameters
tabType要选中的标签类型标识符 TOP_TOOL_BAR_TAB

◆ setCustomBottomBar()

uiextensions.IMainFrame.setCustomBottomBar ( bar  )

设置自定义底部栏

Parameters
bar需要设置的底部栏实例 FSBottomBar

◆ setCustomTopBar()

uiextensions.IMainFrame.setCustomTopBar ( bar  )

设置自定义顶部导航栏

Parameters
bar需要设置的导航栏实例 FSNavigationBar

◆ setFullScreen()

uiextensions.IMainFrame.setFullScreen ( fullScreen  )

设置全屏显示模式

Parameters
fullScreentrue进入全屏,false退出全屏

◆ setToolbarEnabled()

uiextensions.IMainFrame.setToolbarEnabled ( position 'top'| 'bottom'  ,
enabled   
)

设置工具栏启用状态

Parameters
position目标位置('top'或'bottom')
enabledtrue启用,false禁用

◆ showToolbars()

uiextensions.IMainFrame.showToolbars ( )

显示所有工具栏

◆ unregisterFullscreenStateChangedListener()

uiextensions.IMainFrame.unregisterFullscreenStateChangedListener ( listener  )

注销全屏状态变化监听器

Parameters
listener要移除的监听器对象 IFullscreenStateListener