com.skydoves.powermenu

Class CustomPowerMenu.Builder<T,E extends MenuBaseAdapter<T>>

java.lang.Object

com.skydoves.powermenu.AbstractMenuBuilder

com.skydoves.powermenu.CustomPowerMenu.Builder<T,E>

Enclosing class:

CustomPowerMenu<T,E extends MenuBaseAdapter<T>>

public static class CustomPowerMenu.Builder<T,E extends MenuBaseAdapter<T>>
extends AbstractMenuBuilder

Builder class for creating CustomPowerMenu.

Field Summary

Fields inherited from class com.skydoves.powermenu.AbstractMenuBuilder

animationStyle, autoDismiss, backgroundAlpha, backgroundClickListener, backgroundColor, circularEffect, context, defaultPosition, divider, dividerHeight, focusable, footerView, headerView, height, initializeRule, isClipping, layoutInflater, lifecycleOwner, menuAnimation, menuRadius, menuShadow, onDismissedListener, preferenceName, selected, showBackground, width

Constructor Summary

Constructors

Constructor and Description
Builder(android.content.Context context, E adapter)

Method Summary

Modifier and Type	Method and Description
CustomPowerMenu.Builder	addItem(int position, java.lang.Object item) adds an PowerMenuItem item to the popup menu list at position.
CustomPowerMenu.Builder	addItem(java.lang.Object item) adds an PowerMenuItem item to the popup menu list.
CustomPowerMenu.Builder	addItemList(java.util.List<T> itemList) adds a list of the PowerMenuItem item to the popup menu list.
CustomPowerMenu	build()
CustomPowerMenu.Builder	setAnimation(MenuAnimation menuAnimation) sets the menu animation to the popup.
CustomPowerMenu.Builder	setAnimationStyle(int style) sets the customized menu animation using resource.
CustomPowerMenu.Builder	setAutoDismiss(boolean autoDismiss) sets the dismissing automatically when the menu item is clicked.
CustomPowerMenu.Builder	setBackgroundAlpha(float alpha) sets the alpha of the background popup.
CustomPowerMenu.Builder	setBackgroundColor(int color) sets the color of the background popup.
CustomPowerMenu.Builder	setBackgroundColorResource(int color) sets the color of the background popup.
CustomPowerMenu.Builder	setCircularEffect(CircularEffect circularEffect) sets the circular revealed effect using CircularEffect.
CustomPowerMenu.Builder	setDivider(android.graphics.drawable.Drawable divider) sets the divider Drawable between the menu items.
CustomPowerMenu.Builder	setDividerHeight(int height) sets the divider height between the menu items.
CustomPowerMenu.Builder	setFocusable(boolean focusable) sets the focusability of the popup menu.
CustomPowerMenu.Builder	setFooterView(int footerView) sets the footer view by layout resource.
CustomPowerMenu.Builder	setFooterView(android.view.View footerView) sets the footer view by layout view.
CustomPowerMenu.Builder	setHeaderView(int headerView) sets the header view by layout resource.
CustomPowerMenu.Builder	setHeaderView(android.view.View headerView) sets the header view by layout view.
CustomPowerMenu.Builder	setHeight(int height) sets the height size of the popup menu.
CustomPowerMenu.Builder	setInitializeRule(androidx.lifecycle.Lifecycle.Event event, int defaultPosition) sets the initialization rule of the recovering persisted position.
CustomPowerMenu.Builder	setIsClipping(boolean isClipping) sets the clipping or not of the popup menu.
CustomPowerMenu.Builder	setLifecycleOwner(androidx.lifecycle.LifecycleOwner lifecycleOwner) sets the LifecycleOwner for dismissing automatically when the LifecycleOwner is destroyed.
CustomPowerMenu.Builder	setMenuRadius(float radius) sets the corner radius of the popup menu.
CustomPowerMenu.Builder	setMenuShadow(float shadow) sets the shadow of the popup menu.
CustomPowerMenu.Builder	setOnBackgroundClickListener(android.view.View.OnClickListener onBackgroundClickListener) sets the View.OnClickListener to the popup.
CustomPowerMenu.Builder	setOnDismissListener(OnDismissedListener onDismissListener) sets the OnDismissedListener to the popup.
CustomPowerMenu.Builder	setOnMenuItemClickListener(java.lang.Object menuItemClickListener) sets the OnMenuItemClickListener to the popup.
CustomPowerMenu.Builder	setPreferenceName(java.lang.String preferenceName) sets the preference name of the popup menu.
CustomPowerMenu.Builder	setSelected(int position) sets the initialized selected effect menu item position.
CustomPowerMenu.Builder	setShowBackground(boolean show) sets the visibility of the background popup.
CustomPowerMenu.Builder	setSize(int width, int height) sets the width and height size of the popup menu.
CustomPowerMenu.Builder	setWidth(int width) sets the width size of the popup menu.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(@NonNull
               android.content.Context context,
               @NonNull
               E adapter)

