ImageFilterButton

Artifact: androidx.constraintlayout:constraintlayout

Added in 2.2.1

Kotlin |Java

public class ImageFilterButton extends AppCompatImageButton

java.lang.Object
↳	android.view.View
	↳	android.widget.ImageView
		↳	android.widget.ImageButton
			↳	androidx.appcompat.widget.AppCompatImageButton
				↳	androidx.constraintlayout.utils.widget.ImageFilterButton

An AppCompatImageButton that can display, combine and filter images. Added in 2.0

Subclass of AppCompatImageButton to handle various common filtering operations.

ImageFilterButton attributes

altSrc	Provide and alternative image to the src image to allow cross fading
saturation	Sets the saturation of the image. 0 = grayscale, 1 = original, 2 = hyper saturated
brightness	Sets the brightness of the image. 0 = black, 1 = original, 2 = twice as bright
warmth	This adjust the apparent color temperature of the image. 1=neutral, 2=warm, .5=cold
contrast	This sets the contrast. 1 = unchanged, 0 = gray, 2 = high contrast
crossfade	Set the current mix between the two images. 0=src 1= altSrc image
round	(id) call the TransitionListener with this trigger id
roundPercent	Set the corner radius of curvature as a fraction of the smaller side. For squares 1 will result in a circle
overlay	Defines whether the alt image will be faded in on top of the original image or if it will be crossfaded with it. Default is true. Set to false for semitransparent objects

Summary

Public constructors
`ImageFilterButton(Context context)`
`ImageFilterButton(Context context, AttributeSet attrs)`
`ImageFilterButton(Context context, AttributeSet attrs, int defStyleAttr)`

Public methods
`void`	`draw(@NonNull Canvas canvas)`
`float`	`getContrast()` Returns the currently applied contrast
`float`	`getCrossfade()` Returns the currently applied crossfade.
`float`	`getImagePanX()` gts the pan from the center pan of 1 the image is "all the way to the right" if the images width is greater than the screen width, pan = 1 results in the left edge lining up if the images width is less than the screen width, pan = 1 results in the right edges lining up if image width == screen width it does nothing
`float`	`getImagePanY()` gets the pan from the center pan of 1 the image is "all the way to the bottom" if the images width is greater than the screen height, pan = 1 results in the bottom edge lining up if the images width is less than the screen height, pan = 1 results in the top edges lining up if image height == screen height it does nothing
`float`	`getImageRotate()` gets the rotation
`float`	`getImageZoom()` sets the zoom where 1 scales the image just enough to fill the view
`float`	`getRound()` Get the corner radius of curvature NaN = RoundPercent in effect.
`float`	`getRoundPercent()` Get the fractional corner radius of curvature.
`float`	`getSaturation()` Returns the currently applied saturation
`float`	`getWarmth()` Returns the currently applied warmth
`void`	`layout(int l, int t, int r, int b)`
`void`	`setAltImageResource(int resId)` Set the alternative image used to cross fade to.
`void`	`setBrightness(float brightness)` sets the brightness of the image; 0 = black, 1 = original, 2 = twice as bright
`void`	`setContrast(float contrast)` This sets the contrast.
`void`	`setCrossfade(float crossfade)` Set the current mix between the two images that can be set on this view.
`void`	`setImageDrawable(Drawable drawable)`
`void`	`setImagePanX(float pan)` sets the pan from the center pan of 1 the image is "all the way to the right" if the images width is greater than the screen width, pan = 1 results in the left edge lining up if the images width is less than the screen width, pan = 1 results in the right edges lining up if image width == screen width it does nothing
`void`	`setImagePanY(float pan)` sets the pan from the center pan of 1 the image is "all the way to the bottom" if the images width is greater than the screen height, pan = 1 results in the bottom edge lining up if the images width is less than the screen height, pan = 1 results in the top edges lining up if image height == screen height it does nothing
`void`	`setImageResource(int resId)`
`void`	`setImageRotate(float rotation)` sets the rotation angle of the image in degrees
`void`	`setImageZoom(float zoom)` sets the zoom where 1 scales the image just enough to fill the view
`void`	`@RequiresApi(value = Build.VERSION_CODES.LOLLIPOP) setRound(float round)` Set the corner radius of curvature
`void`	`@RequiresApi(value = Build.VERSION_CODES.LOLLIPOP) setRoundPercent(float round)` Set the corner radius of curvature as a fraction of the smaller side.
`void`	`setSaturation(float saturation)` sets the saturation of the image; 0 = grayscale, 1 = original, 2 = hyper saturated
`void`	`setWarmth(float warmth)` This makes the apparent color temperature of the image warmer or colder.

