com.nambimobile.widgets.efab

Class Overlay

com.nambimobile.widgets.efab.Overlay

public class Overlay

An overlay that will show when an class ExpandableFab is clicked in order to partially or fully obscure the screen's content, allowing the class ExpandableFab and class FabOptions to become more apparent.

Developer Notes:

1. If you would like the Overlay to cover the entire screen, layout_width and layout_height must both be set to match_parent (assuming the parent ExpandableFabLayout has no size restrictions).

2. Overlays must be defined within an class ExpandableFabLayout to function properly.

3. To ensure that Overlays cover screen content but NOT the ExpandableFab widget itself, ensure the Overlay is the first child of ExpandableFabLayout via XML, or the first view passed to ExpandableFabLayout's addView/addViews methods via code.

Implementation Notes:

1. Since the Kotlin 'internal' modifier translates to 'public' in Java, the JvmSynthetic annotation is used on those functions and properties to hide them from the published API for Java clients. A proper solution to this issue would be a package-private visibility modifier, but Kotlin has yet to implement it (https://youtrack.jetbrains.com/issue/KT-29227). Until then, the JvmSynthetic annotations should remain in order to present the proper published API to both Java & Kotlin clients.

See Also:

class ExpandableFab, class ExpandableFab, class FabOption, class ExpandableFabLayout, JvmSynthetic

Constructor Detail

Overlay

public Overlay(@NotNull
               android.content.Context context,
               @Nullable
               Orientation orientation)

Used to create an Overlay programmatically (do not use the other constructor Overlay(context, attributeSet) - it is for use by the Android framework when inflating an Overlay via XML). This constructor keeps all optional properties of an Overlay at their default values, though you can always change these values after instantiation by using the appropriate setter methods (with the exception of orientation, which cannot be changed after instantiation).

See documentation for an exhaustive list of all optional properties and their default values.

Please review the Notes documented at the top of the class for guidelines and limitations when using Overlay.

Overlay

public Overlay(@NotNull
               android.content.Context context,
               @NotNull
               android.util.AttributeSet attributeSet)

Called by the system when creating an Overlay via XML (don't call this directly). To create an Overlay programmatically, use the Overlay(context, orientation) constructor.

Method Detail

getOrientation

@NotNull
public Orientation getOrientation()

The enum Orientation this Overlay is viewable in. Default value is Orientation.PORTRAIT.

See Also:

enum Orientation

getOverlayColor

public int getOverlayColor()

The color of the overlay. Default value is white.

Usage of this property is preferred over the inherited setBackgroundColor method.

setOverlayColor

public void setOverlayColor(int value)

The color of the overlay. Default value is white.

Usage of this property is preferred over the inherited setBackgroundColor method.

getOverlayAlpha

public float getOverlayAlpha()

The opacity of the overlay as a positive float, where 0 is completely transparent and 1 is completely opaque. Default value is 0.78431f.

Usage of this property is preferred over the inherited set/getAlpha methods.

setOverlayAlpha

public void setOverlayAlpha(float value)

The opacity of the overlay as a positive float, where 0 is completely transparent and 1 is completely opaque. Default value is 0.78431f.

Usage of this property is preferred over the inherited set/getAlpha methods.

getOpeningAnimationDurationMs

public long getOpeningAnimationDurationMs()

The duration (in milliseconds as a positive long) of the animations that will be played when this Overlay is being shown from a hidden state (when the ExpandableFab is opening). Default value is 300L.

setOpeningAnimationDurationMs

public void setOpeningAnimationDurationMs(long value)

The duration (in milliseconds as a positive long) of the animations that will be played when this Overlay is being shown from a hidden state (when the ExpandableFab is opening). Default value is 300L.

getClosingAnimationDurationMs

public long getClosingAnimationDurationMs()

The duration (in milliseconds as a positive long) of the animations that will be played when this Overlay is being hidden from a visible state (when the ExpandableFab is closing). Default value is 300L.

setClosingAnimationDurationMs

public void setClosingAnimationDurationMs(long value)

The duration (in milliseconds as a positive long) of the animations that will be played when this Overlay is being hidden from a visible state (when the ExpandableFab is closing). Default value is 300L.

setOnClickListener

public void setOnClickListener(@Nullable
                               android.view.View.OnClickListener onClickListener)

Registers a callback to be invoked when this Overlay is clicked. The default behavior the Overlay will be executed before this custom callback.