Method Detail

setLifecycleOwner

public CustomPowerMenu.Builder setLifecycleOwner(@NonNull
                                                 androidx.lifecycle.LifecycleOwner lifecycleOwner)

sets the LifecycleOwner for dismissing automatically when the LifecycleOwner is destroyed. It will prevents memory leak.

Parameters:

lifecycleOwner - lifecycle owner

Returns:

CustomPowerMenu.Builder.

See Also:

GitHub : PowerMenu-Avoid-Memory-Leak

setShowBackground

public CustomPowerMenu.Builder setShowBackground(boolean show)

sets the visibility of the background popup.

Parameters:

show - visibility of the background popup.

Returns:

CustomPowerMenu.Builder.

setOnMenuItemClickListener

public CustomPowerMenu.Builder setOnMenuItemClickListener(java.lang.Object menuItemClickListener)

sets the OnMenuItemClickListener to the popup.

Parameters:

menuItemClickListener - OnMenuItemClickListener interface.

Returns:

CustomPowerMenu.Builder.

setOnBackgroundClickListener

public CustomPowerMenu.Builder setOnBackgroundClickListener(android.view.View.OnClickListener onBackgroundClickListener)

sets the View.OnClickListener to the popup.

Parameters:

onBackgroundClickListener - View.OnClickListener interface.

Returns:

CustomPowerMenu.Builder.

setOnDismissListener

public CustomPowerMenu.Builder setOnDismissListener(OnDismissedListener onDismissListener)

sets the OnDismissedListener to the popup.

Parameters:

onDismissListener - OnDismissedListener interface.

Returns:

CustomPowerMenu.Builder.

setHeaderView

public CustomPowerMenu.Builder setHeaderView(@LayoutRes
                                             int headerView)

sets the header view by layout resource.

Parameters:

headerView - layout resource

Returns:

CustomPowerMenu.Builder.

setHeaderView

public CustomPowerMenu.Builder setHeaderView(android.view.View headerView)

sets the header view by layout view.

Parameters:

headerView - header view.

Returns:

CustomPowerMenu.Builder.

setFooterView

public CustomPowerMenu.Builder setFooterView(@LayoutRes
                                             int footerView)

sets the footer view by layout resource.

Parameters:

footerView - footer view.

Returns:

CustomPowerMenu.Builder.

setFooterView

public CustomPowerMenu.Builder setFooterView(android.view.View footerView)

sets the footer view by layout view.

Parameters:

footerView - footer view.

Returns:

CustomPowerMenu.Builder.

setAnimation

public CustomPowerMenu.Builder setAnimation(@NonNull
                                            MenuAnimation menuAnimation)

sets the menu animation to the popup.

Parameters:

menuAnimation - animation.

Returns:

CustomPowerMenu.Builder.

setAnimationStyle

public CustomPowerMenu.Builder setAnimationStyle(int style)

sets the customized menu animation using resource.

Parameters:

style - animation resource.

Returns:

CustomPowerMenu.Builder.

setMenuRadius

public CustomPowerMenu.Builder setMenuRadius(float radius)

sets the corner radius of the popup menu.

Parameters:

radius - corner radius.

Returns:

CustomPowerMenu.Builder.

setMenuShadow

public CustomPowerMenu.Builder setMenuShadow(float shadow)

sets the shadow of the popup menu.

Parameters:

shadow - popup shadow.

Returns:

CustomPowerMenu.Builder.

setWidth

public CustomPowerMenu.Builder setWidth(int width)

sets the width size of the popup menu.

Parameters:

width - width size.

Returns:

CustomPowerMenu.Builder.

setHeight

public CustomPowerMenu.Builder setHeight(int height)

sets the height size of the popup menu.