Inherited Constants

From android.view.View

`static final int`	`ACCESSIBILITY_DATA_SENSITIVE_AUTO = 0`
`static final int`	`ACCESSIBILITY_DATA_SENSITIVE_NO = 2`
`static final int`	`ACCESSIBILITY_DATA_SENSITIVE_YES = 1`
`static final int`	`ACCESSIBILITY_LIVE_REGION_ASSERTIVE = 2`
`static final int`	`ACCESSIBILITY_LIVE_REGION_NONE = 0`
`static final int`	`ACCESSIBILITY_LIVE_REGION_POLITE = 1`
`static final Property<View, Float>`	`ALPHA`
`static final int`	`AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS = 1`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE = "creditCardExpirationDate"`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY = "creditCardExpirationDay"`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH = "creditCardExpirationMonth"`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR = "creditCardExpirationYear"`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_NUMBER = "creditCardNumber"`
`static final String`	`AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE = "creditCardSecurityCode"`
`static final String`	`AUTOFILL_HINT_EMAIL_ADDRESS = "emailAddress"`
`static final String`	`AUTOFILL_HINT_NAME = "name"`
`static final String`	`AUTOFILL_HINT_PASSWORD = "password"`
`static final String`	`AUTOFILL_HINT_PHONE = "phone"`
`static final String`	`AUTOFILL_HINT_POSTAL_ADDRESS = "postalAddress"`
`static final String`	`AUTOFILL_HINT_POSTAL_CODE = "postalCode"`
`static final String`	`AUTOFILL_HINT_USERNAME = "username"`
`static final int`	`AUTOFILL_TYPE_DATE = 4`
`static final int`	`AUTOFILL_TYPE_LIST = 3`
`static final int`	`AUTOFILL_TYPE_NONE = 0`
`static final int`	`AUTOFILL_TYPE_TEXT = 1`
`static final int`	`AUTOFILL_TYPE_TOGGLE = 2`
`static final int`	`DRAG_FLAG_ACCESSIBILITY_ACTION = 1024`
`static final int`	`DRAG_FLAG_GLOBAL = 256`
`static final int`	`DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION = 64`
`static final int`	`DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION = 128`
`static final int`	`DRAG_FLAG_GLOBAL_URI_READ = 1`
`static final int`	`DRAG_FLAG_GLOBAL_URI_WRITE = 2`
`static final int`	`DRAG_FLAG_OPAQUE = 512`
`static final int`	`DRAWING_CACHE_QUALITY_AUTO = 0` This field is deprecated.
`static final int`	`DRAWING_CACHE_QUALITY_HIGH = 1048576` This field is deprecated.
`static final int`	`DRAWING_CACHE_QUALITY_LOW = 524288` This field is deprecated.
`static final int[]`	`EMPTY_STATE_SET`
`static final int[]`	`ENABLED_FOCUSED_SELECTED_STATE_SET`
`static final int[]`	`ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`ENABLED_FOCUSED_STATE_SET`
`static final int[]`	`ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`ENABLED_SELECTED_STATE_SET`
`static final int[]`	`ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`ENABLED_STATE_SET`
`static final int[]`	`ENABLED_WINDOW_FOCUSED_STATE_SET`
`static final int`	`FIND_VIEWS_WITH_CONTENT_DESCRIPTION = 2`
`static final int`	`FIND_VIEWS_WITH_TEXT = 1`
`static final int`	`FOCUSABLE = 1`
`static final int`	`FOCUSABLES_ALL = 0`
`static final int`	`FOCUSABLES_TOUCH_MODE = 1`
`static final int`	`FOCUSABLE_AUTO = 16`
`static final int[]`	`FOCUSED_SELECTED_STATE_SET`
`static final int[]`	`FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`FOCUSED_STATE_SET`
`static final int[]`	`FOCUSED_WINDOW_FOCUSED_STATE_SET`
`static final int`	`FOCUS_BACKWARD = 1`
`static final int`	`FOCUS_DOWN = 130`
`static final int`	`FOCUS_FORWARD = 2`
`static final int`	`FOCUS_LEFT = 17`
`static final int`	`FOCUS_RIGHT = 66`
`static final int`	`FOCUS_UP = 33`
`static final int`	`GONE = 8`
`static final int`	`HAPTIC_FEEDBACK_ENABLED = 268435456`
`static final int`	`IMPORTANT_FOR_ACCESSIBILITY_AUTO = 0`
`static final int`	`IMPORTANT_FOR_ACCESSIBILITY_NO = 2`
`static final int`	`IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS = 4`
`static final int`	`IMPORTANT_FOR_ACCESSIBILITY_YES = 1`
`static final int`	`IMPORTANT_FOR_AUTOFILL_AUTO = 0`
`static final int`	`IMPORTANT_FOR_AUTOFILL_NO = 2`
`static final int`	`IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS = 8`
`static final int`	`IMPORTANT_FOR_AUTOFILL_YES = 1`
`static final int`	`IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS = 4`
`static final int`	`IMPORTANT_FOR_CONTENT_CAPTURE_AUTO = 0`
`static final int`	`IMPORTANT_FOR_CONTENT_CAPTURE_NO = 2`
`static final int`	`IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS = 8`
`static final int`	`IMPORTANT_FOR_CONTENT_CAPTURE_YES = 1`
`static final int`	`IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS = 4`
`static final int`	`INVISIBLE = 4`
`static final int`	`KEEP_SCREEN_ON = 67108864`
`static final int`	`LAYER_TYPE_HARDWARE = 2`
`static final int`	`LAYER_TYPE_NONE = 0`
`static final int`	`LAYER_TYPE_SOFTWARE = 1`
`static final int`	`LAYOUT_DIRECTION_INHERIT = 2`
`static final int`	`LAYOUT_DIRECTION_LOCALE = 3`
`static final int`	`LAYOUT_DIRECTION_LTR = 0`
`static final int`	`LAYOUT_DIRECTION_RTL = 1`
`static final int`	`MEASURED_HEIGHT_STATE_SHIFT = 16`
`static final int`	`MEASURED_SIZE_MASK = 16777215`
`static final int`	`MEASURED_STATE_MASK = -16777216`
`static final int`	`MEASURED_STATE_TOO_SMALL = 16777216`
`static final int`	`NOT_FOCUSABLE = 0`
`static final int`	`NO_ID = -1`
`static final int`	`OVER_SCROLL_ALWAYS = 0`
`static final int`	`OVER_SCROLL_IF_CONTENT_SCROLLS = 1`
`static final int`	`OVER_SCROLL_NEVER = 2`
`static final int[]`	`PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_SELECTED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_STATE_SET`
`static final int[]`	`PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_FOCUSED_SELECTED_STATE_SET`
`static final int[]`	`PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_SELECTED_STATE_SET`
`static final int[]`	`PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int[]`	`PRESSED_STATE_SET`
`static final int[]`	`PRESSED_WINDOW_FOCUSED_STATE_SET`
`static final Property<View, Float>`	`ROTATION`
`static final Property<View, Float>`	`ROTATION_X`
`static final Property<View, Float>`	`ROTATION_Y`
`static final Property<View, Float>`	`SCALE_X`
`static final Property<View, Float>`	`SCALE_Y`
`static final int`	`SCREEN_STATE_OFF = 0`
`static final int`	`SCREEN_STATE_ON = 1`
`static final int`	`SCROLLBARS_INSIDE_INSET = 16777216`
`static final int`	`SCROLLBARS_INSIDE_OVERLAY = 0`
`static final int`	`SCROLLBARS_OUTSIDE_INSET = 50331648`
`static final int`	`SCROLLBARS_OUTSIDE_OVERLAY = 33554432`
`static final int`	`SCROLLBAR_POSITION_DEFAULT = 0`
`static final int`	`SCROLLBAR_POSITION_LEFT = 1`
`static final int`	`SCROLLBAR_POSITION_RIGHT = 2`
`static final int`	`SCROLL_AXIS_HORIZONTAL = 1`
`static final int`	`SCROLL_AXIS_NONE = 0`
`static final int`	`SCROLL_AXIS_VERTICAL = 2`
`static final int`	`SCROLL_CAPTURE_HINT_AUTO = 0`
`static final int`	`SCROLL_CAPTURE_HINT_EXCLUDE = 1`
`static final int`	`SCROLL_CAPTURE_HINT_EXCLUDE_DESCENDANTS = 4`
`static final int`	`SCROLL_CAPTURE_HINT_INCLUDE = 2`
`static final int`	`SCROLL_INDICATOR_BOTTOM = 2`
`static final int`	`SCROLL_INDICATOR_END = 32`
`static final int`	`SCROLL_INDICATOR_LEFT = 4`
`static final int`	`SCROLL_INDICATOR_RIGHT = 8`
`static final int`	`SCROLL_INDICATOR_START = 16`
`static final int`	`SCROLL_INDICATOR_TOP = 1`
`static final int[]`	`SELECTED_STATE_SET`
`static final int[]`	`SELECTED_WINDOW_FOCUSED_STATE_SET`
`static final int`	`SOUND_EFFECTS_ENABLED = 134217728`
`static final int`	`STATUS_BAR_HIDDEN = 1` This field is deprecated.
`static final int`	`STATUS_BAR_VISIBLE = 0` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_FULLSCREEN = 4` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_HIDE_NAVIGATION = 2` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_IMMERSIVE = 2048` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_IMMERSIVE_STICKY = 4096` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN = 1024` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION = 512` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LAYOUT_STABLE = 256` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR = 16` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LIGHT_STATUS_BAR = 8192` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_LOW_PROFILE = 1` This field is deprecated.
`static final int`	`SYSTEM_UI_FLAG_VISIBLE = 0` This field is deprecated.
`static final int`	`SYSTEM_UI_LAYOUT_FLAGS = 1536` This field is deprecated.
`static final int`	`TEXT_ALIGNMENT_CENTER = 4`
`static final int`	`TEXT_ALIGNMENT_GRAVITY = 1`
`static final int`	`TEXT_ALIGNMENT_INHERIT = 0`
`static final int`	`TEXT_ALIGNMENT_TEXT_END = 3`
`static final int`	`TEXT_ALIGNMENT_TEXT_START = 2`
`static final int`	`TEXT_ALIGNMENT_VIEW_END = 6`
`static final int`	`TEXT_ALIGNMENT_VIEW_START = 5`
`static final int`	`TEXT_DIRECTION_ANY_RTL = 2`
`static final int`	`TEXT_DIRECTION_FIRST_STRONG = 1`
`static final int`	`TEXT_DIRECTION_FIRST_STRONG_LTR = 6`
`static final int`	`TEXT_DIRECTION_FIRST_STRONG_RTL = 7`
`static final int`	`TEXT_DIRECTION_INHERIT = 0`
`static final int`	`TEXT_DIRECTION_LOCALE = 5`
`static final int`	`TEXT_DIRECTION_LTR = 3`
`static final int`	`TEXT_DIRECTION_RTL = 4`
`static final Property<View, Float>`	`TRANSLATION_X`
`static final Property<View, Float>`	`TRANSLATION_Y`
`static final Property<View, Float>`	`TRANSLATION_Z`
`static final String`	`VIEW_LOG_TAG = "View"`
`static final int`	`VISIBLE = 0`
`static final int[]`	`WINDOW_FOCUSED_STATE_SET`
`static final Property<View, Float>`	`X`
`static final Property<View, Float>`	`Y`
`static final Property<View, Float>`	`Z`

Inherited methods

From androidx.appcompat.widget.AppCompatImageButton

`void`	`drawableStateChanged()`
`boolean`	`hasOverlappingRendering()`
`void`	`setBackgroundDrawable(@Nullable Drawable background)` This method is deprecated.
`void`	`setBackgroundResource(@DrawableRes int resId)`
`void`	`setImageBitmap(Bitmap bm)`
`void`	`setImageLevel(int level)`
`void`	`setImageURI(@Nullable Uri uri)`

From android.widget.ImageButton

`CharSequence`	`getAccessibilityClassName()`
`PointerIcon`	`onResolvePointerIcon(MotionEvent event, int pointerIndex)`
`boolean`	`onSetAlpha(int alpha)`

From android.widget.ImageView

`void`	`animateTransform(Matrix matrix)`
`final void`	`clearColorFilter()`
`void`	`drawableHotspotChanged(float x, float y)`
`void`	`drawableStateChanged()`
`boolean`	`getAdjustViewBounds()`
`int`	`getBaseline()`
`boolean`	`getBaselineAlignBottom()`
`ColorFilter`	`getColorFilter()`
`boolean`	`getCropToPadding()`
`Drawable`	`getDrawable()`
`int`	`getImageAlpha()`
`Matrix`	`getImageMatrix()`
`BlendMode`	`getImageTintBlendMode()`
`ColorStateList`	`getImageTintList()`
`PorterDuff.Mode`	`getImageTintMode()`
`int`	`getMaxHeight()`
`int`	`getMaxWidth()`
`ImageView.ScaleType`	`getScaleType()`
`boolean`	`hasOverlappingRendering()`
`void`	`invalidateDrawable(Drawable dr)`
`boolean`	`isOpaque()`
`void`	`jumpDrawablesToCurrentState()`
`void`	`onAttachedToWindow()`
`int[]`	`onCreateDrawableState(int extraSpace)`
`void`	`onDetachedFromWindow()`
`void`	`onDraw(Canvas canvas)`
`void`	`onMeasure(int widthMeasureSpec, int heightMeasureSpec)`
`void`	`onRtlPropertiesChanged(int layoutDirection)`
`void`	`onVisibilityAggregated(boolean isVisible)`
`void`	`setAdjustViewBounds(boolean adjustViewBounds)`
`void`	`setAlpha(int alpha)` This method is deprecated.
`void`	`setBaseline(int baseline)`
`void`	`setBaselineAlignBottom(boolean aligned)`
`final void`	`setColorFilter(int color, PorterDuff.Mode mode)`
`void`	`setCropToPadding(boolean cropToPadding)`
`boolean`	`setFrame(int l, int t, int r, int b)`
`void`	`setImageAlpha(int alpha)`
`void`	`setImageBitmap(Bitmap bm)`
`void`	`setImageDrawable(Drawable drawable)`
`void`	`setImageIcon(Icon icon)`
`void`	`setImageLevel(int level)`
`void`	`setImageMatrix(Matrix matrix)`
`void`	`setImageResource(int resId)`
`void`	`setImageState(int[] state, boolean merge)`
`void`	`setImageTintBlendMode(BlendMode blendMode)`
`void`	`setImageTintList(ColorStateList tint)`
`void`	`setImageTintMode(PorterDuff.Mode tintMode)`
`void`	`setImageURI(Uri uri)`
`void`	`setMaxHeight(int maxHeight)`
`void`	`setMaxWidth(int maxWidth)`
`void`	`setScaleType(ImageView.ScaleType scaleType)`
`void`	`setSelected(boolean selected)`
`void`	`setVisibility(int visibility)`
`boolean`	`verifyDrawable(Drawable dr)`

From androidx.core.view.TintableBackgroundView

abstract void

setSupportBackgroundTintMode(@Nullable PorterDuff.Mode tintMode)

Specifies the blending mode used to apply the tint specified by setSupportBackgroundTintList} to the background drawable.