Foxit PDF SDK  9.1
com.foxit.uiextensions.pdfreader.IMainFrame Interface Reference

Public Member Functions

Activity getAttachedActivity ()
 
void setAttachedActivity (Activity act)
 
Context getContext ()
 
RelativeLayout getContentView ()
 
void showToolbars ()
 
void hideToolbars ()
 
boolean isToolbarsVisible ()
 
BaseBar getTopToolbar ()
 
BaseBar getBottomToolbar ()
 
void enableTopToolbar (boolean isEnabled)
 
void enableBottomToolbar (boolean isEnabled)
 
boolean isShowTopToolbar ()
 
boolean isShowBottomToolbar ()
 
BaseBar getCustomTopbar ()
 
BaseBar getCustomBottombar ()
 
IPanelManager getPanelManager ()
 
IViewSettingsWindow getSettingWindow ()
 
void hideSettingWindow ()
 
ViewGroup getTopActionView ()
 
void setToolBarPosition (@UIDragToolBar.ToolbarPos int position)
 
.ToolbarPos int getToolBarPosition ()
 
int getCurrentTab ()
 
void setCurrentTab (int tabType)
 
void removeTab (int tabType)
 
void enableSmallTopToolbar (boolean isEnabled)
 
void enableSmallBottomToolbar (boolean isEnabled)
 
boolean isSmallTopToolbarEnabled ()
 
boolean isSmallBottomToolbarEnabled ()
 

Detailed Description

Interface definition for main frame of the complete pdf reader. It provides an entrance to access the UI of reader. For example, getTopToolbar/getBottomToolbar will provide caller the interface for top bar and bottom bar of pdf view control. The SDK user is able to modify or customize the reader UI through these interfaces.

Member Function Documentation

◆ enableBottomToolbar()

void com.foxit.uiextensions.pdfreader.IMainFrame.enableBottomToolbar ( boolean  isEnabled)
Parameters
isEnabledIf set false, the bottom toolbar will be hidden, true otherwise.

◆ enableSmallBottomToolbar()

void com.foxit.uiextensions.pdfreader.IMainFrame.enableSmallBottomToolbar ( boolean  isEnabled)

Enable or disable small bottom toolbar.

Parameters
isEnabledWhether small bottom toolbar is enabled or not.

◆ enableSmallTopToolbar()

void com.foxit.uiextensions.pdfreader.IMainFrame.enableSmallTopToolbar ( boolean  isEnabled)

Enable or disable small top toolbar.

Parameters
isEnabledWhether small top toolbar is enabled or not.

◆ enableTopToolbar()

void com.foxit.uiextensions.pdfreader.IMainFrame.enableTopToolbar ( boolean  isEnabled)
Parameters
isEnabledIf set false, the top toolbar will be hidden, true otherwise.

◆ getAttachedActivity()

Activity com.foxit.uiextensions.pdfreader.IMainFrame.getAttachedActivity ( )
Returns
Return the Activity this frame is currently associated with.

◆ getBottomToolbar()

BaseBar com.foxit.uiextensions.pdfreader.IMainFrame.getBottomToolbar ( )
Returns
The bottom toolbar

◆ getContentView()

RelativeLayout com.foxit.uiextensions.pdfreader.IMainFrame.getContentView ( )
Returns
Get the root view for the frame layout

◆ getContext()

Context com.foxit.uiextensions.pdfreader.IMainFrame.getContext ( )
Returns
Context this frame is currently associated with.

◆ getCurrentTab()

int com.foxit.uiextensions.pdfreader.IMainFrame.getCurrentTab ( )

◆ getCustomBottombar()

BaseBar com.foxit.uiextensions.pdfreader.IMainFrame.getCustomBottombar ( )
Returns
The custom bottom bar

◆ getCustomTopbar()

BaseBar com.foxit.uiextensions.pdfreader.IMainFrame.getCustomTopbar ( )
Returns
The custom top bar

◆ getPanelManager()

IPanelManager com.foxit.uiextensions.pdfreader.IMainFrame.getPanelManager ( )
Returns
The manager of the panelIPanelManager

◆ getSettingWindow()

IViewSettingsWindow com.foxit.uiextensions.pdfreader.IMainFrame.getSettingWindow ( )
Returns
The settings window.

◆ getToolBarPosition()

.ToolbarPos int com.foxit.uiextensions.pdfreader.IMainFrame.getToolBarPosition ( )

Get the position of the toolbar.

Returns
The position of the toolbar.

◆ getTopActionView()

ViewGroup com.foxit.uiextensions.pdfreader.IMainFrame.getTopActionView ( )
Returns
Get the action view, it is below the top bar and its sub-toolbar, and can be used to insert a custom views,

◆ getTopToolbar()

BaseBar com.foxit.uiextensions.pdfreader.IMainFrame.getTopToolbar ( )
Returns
The top toolbar

◆ hideSettingWindow()

void com.foxit.uiextensions.pdfreader.IMainFrame.hideSettingWindow ( )

Hide the settings window.

◆ hideToolbars()

void com.foxit.uiextensions.pdfreader.IMainFrame.hideToolbars ( )

Hide the tool bars, enter the full screen mode

◆ isShowBottomToolbar()

boolean com.foxit.uiextensions.pdfreader.IMainFrame.isShowBottomToolbar ( )
Returns
True indicates that the bottom toolbar is the display state. false otherwise.

◆ isShowTopToolbar()

boolean com.foxit.uiextensions.pdfreader.IMainFrame.isShowTopToolbar ( )
Returns
True indicates that the top toolbar is the display state. false otherwise.

◆ isSmallBottomToolbarEnabled()

boolean com.foxit.uiextensions.pdfreader.IMainFrame.isSmallBottomToolbarEnabled ( )

Returns the enabled status for the small bottom toolbar

Returns
True if this view is enabled, false otherwise.

◆ isSmallTopToolbarEnabled()

boolean com.foxit.uiextensions.pdfreader.IMainFrame.isSmallTopToolbarEnabled ( )

Returns the enabled status for the small top toolbar

Returns
True if this view is enabled, false otherwise.

◆ isToolbarsVisible()

boolean com.foxit.uiextensions.pdfreader.IMainFrame.isToolbarsVisible ( )
Returns
If it's full screen mode, reture true, false otherwise.

◆ removeTab()

void com.foxit.uiextensions.pdfreader.IMainFrame.removeTab ( int  tabType)

Remove the tab in the center of the topbar and its sub-toolbar

Note:Removing the tab of the topbar will not affect the full screen toolbar

Parameters
tabTypePlease refer to values starting from ToolbarItemConfig#ITEM_HOME_TAB

◆ setAttachedActivity()

void com.foxit.uiextensions.pdfreader.IMainFrame.setAttachedActivity ( Activity  act)

Set the Activity associated with this frame.

Parameters
actActivity

◆ setCurrentTab()

void com.foxit.uiextensions.pdfreader.IMainFrame.setCurrentTab ( int  tabType)

◆ setToolBarPosition()

void com.foxit.uiextensions.pdfreader.IMainFrame.setToolBarPosition ( @UIDragToolBar.ToolbarPos int  position)

Set the toolbar position, Currently supported locations can refer to UIDragToolBar.ToolbarPos.

Parameters
positionThe position of toolbar. UIDragToolBar.ToolbarPos

◆ showToolbars()

void com.foxit.uiextensions.pdfreader.IMainFrame.showToolbars ( )

Show th tool bars, exit full screen mode