Foxit PDF SDK  9.1
FSMainTopbar Class Reference
Inheritance diagram for FSMainTopbar:
FSMainToolbar

Instance Methods

(void) - registerEventListener:
 Register an event listener. More...
 
(void) - resetCurrentTagItem
 Reset the tag Item in order to update on the view.Calling this method causes the current toolbar to be updated immediately. More...
 
(void) - setStateBarColor:
 Set the color of the state bar. More...
 
(void) - setTagItemBackgroudColor:
 Set the background color of the tagItem. More...
 
(void) - unregisterEventListener:
 Unregister an event listener. More...
 
- Instance Methods inherited from FSMainToolbar
(void) - addItem:atPosition:
 Add item at position, Please refer to {@linkFSMainToolbarItemPositionXXX} and FSMainToolbarItemPosition values and it would be one of these values.. More...
 
(__kindof UIStackView *) - getToolbarContentView
 Get the the toolbar content view. More...
 
(instancetype) - NS_UNAVAILABLE
 
(void) - removeItem:atPosition:
 Removes item at position, Please refer to {@linkFSMainToolbarItemPositionXXX} and FSMainToolbarItemPosition values and it would be one of these values.. More...
 
(void) - removeItemAtPosition:index:
 Removes the index item at position, Please refer to {@linkFSMainToolbarItemPositionXXX} and FSMainToolbarItemPosition values and it would be one of these values.. More...
 
(void) - setBackgroundColor:
 Set the background color. More...
 

Properties

__kindof UIView * attachView
 Get/Set the subview to contview. More...
 
NSArray< FSMainTopbarToolTagItem * > * currentNewTagItems
 Get/Set the main tag Items to display a new icon in the popup window. More...
 
FSMainTopbarToolTagItemcurrentTagItem
 Get the current tag Item. More...
 
CGFloat horizontalContentHeight
 Set horizontal content height. More...
 
NSArray< FSMainToolbarItem * > *itemsForPositionCenter NS_UNAVAILABLE
 Disable this method. More...
 
FSTopbarSubitemContentViewPosition subitemContentPosition
 Get the subtoolbar position. Please refer to FSTopbarSubitemContentViewPositionXXX values and it would be one of these values.. More...
 
NSArray< FSMainTopbarToolTagItem * > * tagItems
 Get/Set the main tag Items displayed on the toolbar. More...
 
CGFloat verticalContentWidth
 Set vertical content width. More...
 
- Properties inherited from FSMainToolbar
CGFloat contentHeight
 Set content bar height. More...
 
NSArray< FSMainToolbarItem * > * itemsForPositionCenter
 Get/Set the items displayed on the toolbar center. More...
 
NSArray< FSMainToolbarItem * > * itemsForPositionLeft
 Get/Set the items displayed on the toolbar left. More...
 
NSArray< FSMainToolbarItem * > * itemsForPositionRight
 Get/Set the items displayed on the toolbar right. More...
 

Additional Inherited Members

- Class Methods inherited from FSMainToolbar
(instancetype) + NS_UNAVAILABLE
 Disable the default initialization. More...
 

Method Documentation

◆ registerEventListener:

- (void) registerEventListener: (id< IFSMainTopbarEventListener >)  listener

Register an event listener.

Parameters
[in]listenerThe Topbar Listener.

◆ resetCurrentTagItem

- (void) resetCurrentTagItem

Reset the tag Item in order to update on the view.Calling this method causes the current toolbar to be updated immediately.

◆ setStateBarColor:

- (void) setStateBarColor: (nullable UIColor *)  color

Set the color of the state bar.

Parameters
[in]colorThe background color used to specify the status.

◆ setTagItemBackgroudColor:

- (void) setTagItemBackgroudColor: (nullable UIColor *)  color

Set the background color of the tagItem.

Parameters
[in]colorThe background color used to specify the status.

◆ unregisterEventListener:

- (void) unregisterEventListener: (id< IFSMainTopbarEventListener >)  listener

Unregister an event listener.

Parameters
[in]listenerThe Topbar Listener.

Property Documentation

◆ attachView

- (__kindof UIView*) attachView
readwritenonatomicstrong

Get/Set the subview to contview.

◆ currentNewTagItems

- (NSArray<FSMainTopbarToolTagItem *>*) currentNewTagItems
readwritenonatomiccopy

Get/Set the main tag Items to display a new icon in the popup window.

◆ currentTagItem

- (FSMainTopbarToolTagItem*) currentTagItem
readnonatomicstrong

Get the current tag Item.

◆ horizontalContentHeight

- (CGFloat) horizontalContentHeight
readwritenonatomicassign

Set horizontal content height.

◆ NS_UNAVAILABLE

- (NSArray<FSMainToolbarItem *>* itemsForPositionCenter) NS_UNAVAILABLE
readwritenonatomiccopy

Disable this method.

◆ subitemContentPosition

- (FSTopbarSubitemContentViewPosition) subitemContentPosition
readwritenonatomicassign

Get the subtoolbar position. Please refer to FSTopbarSubitemContentViewPositionXXX values and it would be one of these values..

◆ tagItems

- (NSArray<FSMainTopbarToolTagItem *>*) tagItems
readwritenonatomiccopy

Get/Set the main tag Items displayed on the toolbar.

◆ verticalContentWidth

- (CGFloat) verticalContentWidth
readwritenonatomicassign

Set vertical content width.