Parameters:

height - height size.

Returns:

CustomPowerMenu.Builder.

setSize

public CustomPowerMenu.Builder setSize(int width,
                                       int height)

sets the width and height size of the popup menu.

Parameters:

width - width size.

height - height size.

Returns:

CustomPowerMenu.Builder.

setDividerHeight

public CustomPowerMenu.Builder setDividerHeight(int height)

sets the divider height between the menu items.

Parameters:

height - divider height between the menu items.

Returns:

CustomPowerMenu.Builder.

setDivider

public CustomPowerMenu.Builder setDivider(android.graphics.drawable.Drawable divider)

sets the divider Drawable between the menu items.

Parameters:

divider - divider Drawable between the menu items.

Returns:

CustomPowerMenu.Builder.

setBackgroundColor

public CustomPowerMenu.Builder setBackgroundColor(int color)

sets the color of the background popup.

Parameters:

color - color of the background popup.

Returns:

CustomPowerMenu.Builder.

setBackgroundColorResource

public CustomPowerMenu.Builder setBackgroundColorResource(int color)

sets the color of the background popup.

Parameters:

color - color of the background popup by resource.

Returns:

CustomPowerMenu.Builder.

setBackgroundAlpha

public CustomPowerMenu.Builder setBackgroundAlpha(float alpha)

sets the alpha of the background popup.

Parameters:

alpha - alpha of the background popup.

Returns:

CustomPowerMenu.Builder.

setFocusable

public CustomPowerMenu.Builder setFocusable(boolean focusable)

sets the focusability of the popup menu.

Parameters:

focusable - focusability of the popup menu.

Returns:

CustomPowerMenu.Builder.

setSelected

public CustomPowerMenu.Builder setSelected(int position)

sets the initialized selected effect menu item position.

Parameters:

position - initialized selected effect menu item position.

Returns:

CustomPowerMenu.Builder.

setIsClipping

public CustomPowerMenu.Builder setIsClipping(boolean isClipping)

sets the clipping or not of the popup menu.

Parameters:

isClipping - clipping or not of the popup menu.

Returns:

CustomPowerMenu.Builder.

setAutoDismiss

public CustomPowerMenu.Builder setAutoDismiss(boolean autoDismiss)

sets the dismissing automatically when the menu item is clicked.

Parameters:

autoDismiss - dismissing automatically when the menu item is clicked.

Returns:

CustomPowerMenu.Builder.

addItem

public CustomPowerMenu.Builder addItem(java.lang.Object item)

adds an PowerMenuItem item to the popup menu list.

Parameters:

item - PowerMenuItem item.

Returns:

CustomPowerMenu.Builder.

addItem

public CustomPowerMenu.Builder addItem(int position,
                                       java.lang.Object item)

adds an PowerMenuItem item to the popup menu list at position.

Parameters:

position - specific position.

item - PowerMenuItem item.

Returns:

CustomPowerMenu.Builder.

addItemList

public CustomPowerMenu.Builder addItemList(java.util.List<T> itemList)

adds a list of the PowerMenuItem item to the popup menu list.

Parameters:

itemList - list of the PowerMenuItem.

Returns:

CustomPowerMenu.Builder.

setPreferenceName

public CustomPowerMenu.Builder setPreferenceName(@NonNull
                                                 java.lang.String preferenceName)

sets the preference name of the popup menu. For persistence the clicked item position. If the preference name is set, the persisted position item will be clicked automatically when the popup menu initialized. This option should be used with setInitializeRule and setLifecycleOwner.

Parameters:

preferenceName - name of the popup menu.

Returns:

CustomPowerMenu.Builder.

See Also:

setInitializeRule

public CustomPowerMenu.Builder setInitializeRule(@NonNull
                                                 androidx.lifecycle.Lifecycle.Event event,
                                                 int defaultPosition)

sets the initialization rule of the recovering persisted position.

Parameters:

event - when should be recovered.

defaultPosition - default selected position.

Returns:

CustomPowerMenu.Builder.

setCircularEffect

public CustomPowerMenu.Builder setCircularEffect(@NonNull
                                                 CircularEffect circularEffect)

sets the circular revealed effect using CircularEffect.

Parameters:

circularEffect - circular revealed effect using CircularEffect.

Returns:

@return CustomPowerMenu.Builder.

build

public CustomPowerMenu build()