- ErrorsKt - Class in com.nambimobile.widgets.efab
-
- ErrorsKt() - Constructor for class com.nambimobile.widgets.efab.ErrorsKt
-
- ExpandableFab - Class in com.nambimobile.widgets.efab
-
The design and behavior of a Floating Action Button which can animate and expand to show
optional
class FabOption
s when clicked. It's the focal point for the ExpandableFab widget's
functionality, from an end-user's perspective.
- ExpandableFab(context, orientation) - Constructor for class com.nambimobile.widgets.efab.ExpandableFab
-
Used to create an ExpandableFab programmatically (do not use the other constructor
ExpandableFab(context, attributeSet) - it is for use by the Android framework when
inflating an ExpandableFab via XML). This constructor keeps all optional properties of an
ExpandableFab and its optional label 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).
- ExpandableFab(context, attributeSet) - Constructor for class com.nambimobile.widgets.efab.ExpandableFab
-
Called by the system when creating an ExpandableFab via XML (don't call this directly).
To create an ExpandableFab programmatically, use the ExpandableFab(context, orientation)
constructor.
- ExpandableFabLayout - Class in com.nambimobile.widgets.efab
-
The container and controller for all children views of the ExpandableFab widget (Overlay,
ExpandableFab, FabOption, Label). The ExpandableFabLayout handles the bulk of the functionality
for the ExpandableFab widget as a whole (from coordinating opening and closing animations to
screen orientation changes, etc). See below for an example on how to easily set up the
ExpandableFab widget using the ExpandableFabLayout as the containing ViewGroup.
- ExpandableFabLayout(context) - Constructor for class com.nambimobile.widgets.efab.ExpandableFabLayout
-
Used to create an ExpandableFabLayout programmatically (do not use the other constructor
ExpandableFabLayout(context, attributeSet) - it is for use by the Android framework when
inflating an ExpandableFabLayout via XML).
- ExpandableFabLayout(context, attributeSet) - Constructor for class com.nambimobile.widgets.efab.ExpandableFabLayout
-
Called by the system when creating an ExpandableFabLayout via XML (don't call this directly).
To create an ExpandableFabLayout programmatically, use the ExpandableFabLayout(context)
constructor.
- getClosingAnimationDurationMs() - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The duration (in milliseconds as a positive long) of the ExpandableFab's closing animations.
Default value is 500L.
- getClosingAnimationDurationMs() - Method in class com.nambimobile.widgets.efab.FabOption
-
The duration (in milliseconds as a positive long) of the animations that will be played
when this FabOption is being hidden from a visible state (when the ExpandableFab is closing).
Default value is 75L.
- getClosingAnimationDurationMs() - Method in class com.nambimobile.widgets.efab.Overlay
-
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.
- getClosingAnticipateTension() - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The tension (as a positive float) applied on the ExpandableFab's icon to mimic an
AnticipateInterpolator when it's playing its closing animations. An AnticipateInterpolator
allows us to have a closing animation where the ExpandableFab's icon will begin rotating
slightly backwards, before smoothly rotating forward to its default 0 degree rotation.
Every multiple of 10f will be a full 360 degree rotation backwards. Default value is 2f.
- getCurrentConfiguration() - Method in class com.nambimobile.widgets.efab.ExpandableFabLayout
-
Returns the OrientationConfiguration showing for the current screen orientation.
An OrientationConfiguration is just a holder for all the views of an ExpandableFab widget
in a specific
enum Orientation
.
- getEfab() - Method in class com.nambimobile.widgets.efab.OrientationConfiguration
-
- getEfabColor() - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The color of the ExpandableFab. Default value is your app's colorAccent.
- getEfabEnabled() - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The enabled state of this ExpandableFab and its label. Disabled ExpandableFabs and labels
will be visually distinct and unclickable. Default value is true (enabled).
- getEfabIcon() - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The drawable to show as the ExpandableFab's icon. Default value is a white plus sign vector
drawable.
- getEfabSize() - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The size of this ExpandableFab (NOT its FabOptions. For that, see property
fabOptionSize
).
Must be FabSize.MINI, FabSize.NORMAL, FabSize.AUTO or FabSize.CUSTOM.
FabSize.CUSTOM should be used when you're setting the size of the ExpandableFab's
layout_width and layout_height to a custom value manually (when using CUSTOM, make sure to
also set app:fabCustomSize equal to your custom layout_width/layout_height size and
app:maxImageSize equal to your icon size in order to ensure your icon is centered
properly). Default value is FabSize.NORMAL.
- getFabOptionColor() - Method in class com.nambimobile.widgets.efab.FabOption
-
The color of the FabOption. Default value is your app's colorAccent.
- getFabOptionEnabled() - Method in class com.nambimobile.widgets.efab.FabOption
-
The enabled state of this FabOption and its label. Disabled FabOptions and labels will be
visually distinct and unclickable. Default value is true (enabled).
- getFabOptionIcon() - Method in class com.nambimobile.widgets.efab.FabOption
-
The drawable to show as the FabOption's icon. Default value is null (no icon shown).
- getFabOptionPosition() - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
How each FabOption in this orientation will be positioned relative to the previous
FabOption. Default value is FabOptionPosition.ABOVE.
- getFabOptions() - Method in class com.nambimobile.widgets.efab.OrientationConfiguration
-
The
class FabOption
s (with optional labels) in this orientation. May be empty.
- getFabOptionSize() - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The size of each FabOption in this orientation (NOT the size of the ExpandableFab. For that,
see property
efabSize
). Must be FabSize.MINI, FabSize.NORMAL, FabSize.AUTO or
FabSize.CUSTOM. FabSize.CUSTOM should be used when you're setting the size of the
FabOptions' layout_width and layout_height to a custom value manually (when using CUSTOM,
make sure to also set app:fabCustomSize equal to your custom layout_width/layout_height
size and app:maxImageSize equal to your icon size in order to ensure your icon is centered
properly). Default value is FabSize.MINI.
- getFirstFabOptionMarginPx() - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The margin (in pixels as a positive float) between the first FabOption in this orientation
and the ExpandableFab itself. Depending on the size you set for the ExpandableFab, you may
want this margin to be different than
successiveFabOptionMarginPx
. Default value is 80f.
- getHiddenToVisibleAnimationDurationMs() - Method in class com.nambimobile.widgets.efab.Label
-
The duration (in milliseconds as a positive long) of the animations that the Label will
play when going from a hidden to visible state.
- getIconAnimationRotationDeg() - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
A float, in degrees, representing how much the ExpandableFab's icon will rotate when
animating. When opening, the ExpandableFab will rotate from 0 to this value. When closing,
the icon will rotate from this value to its initial position of 0. Default value is -135f.
- getLabel() - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The optional label attached to this ExpandableFab. The label will only be shown when its
labelText is not null. Default values for the label are as follows:
- getLabel() - Method in class com.nambimobile.widgets.efab.FabOption
-
The optional label attached to this FabOption. The label will only be shown when its
labelText is not null. Default values for the label are as follows:
- getLabelBackgroundColor() - Method in class com.nambimobile.widgets.efab.Label
-
The color of the Label's background. Usage of this property is preferred over the
inherited setBackgroundColor method.
- getLabelElevation() - Method in class com.nambimobile.widgets.efab.Label
-
The elevation of the Label, in pixels as a positive float. Retrieve this value in the
correct form from your dimens.xml file using:
resources.getDimensionPixelSize(R.dimen.name_of_elevation_size). Usage of this property is
preferred over the inherited set/getElevation methods.
- getLabelText() - Method in class com.nambimobile.widgets.efab.Label
-
The text of the Label. Can be set to null to hide the label. Usage of this property is
preferred over the inherited set/getText methods.
- getLabelTextColor() - Method in class com.nambimobile.widgets.efab.Label
-
The color of the Label's text. Usage of this property is preferred over the inherited
setTextColor method variations.
- getLabelTextSize() - Method in class com.nambimobile.widgets.efab.Label
-
The size of the Label's text, as a float. Retrieve this value in the correct form from your
dimens.xml file using: resources.getDimension(R.dimen.name_of_text_size). Text sizes should
use sp as the unit. Usage of this property is preferred over the inherited set/getTextSize
methods.
- getLandscapeConfiguration() - Method in class com.nambimobile.widgets.efab.ExpandableFabLayout
-
A holder for all the views of the ExpandableFab widget declared in the landscape screen
orientation. Values for the views will only be populated after they are added through calls
to ExpandableFabLayout's addView methods (or after they're defined via XML).
- getMarginPx() - Method in class com.nambimobile.widgets.efab.Label
-
The margin (in pixels as a positive float) between the Label and the view it is attached to.
Negative values are not allowed since clients should likely be changing the Label's
position
if they wanted to move the Label to the opposite side of the view it's attached
to.
- getOpeningAnimationDurationMs() - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The duration (in milliseconds as a positive long) of the ExpandableFab's opening animations.
Default value is 250L.
- getOpeningAnimationDurationMs() - Method in class com.nambimobile.widgets.efab.FabOption
-
The duration (in milliseconds as a positive long) of the animations that will be played
when this FabOption is being shown from a hidden state (when the ExpandableFab is opening).
Default value is 125L.
- getOpeningAnimationDurationMs() - Method in class com.nambimobile.widgets.efab.Overlay
-
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.
- getOpeningOvershootTension() - Method in class com.nambimobile.widgets.efab.FabOption
-
The tension (as a positive float) in an OvershootInterpolator applied on the FabOption when
it's playing its animations for being shown from a hidden state (when the ExpandableFab is
opening). The OvershootInterpolator allows us to have an animation where the FabOption
will grow past its regular size when initially appearing, before smoothly shrinking down
to regular size. Larger values will exaggerate the effort more. Default value is 3.5f.
- getOrientation() - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The
enum Orientation
this ExpandableFab is viewable in. Default value is Orientation.PORTRAIT.
- getOrientation() - Method in class com.nambimobile.widgets.efab.FabOption
-
The
enum Orientation
this FabOption is viewable in. Default value is Orientation.PORTRAIT.
- getOrientation() - Method in class com.nambimobile.widgets.efab.Overlay
-
The
enum Orientation
this Overlay is viewable in. Default value is Orientation.PORTRAIT.
- getOverlay() - Method in class com.nambimobile.widgets.efab.OrientationConfiguration
-
- getOverlayAlpha() - Method in class com.nambimobile.widgets.efab.Overlay
-
The opacity of the overlay as a positive float, where 0 is completely transparent and 1 is
completely opaque. Default value is 0.78431f.
- getOverlayColor() - Method in class com.nambimobile.widgets.efab.Overlay
-
The color of the overlay. Default value is white.
- getOvershootTension() - Method in class com.nambimobile.widgets.efab.Label
-
The tension (as a positive float) in an OvershootInterpolator applied on the Label when it
is being shown from a hidden state. Larger values will exaggerate the effect more.
- getPortraitConfiguration() - Method in class com.nambimobile.widgets.efab.ExpandableFabLayout
-
A holder for all the views of the ExpandableFab widget declared in the portrait screen
orientation. Values for the views will only be populated after they are added through calls
to ExpandableFabLayout's addView methods (or after they're defined via XML).
- getPosition() - Method in class com.nambimobile.widgets.efab.Label
-
- getSuccessiveFabOptionMarginPx() - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The margin (in pixels as a positive float) between successive FabOptions in this
ExpandableFab orientation. See
firstFabOptionMarginPx
if trying to set the margin
between the first FabOption in this orientation and the ExpandableFab itself. Default value
is 75f.
- getTranslationXPx() - Method in class com.nambimobile.widgets.efab.Label
-
The distance (in pixels as a float) the Label will travel horizontally during animations.
A negative value will make the Label travel to the left, while a positive value will make
it travel to the right. See its use in visibleToHiddenAnimations and
hiddenToVisibleAnimations.
- getValue() - Method in enum com.nambimobile.widgets.efab.FabOptionPosition
-
- getValue() - Method in enum com.nambimobile.widgets.efab.FabSize
-
- getValue() - Method in enum com.nambimobile.widgets.efab.LabelPosition
-
- getVisibleToHiddenAnimationDurationMs() - Method in class com.nambimobile.widgets.efab.Label
-
The duration (in milliseconds as a positive long) of the animations that the Label will
play when going from a visible to hidden state.
- setClosingAnimationDurationMs(value) - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The duration (in milliseconds as a positive long) of the ExpandableFab's closing animations.
Default value is 500L.
- setClosingAnimationDurationMs(value) - Method in class com.nambimobile.widgets.efab.FabOption
-
The duration (in milliseconds as a positive long) of the animations that will be played
when this FabOption is being hidden from a visible state (when the ExpandableFab is closing).
Default value is 75L.
- setClosingAnimationDurationMs(value) - Method in class com.nambimobile.widgets.efab.Overlay
-
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.
- setClosingAnticipateTension(value) - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The tension (as a positive float) applied on the ExpandableFab's icon to mimic an
AnticipateInterpolator when it's playing its closing animations. An AnticipateInterpolator
allows us to have a closing animation where the ExpandableFab's icon will begin rotating
slightly backwards, before smoothly rotating forward to its default 0 degree rotation.
Every multiple of 10f will be a full 360 degree rotation backwards. Default value is 2f.
- setEfabColor(value) - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The color of the ExpandableFab. Default value is your app's colorAccent.
- setEfabEnabled(value) - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The enabled state of this ExpandableFab and its label. Disabled ExpandableFabs and labels
will be visually distinct and unclickable. Default value is true (enabled).
- setEfabIcon(value) - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The drawable to show as the ExpandableFab's icon. Default value is a white plus sign vector
drawable.
- setEfabSize(value) - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The size of this ExpandableFab (NOT its FabOptions. For that, see property
fabOptionSize
).
Must be FabSize.MINI, FabSize.NORMAL, FabSize.AUTO or FabSize.CUSTOM.
FabSize.CUSTOM should be used when you're setting the size of the ExpandableFab's
layout_width and layout_height to a custom value manually (when using CUSTOM, make sure to
also set app:fabCustomSize equal to your custom layout_width/layout_height size and
app:maxImageSize equal to your icon size in order to ensure your icon is centered
properly). Default value is FabSize.NORMAL.
- setFabOptionColor(value) - Method in class com.nambimobile.widgets.efab.FabOption
-
The color of the FabOption. Default value is your app's colorAccent.
- setFabOptionEnabled(value) - Method in class com.nambimobile.widgets.efab.FabOption
-
The enabled state of this FabOption and its label. Disabled FabOptions and labels will be
visually distinct and unclickable. Default value is true (enabled).
- setFabOptionIcon(value) - Method in class com.nambimobile.widgets.efab.FabOption
-
The drawable to show as the FabOption's icon. Default value is null (no icon shown).
- setFabOptionPosition(p) - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
How each FabOption in this orientation will be positioned relative to the previous
FabOption. Default value is FabOptionPosition.ABOVE.
- setFabOptionSize(p) - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The size of each FabOption in this orientation (NOT the size of the ExpandableFab. For that,
see property
efabSize
). Must be FabSize.MINI, FabSize.NORMAL, FabSize.AUTO or
FabSize.CUSTOM. FabSize.CUSTOM should be used when you're setting the size of the
FabOptions' layout_width and layout_height to a custom value manually (when using CUSTOM,
make sure to also set app:fabCustomSize equal to your custom layout_width/layout_height
size and app:maxImageSize equal to your icon size in order to ensure your icon is centered
properly). Default value is FabSize.MINI.
- setFirstFabOptionMarginPx(value) - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The margin (in pixels as a positive float) between the first FabOption in this orientation
and the ExpandableFab itself. Depending on the size you set for the ExpandableFab, you may
want this margin to be different than
successiveFabOptionMarginPx
. Default value is 80f.
- setHiddenToVisibleAnimationDurationMs(value) - Method in class com.nambimobile.widgets.efab.Label
-
The duration (in milliseconds as a positive long) of the animations that the Label will
play when going from a hidden to visible state.
- setIconAnimationRotationDeg(p) - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
A float, in degrees, representing how much the ExpandableFab's icon will rotate when
animating. When opening, the ExpandableFab will rotate from 0 to this value. When closing,
the icon will rotate from this value to its initial position of 0. Default value is -135f.
- setLabelBackgroundColor(value) - Method in class com.nambimobile.widgets.efab.Label
-
The color of the Label's background. Usage of this property is preferred over the
inherited setBackgroundColor method.
- setLabelElevation(value) - Method in class com.nambimobile.widgets.efab.Label
-
The elevation of the Label, in pixels as a positive float. Retrieve this value in the
correct form from your dimens.xml file using:
resources.getDimensionPixelSize(R.dimen.name_of_elevation_size). Usage of this property is
preferred over the inherited set/getElevation methods.
- setLabelText(value) - Method in class com.nambimobile.widgets.efab.Label
-
The text of the Label. Can be set to null to hide the label. Usage of this property is
preferred over the inherited set/getText methods.
- setLabelTextColor(value) - Method in class com.nambimobile.widgets.efab.Label
-
The color of the Label's text. Usage of this property is preferred over the inherited
setTextColor method variations.
- setLabelTextSize(value) - Method in class com.nambimobile.widgets.efab.Label
-
The size of the Label's text, as a float. Retrieve this value in the correct form from your
dimens.xml file using: resources.getDimension(R.dimen.name_of_text_size). Text sizes should
use sp as the unit. Usage of this property is preferred over the inherited set/getTextSize
methods.
- setMarginPx(value) - Method in class com.nambimobile.widgets.efab.Label
-
The margin (in pixels as a positive float) between the Label and the view it is attached to.
Negative values are not allowed since clients should likely be changing the Label's
position
if they wanted to move the Label to the opposite side of the view it's attached
to.
- setOnClickListener(onClickListener) - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
Registers a callback to be invoked when this ExpandableFab or its label is clicked. The
default behavior the ExpandableFab will be executed before this custom callback.
- setOnClickListener(onClickListener) - Method in class com.nambimobile.widgets.efab.FabOption
-
Registers a callback to be invoked when this FabOption or its label is clicked. The
default behavior the FabOption will be executed before this custom callback.
- setOnClickListener(onClickListener) - Method in class com.nambimobile.widgets.efab.Overlay
-
Registers a callback to be invoked when this Overlay is clicked. The default behavior the
Overlay will be executed before this custom callback.
- setOpeningAnimationDurationMs(value) - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The duration (in milliseconds as a positive long) of the ExpandableFab's opening animations.
Default value is 250L.
- setOpeningAnimationDurationMs(value) - Method in class com.nambimobile.widgets.efab.FabOption
-
The duration (in milliseconds as a positive long) of the animations that will be played
when this FabOption is being shown from a hidden state (when the ExpandableFab is opening).
Default value is 125L.
- setOpeningAnimationDurationMs(value) - Method in class com.nambimobile.widgets.efab.Overlay
-
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.
- setOpeningOvershootTension(value) - Method in class com.nambimobile.widgets.efab.FabOption
-
The tension (as a positive float) in an OvershootInterpolator applied on the FabOption when
it's playing its animations for being shown from a hidden state (when the ExpandableFab is
opening). The OvershootInterpolator allows us to have an animation where the FabOption
will grow past its regular size when initially appearing, before smoothly shrinking down
to regular size. Larger values will exaggerate the effort more. Default value is 3.5f.
- setOverlayAlpha(value) - Method in class com.nambimobile.widgets.efab.Overlay
-
The opacity of the overlay as a positive float, where 0 is completely transparent and 1 is
completely opaque. Default value is 0.78431f.
- setOverlayColor(value) - Method in class com.nambimobile.widgets.efab.Overlay
-
The color of the overlay. Default value is white.
- setOvershootTension(value) - Method in class com.nambimobile.widgets.efab.Label
-
The tension (as a positive float) in an OvershootInterpolator applied on the Label when it
is being shown from a hidden state. Larger values will exaggerate the effect more.
- setPosition(p) - Method in class com.nambimobile.widgets.efab.Label
-
- setSize(size) - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
Sets the size of the ExpandableFab. Overridden to ensure we never set the size to be
FabSize.CUSTOM.
- setSize(size) - Method in class com.nambimobile.widgets.efab.FabOption
-
Sets the size of the FabOption. Overridden to ensure we never set the size to be
FabSize.CUSTOM.
- setSuccessiveFabOptionMarginPx(value) - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
The margin (in pixels as a positive float) between successive FabOptions in this
ExpandableFab orientation. See
firstFabOptionMarginPx
if trying to set the margin
between the first FabOption in this orientation and the ExpandableFab itself. Default value
is 75f.
- setTranslationXPx(p) - Method in class com.nambimobile.widgets.efab.Label
-
The distance (in pixels as a float) the Label will travel horizontally during animations.
A negative value will make the Label travel to the left, while a positive value will make
it travel to the right. See its use in visibleToHiddenAnimations and
hiddenToVisibleAnimations.
- setVisibleToHiddenAnimationDurationMs(value) - Method in class com.nambimobile.widgets.efab.Label
-
The duration (in milliseconds as a positive long) of the animations that the Label will
play when going from a visible to hidden state.
- show() - Method in class com.nambimobile.widgets.efab.ExpandableFab
-
Shows the ExpandableFab and optional label.