Added in API level 1

ClipDrawable


open class ClipDrawable : DrawableWrapper
kotlin.Any
   ↳ android.graphics.drawable.Drawable
   ↳ android.graphics.drawable.DrawableWrapper
   ↳ android.graphics.drawable.ClipDrawable

A Drawable that clips another Drawable based on this Drawable's current level value. You can control how much the child Drawable gets clipped in width and height based on the level, as well as a gravity to control where it is placed in its overall container. Most often used to implement things like progress bars, by increasing the drawable's level with setLevel().

Note: The drawable is clipped completely and not visible when the level is 0 and fully revealed when the level is 10,000.

It can be defined in an XML file with the <clip> element. For more information, see the guide to Drawable Resources.

Summary

XML attributes
android:clipOrientation The orientation for the clip.
android:drawable Reference to a drawable resource to draw with the specified scale.
android:gravity Specifies where to clip within the drawable.
Constants
static Int

static Int

Public constructors
ClipDrawable(drawable: Drawable!, gravity: Int, orientation: Int)

Creates a new clip drawable with the specified gravity and orientation.

Public methods
open Unit

Applies the specified theme to this Drawable and its children.

open Unit
draw(canvas: Canvas)

open Int

open Unit
inflate(r: Resources, parser: XmlPullParser, attrs: AttributeSet, theme: Resources.Theme?)

Inflate this Drawable from an XML resource optionally styled by a theme.

Protected methods
open Boolean

Inherited functions

XML attributes

android:clipOrientation

android:clipOrientation
The orientation for the clip.

Must be one or more (separated by '|') of the following constant values.

Constant Value Description
horizontal 1 Clip the drawable horizontally.
vertical 2 Clip the drawable vertically.

android:drawable

android:drawable
Reference to a drawable resource to draw with the specified scale.

May be a reference to another resource, in the form "@[+][package:]type/name" or a theme attribute in the form "?[package:]type/name".

android:gravity

android:gravity
Specifies where to clip within the drawable. The default value is left.

Must be one or more (separated by '|') of the following constant values.

Constant Value Description
bottom 50 Push object to the bottom of its container, not changing its size.
center 11 Place the object in the center of its container in both the vertical and horizontal axis, not changing its size.
center_horizontal 1 Place object in the horizontal center of its container, not changing its size.
center_vertical 10 Place object in the vertical center of its container, not changing its size.
clip_horizontal 8 Additional option that can be set to have the left and/or right edges of the child clipped to its container's bounds. The clip will be based on the horizontal gravity: a left gravity will clip the right edge, a right gravity will clip the left edge, and neither will clip both edges.
clip_vertical 80 Additional option that can be set to have the top and/or bottom edges of the child clipped to its container's bounds. The clip will be based on the vertical gravity: a top gravity will clip the bottom edge, a bottom gravity will clip the top edge, and neither will clip both edges.
end 800005 Push object to the end of its container, not changing its size.
fill 77 Grow the horizontal and vertical size of the object if needed so it completely fills its container.
fill_horizontal 7 Grow the horizontal size of the object if needed so it completely fills its container.
fill_vertical 70 Grow the vertical size of the object if needed so it completely fills its container.
left 3 Push object to the left of its container, not changing its size.
right 5 Push object to the right of its container, not changing its size.
start 800003 Push object to the beginning of its container, not changing its size.
top 30 Push object to the top of its container, not changing its size.

Constants

HORIZONTAL

Added in API level 1
static val HORIZONTAL: Int
Value: 1

VERTICAL

Added in API level 1
static val VERTICAL: Int
Value: 2

Public constructors

ClipDrawable

Added in API level 1
ClipDrawable(
    drawable: Drawable!,
    gravity: Int,
    orientation: Int)

Creates a new clip drawable with the specified gravity and orientation.

Parameters
drawable Drawable!: the drawable to clip
gravity Int: gravity constant (see Gravity used to position the clipped drawable within the parent container
orientation Int: bitwise-or of HORIZONTAL and/or VERTICAL

Public methods

applyTheme

Added in API level 21
open fun applyTheme(t: Resources.Theme): Unit

Applies the specified theme to this Drawable and its children.

Parameters
t Resources.Theme: This value cannot be null.

draw

Added in API level 1
open fun draw(canvas: Canvas): Unit
Parameters
canvas Canvas: This value cannot be null.

getOpacity

Added in API level 1
open fun getOpacity(): Int
Return
Int int The opacity class of the Drawable. Value is android.graphics.PixelFormat#UNKNOWN, android.graphics.PixelFormat#TRANSLUCENT, android.graphics.PixelFormat#TRANSPARENT, or android.graphics.PixelFormat#OPAQUE

inflate

Added in API level 21
open fun inflate(
    r: Resources,
    parser: XmlPullParser,
    attrs: AttributeSet,
    theme: Resources.Theme?
): Unit

Inflate this Drawable from an XML resource optionally styled by a theme. This can't be called more than once for each Drawable. Note that framework may have called this once to create the Drawable instance from XML resource.

Parameters
r Resources: This value cannot be null.
parser XmlPullParser: This value cannot be null.
attrs AttributeSet: This value cannot be null.
theme Resources.Theme?: This value may be null.
Exceptions
org.xmlpull.v1.XmlPullParserException
java.io.IOException

Protected methods

onLevelChange

Added in API level 1
protected open fun onLevelChange(level: Int): Boolean
Return
Boolean Returns true if the level change has caused the appearance of the Drawable to change (that is, it needs to be drawn), else false if it looks the same and there is no need to redraw it since its last level.