Foxit PDF SDK  9.1
Classes | Public Member Functions | List of all members
com.foxit.uiextensions.modules.panel.IPanelManager Interface Reference

Classes

interface  OnPanelEventListener
 

Public Member Functions

PanelHost getPanelHost ()
 
void showPanel ()
 
void showPanel (int panelType)
 
boolean isShowingPanel ()
 
void hidePanel ()
 
void addPanel (PanelSpec panelSpec)
 
void addPanel (int index, PanelSpec panelSpec)
 
void removePanel (PanelSpec panelSpec)
 
void removePanel (int panelType)
 
void registerPanelEventListener (OnPanelEventListener listener)
 
void unregisterPanelEventListener (OnPanelEventListener listener)
 

Detailed Description

The interface to handle the creation, display, hiding, layout, and interaction of panels.

Member Function Documentation

◆ addPanel() [1/2]

void com.foxit.uiextensions.modules.panel.IPanelManager.addPanel ( int  index,
PanelSpec  panelSpec 
)

Adds a child panel view. If the panel typePanelSpec#getPanelType() already exists, will not be added again. referencePanelSpec#BOOKMARKS

Parameters
indexthe position at which to add the child
panelSpecthe child panel to add

◆ addPanel() [2/2]

void com.foxit.uiextensions.modules.panel.IPanelManager.addPanel ( PanelSpec  panelSpec)

Adds a child panel view. If the panel typePanelSpec#getPanelType() already exists, will not be added again. referencePanelSpec#BOOKMARKS

Parameters
panelSpecthe child panel to add

◆ getPanelHost()

PanelHost com.foxit.uiextensions.modules.panel.IPanelManager.getPanelHost ( )

Get the panel host

Returns
The panel host

◆ hidePanel()

void com.foxit.uiextensions.modules.panel.IPanelManager.hidePanel ( )

Dismiss the panel and its window.

◆ isShowingPanel()

boolean com.foxit.uiextensions.modules.panel.IPanelManager.isShowingPanel ( )
Returns
Whether the panel is currently showing.

◆ registerPanelEventListener()

void com.foxit.uiextensions.modules.panel.IPanelManager.registerPanelEventListener ( OnPanelEventListener  listener)

Adds the specified listener to the list of listeners that will be notified of panel events.

Parameters
listenerListener to notify when panel events occur.

◆ removePanel() [1/2]

void com.foxit.uiextensions.modules.panel.IPanelManager.removePanel ( int  panelType)

Remove the child panel view at the specified position in the group.

Parameters
panelTypethe position in the group of the panel to remove

◆ removePanel() [2/2]

void com.foxit.uiextensions.modules.panel.IPanelManager.removePanel ( PanelSpec  panelSpec)

Remove the child panel view.

Parameters
panelSpecthe child panel view.

◆ showPanel() [1/2]

void com.foxit.uiextensions.modules.panel.IPanelManager.showPanel ( )

Display the default or the current panel window.

◆ showPanel() [2/2]

void com.foxit.uiextensions.modules.panel.IPanelManager.showPanel ( int  panelType)

Display the panel window by the specified panel type.

Parameters
panelTypeThe panel type, start with PanelSpec#BOOKMARKS,

◆ unregisterPanelEventListener()

void com.foxit.uiextensions.modules.panel.IPanelManager.unregisterPanelEventListener ( OnPanelEventListener  listener)

Removes the specified listener from the list of listeners that will be notified of panel events.

Parameters
listenerListener to remove from being notified of panel events