Foxit PDF SDK  9.1
com.foxit.uiextensions.controls.menu.IMenuGroup Interface Reference

Public Member Functions

View getContentView ()
 
int getGroupId ()
 
void setVisible (boolean visible)
 
boolean isVisible ()
 
void setHeaderTitle (String text)
 
void setHeaderTitleColor (@ColorInt int color)
 
void setHeaderBackgroundColor (@ColorInt int color)
 
void setHeaderTitleVisible (boolean visible)
 
void setHeaderTitleHeight (@ColorInt int height)
 
void setDividerVisible (boolean visible)
 
void setCheckMode (@CheckMode int mode)
 
int getCheckMode ()
 
IMenuItem addItem (IMenuItem item)
 
IMenuItem addItem (CharSequence title)
 
IMenuItem addItem (Drawable icon, CharSequence title)
 
IMenuItem addItem (int itemId, Drawable icon, CharSequence title)
 
IMenuItem addItem (int itemId, CharSequence title)
 
IMenuItem addItemAt (int index, CharSequence title)
 
IMenuItem addItemAt (int index, @DrawableRes int iconRes, CharSequence title)
 
IMenuItem addItemAt (int index, int itemId, @DrawableRes int iconRes, CharSequence title)
 
IMenuItem addItem (View customView)
 
IMenuItem addItem (int itemId, View customView)
 
IMenuItem addItemAt (int index, View customView)
 
IMenuItem addItemAt (int index, int itemId, View customView)
 
void removeItem (IMenuItem item)
 
void removeItem (int itemId)
 
void removeItemAt (int index)
 
IMenuItem getItem (int itemId)
 
IMenuItem getItemAt (int index)
 
List< IMenuItemgetItems ()
 
IMenuGroup setParentItem (IMenuItem parent)
 
IMenuItem getParentItem ()
 

Detailed Description

An Item is returned by calling one of the IMenuView#addGroup methods.

For a feature set of specific menu types, see IMenuView.

Member Function Documentation

◆ addItem() [1/7]

IMenuItem com.foxit.uiextensions.controls.menu.IMenuGroup.addItem ( CharSequence  title)

Add a new item to the group. This item displays the given title for its label.

Parameters
titleThe new text to be displayed.
Returns
The newly added menu item.

◆ addItem() [2/7]

IMenuItem com.foxit.uiextensions.controls.menu.IMenuGroup.addItem ( Drawable  icon,
CharSequence  title 
)

Add a new item to the group. This item displays the given icon and title for its label.

Parameters
iconThe new icon to be diaplayed.
titleThe new text to be displayed.
Returns
The newly added menu item.

◆ addItem() [3/7]

IMenuItem com.foxit.uiextensions.controls.menu.IMenuGroup.addItem ( IMenuItem  item)

add menu item with IMenuItem

Parameters
itemitem to add
Returns
the added item

◆ addItem() [4/7]

IMenuItem com.foxit.uiextensions.controls.menu.IMenuGroup.addItem ( int  itemId,
CharSequence  title 
)

Add a new item to the group. This item displays the given title for its label.

Parameters
itemIdUnique item ID. Please refer to existing items MoreMenuConstants#ITEM_PRIMARY_PROTECT
titleThe new text to be displayed.
Returns
The newly added menu item.

◆ addItem() [5/7]

IMenuItem com.foxit.uiextensions.controls.menu.IMenuGroup.addItem ( int  itemId,
Drawable  icon,
CharSequence  title 
)

Add a new item to the group. This item displays the given icon and title for its label.

Parameters
itemIdUnique item ID. Please refer to existing items MoreMenuConstants#ITEM_PRIMARY_PROTECT
iconThe new icon to be diaplayed.
titleThe new text to be displayed.
Returns
The newly added menu item.

◆ addItem() [6/7]

IMenuItem com.foxit.uiextensions.controls.menu.IMenuGroup.addItem ( int  itemId,
View  customView 
)

Add a custom item to the group.

Parameters
itemIdUnique item ID. Please refer to existing items MoreMenuConstants#ITEM_PRIMARY_PROTECT
customViewThe custom view
Returns
The newly added menu item.

◆ addItem() [7/7]

IMenuItem com.foxit.uiextensions.controls.menu.IMenuGroup.addItem ( View  customView)

Add a custom item to the group.

Parameters
customViewThe custom view
Returns
The newly added menu item.

◆ addItemAt() [1/5]

IMenuItem com.foxit.uiextensions.controls.menu.IMenuGroup.addItemAt ( int  index,
@DrawableRes int  iconRes,
CharSequence  title 
)

Add a new item to the group. This item displays the given icon and title for its label.

Parameters
indexThe position at which to add menu item
iconResThe new icon to be diaplayed.
titleThe new text to be displayed.
Returns
The newly added menu item.

◆ addItemAt() [2/5]

IMenuItem com.foxit.uiextensions.controls.menu.IMenuGroup.addItemAt ( int  index,
CharSequence  title 
)

Add a new item to the group. This item displays the given title for its label.

Parameters
indexThe position at which to add menu item
titleThe new text to be displayed.
Returns
The newly added menu item.

◆ addItemAt() [3/5]

IMenuItem com.foxit.uiextensions.controls.menu.IMenuGroup.addItemAt ( int  index,
int  itemId,
@DrawableRes int  iconRes,
CharSequence  title 
)

Add a new item to the group. This item displays the given icon and title for its label.

