com.sergivonavi.materialbanner

Class Banner.Builder

java.lang.Object

com.sergivonavi.materialbanner.Banner.Builder

Enclosing class:

Banner

public static class Banner.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder(android.content.Context context) Creates a builder for a banner that uses the default banner style (either specified in the app theme or in this library).
Builder(android.content.Context context, int themeResId) Creates a builder for a banner that uses an explicit style resource.

Method Summary

Modifier and Type	Method and Description
Banner	create() Creates a Banner with the arguments supplied to this builder.
Banner.Builder	setIcon(android.graphics.drawable.Drawable icon) Sets the resource id of the Drawable to be used in the banner.
Banner.Builder	setIcon(int iconId) Sets the Drawable to be used in the banner.
Banner.Builder	setId(int id) Sets the identifier for this banner.
Banner.Builder	setLeftButton(int textId, BannerInterface.OnClickListener listener) Sets a listener to be invoked when the left button of the banner is pressed.
Banner.Builder	setLeftButton(java.lang.String text, BannerInterface.OnClickListener listener) Sets a listener to be invoked when the left button of the banner is pressed.
Banner.Builder	setMessage(int textId) Sets the message to display in the banner using the given resource id.
Banner.Builder	setMessage(java.lang.String text) Sets the message to display in the banner.
Banner.Builder	setOnDismissListener(BannerInterface.OnDismissListener listener) Sets a listener to be invoked when the banner is dismissed.
Banner.Builder	setOnShowListener(BannerInterface.OnShowListener listener) Sets a listener to be invoked when the banner is shown.
Banner.Builder	setParent(android.view.ViewGroup parent) Sets the ViewGroup that will be a parent view for this banner.
Banner.Builder	setParent(android.view.ViewGroup parent, int index) Sets the ViewGroup that will be a parent view for this banner and specify banner's index in the parent view.
Banner.Builder	setParent(android.view.ViewGroup parent, int index, android.view.ViewGroup.LayoutParams params) Sets the ViewGroup that will be a parent view for this banner and specify banner's index in the parent view.
Banner.Builder	setRightButton(int textId, BannerInterface.OnClickListener listener) Sets a listener to be invoked when the right button of the banner is pressed.
Banner.Builder	setRightButton(java.lang.String text, BannerInterface.OnClickListener listener) Sets a listener to be invoked when the right button of the banner is pressed.
Banner	show() Creates a Banner with the arguments supplied to this builder and immediately displays the banner.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(android.content.Context context)

Creates a builder for a banner that uses the default banner style (either specified in the app theme or in this library).

The default banner style is defined by R.attr#bannerStyle within the parent context's theme.

Parameters:

context - the parent context

Builder

public Builder(android.content.Context context,
               int themeResId)

Creates a builder for a banner that uses an explicit style resource.

Parameters:

context - the parent context

themeResId - the resource ID of the theme against which to inflate this banner

Method Detail

setParent

public Banner.Builder setParent(android.view.ViewGroup parent)

Sets the ViewGroup that will be a parent view for this banner.

Note: the banner will be added as a first child to this view. To specify an index use setParent(ViewGroup, int).

Parameters:

parent - the parent view to display the banner in

Returns:

the Banner.Builder object to chain calls

See Also:

setParent(ViewGroup, int), setParent(ViewGroup, int, ViewGroup.LayoutParams)

setParent

public Banner.Builder setParent(android.view.ViewGroup parent,
                                int index)

Sets the ViewGroup that will be a parent view for this banner and specify banner's index in the parent view.

Parameters:

parent - the parent view to display the banner in

index - the position at which to add the banner or -1 to add last

Returns:

the Banner.Builder object to chain calls

See Also:

setParent(ViewGroup), setParent(ViewGroup, int, ViewGroup.LayoutParams)

setParent

public Banner.Builder setParent(android.view.ViewGroup parent,
                                int index,
                                android.view.ViewGroup.LayoutParams params)

Sets the ViewGroup that will be a parent view for this banner and specify banner's index in the parent view.

Parameters:

parent - the parent view to display the banner in

index - the position at which to add the banner or -1 to add last

params - the layout parameters to set on the banner

Returns:

the Banner.Builder object to chain calls

See Also:

setParent(ViewGroup), setParent(ViewGroup, int)

setId

public Banner.Builder setId(int id)

Sets the identifier for this banner. The identifier should be a positive number.

Parameters:

id - A number used to identify the banner

Returns:

the Banner.Builder object to chain calls

setIcon

public Banner.Builder setIcon(int iconId)

Sets the Drawable to be used in the banner.

Returns:

the Banner.Builder object to chain calls

setIcon

public Banner.Builder setIcon(android.graphics.drawable.Drawable icon)

Sets the resource id of the Drawable to be used in the banner.

Returns:

the Banner.Builder object to chain calls

setMessage

public Banner.Builder setMessage(int textId)

Sets the message to display in the banner using the given resource id.

Returns:

the Banner.Builder object to chain calls

setMessage

public Banner.Builder setMessage(java.lang.String text)

Sets the message to display in the banner.

Returns:

the Banner.Builder object to chain calls

setLeftButton

public Banner.Builder setLeftButton(int textId,
                                    BannerInterface.OnClickListener listener)

Sets a listener to be invoked when the left button of the banner is pressed.

Usually used for the dismissive action.

Parameters:

textId - The resource id of the text to display in the left button

listener - The BannerInterface.OnClickListener to use

Returns:

the Banner.Builder object to chain calls

setLeftButton

public Banner.Builder setLeftButton(java.lang.String text,
                                    BannerInterface.OnClickListener listener)

Sets a listener to be invoked when the left button of the banner is pressed.

Usually used for the dismissive action.

Parameters:

text - The text to display in the left button

listener - The BannerInterface.OnClickListener to use

Returns:

the Banner.Builder object to chain calls

setRightButton

public Banner.Builder setRightButton(int textId,
                                     BannerInterface.OnClickListener listener)

Sets a listener to be invoked when the right button of the banner is pressed.

Usually used for the confirming action.

Parameters:

textId - The resource id of the text to display in the right button

listener - The BannerInterface.OnClickListener to use

Returns:

the Banner.Builder object to chain calls

setRightButton

public Banner.Builder setRightButton(java.lang.String text,
                                     BannerInterface.OnClickListener listener)

Sets a listener to be invoked when the right button of the banner is pressed.

Usually used for the confirming action.

Parameters:

text - The text to display in the right button

listener - The BannerInterface.OnClickListener to use

Returns:

the Banner.Builder object to chain calls

setOnDismissListener

public Banner.Builder setOnDismissListener(BannerInterface.OnDismissListener listener)

Sets a listener to be invoked when the banner is dismissed.

Parameters:

listener - The BannerInterface.OnDismissListener to use

Returns:

the Banner.Builder object to chain calls

setOnShowListener

public Banner.Builder setOnShowListener(BannerInterface.OnShowListener listener)

Sets a listener to be invoked when the banner is shown.

Parameters:

listener - The BannerInterface.OnShowListener to use

Returns:

the Banner.Builder object to chain calls

create

public Banner create()

Creates a Banner with the arguments supplied to this builder.

Calling this method does not display the banner. If no additional processing is needed, show() may be called instead to both create and display the banner.

Returns:

The banner created using the arguments supplied to this builder

show

public Banner show()

Creates a Banner with the arguments supplied to this builder and immediately displays the banner.

Calling this method is functionally identical to:

 Banner banner = builder.create();
 banner.show();

Returns:

The banner created using the arguments supplied to this builder