Parameters
indexThe position at which to add menu item
itemIdUnique item ID. Please refer to existing items MoreMenuConstants#ITEM_PRIMARY_PROTECT
iconResThe new icon to be diaplayed.
titleThe new text to be displayed.
Returns
The newly added menu item.

◆ addItemAt() [4/5]

IMenuItem com.foxit.uiextensions.controls.menu.IMenuGroup.addItemAt ( int  index,
int  itemId,
View  customView 
)

Add a custom item to the group.

Parameters
indexThe position at which to add menu item
itemIdUnique item ID. Please refer to existing items MoreMenuConstants#ITEM_PRIMARY_PROTECT
customViewThe custom view
Returns
The newly added menu item.

◆ addItemAt() [5/5]

IMenuItem com.foxit.uiextensions.controls.menu.IMenuGroup.addItemAt ( int  index,
View  customView 
)

Add a custom item to the group.

Parameters
indexThe position at which to add menu item
customViewThe custom view
Returns
The newly added menu item.

◆ getCheckMode()

int com.foxit.uiextensions.controls.menu.IMenuGroup.getCheckMode ( )
Returns
the default style of the group item.

◆ getContentView()

View com.foxit.uiextensions.controls.menu.IMenuGroup.getContentView ( )

Returns the root view of the current menu group.

Returns
the root view of the current menu group.

◆ getGroupId()

int com.foxit.uiextensions.controls.menu.IMenuGroup.getGroupId ( )

Returns the current menu group id

Returns
the current menu group idMoreMenuConstants#GROUP_ACTION_MENU_PRIMARY

◆ getItem()

IMenuItem com.foxit.uiextensions.controls.menu.IMenuGroup.getItem ( int  itemId)

Gets the menu item by the given id.

Parameters
itemIdUnique item ID. Please refer to existing items MoreMenuConstants#ITEM_PRIMARY_PROTECT
Returns
The menu item.

◆ getItemAt()

IMenuItem com.foxit.uiextensions.controls.menu.IMenuGroup.getItemAt ( int  index)

Gets the group item at the given index.

Parameters
indexThe index of the menu item to return.
Returns
The menu item.

◆ getItems()

List<IMenuItem> com.foxit.uiextensions.controls.menu.IMenuGroup.getItems ( )
Returns
the all menu items under the current menu group

◆ getParentItem()

IMenuItem com.foxit.uiextensions.controls.menu.IMenuGroup.getParentItem ( )

Get parent menu item of current menu group

Returns
Current group's parent menu item

◆ isVisible()

boolean com.foxit.uiextensions.controls.menu.IMenuGroup.isVisible ( )
Returns
the visible status for this group item.

◆ removeItem() [1/2]

void com.foxit.uiextensions.controls.menu.IMenuGroup.removeItem ( IMenuItem  item)

Remove the specified menu item.

Parameters
itemThe specified menu item to be removed.

◆ removeItem() [2/2]

void com.foxit.uiextensions.controls.menu.IMenuGroup.removeItem ( int  itemId)

Remove the specified menu according to item id.

Parameters
itemIdUnique item ID. Please refer to existing items MoreMenuConstants#ITEM_PRIMARY_PROTECT

◆ removeItemAt()

void com.foxit.uiextensions.controls.menu.IMenuGroup.removeItemAt ( int  index)

Remove the menu according to specified position.

Parameters
indexThe position of the menu item

◆ setCheckMode()

void com.foxit.uiextensions.controls.menu.IMenuGroup.setCheckMode ( @CheckMode int  mode)

Set the default style of the group item.

Parameters
modeThe CheckMode to use

◆ setDividerVisible()

void com.foxit.uiextensions.controls.menu.IMenuGroup.setDividerVisible ( boolean  visible)

Set divider to be visible or not

Parameters
visibleReturn true to be visible

◆ setHeaderBackgroundColor()

void com.foxit.uiextensions.controls.menu.IMenuGroup.setHeaderBackgroundColor ( @ColorInt int  color)

Sets the background color for this group item.

Parameters
colorA color value in the form 0xAARRGGBB. Do not pass a resource ID. To get a color value from a resource ID, call getColor.

◆ setHeaderTitle()

void com.foxit.uiextensions.controls.menu.IMenuGroup.setHeaderTitle ( String  text)

Change the title associated with this group.

Parameters
textThe new text to be displayed.

◆ setHeaderTitleColor()

void com.foxit.uiextensions.controls.menu.IMenuGroup.setHeaderTitleColor ( @ColorInt int  color)

Change the title text color associated with this group.

Parameters
colorA color value in the form 0xAARRGGBB. Do not pass a resource ID. To get a color value from a resource ID, call getColor.

◆ setHeaderTitleHeight()

void com.foxit.uiextensions.controls.menu.IMenuGroup.setHeaderTitleHeight ( @ColorInt int  height)

Sets the height for header title.

Parameters
heightA pixel value specified for the header height.

◆ setHeaderTitleVisible()

void com.foxit.uiextensions.controls.menu.IMenuGroup.setHeaderTitleVisible ( boolean  visible)

Set header title to be visible or not

Parameters
visibleTrue if this group should visible, false otherwise.

◆ setParentItem()

IMenuGroup com.foxit.uiextensions.controls.menu.IMenuGroup.setParentItem ( IMenuItem  parent)

Set parent item for current menu group

Parameters
parentCurrent menu group's parent
Returns
Current menu group

◆ setVisible()

void com.foxit.uiextensions.controls.menu.IMenuGroup.setVisible ( boolean  visible)

Change the visibility for the menu group

Parameters
visibleTrue if this group should visible, false otherwise.