java.lang.Object | ||
↳ | android.graphics.drawable.Drawable | |
↳ | android.graphics.drawable.RotateDrawable |
A Drawable that can rotate another Drawable based on the current level value. The start and end angles of rotation can be controlled to map any circular arc to the level values range.
It can be defined in an XML file with the <rotate>
element.
For more information, see the guide to
Animation Resources.
XML Attributes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
android:drawable | Reference to a drawable resource to use for the frame. | ||||||||||
android:fromDegrees | setFromDegrees(float) | ||||||||||
android:pivotX | setPivotX(float) | ||||||||||
android:pivotY | setPivotY(float) | ||||||||||
android:toDegrees | setToDegrees(float) | ||||||||||
android:visible | Provides initial visibility state of the drawable; the default value is false. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Create a new rotating drawable with an empty state.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Draw in its bounds (set via setBounds) respecting optional effects such
as alpha (set via setAlpha) and color filter (set via setColorFilter).
| |||||||||||
Gets the current alpha value for the drawable.
| |||||||||||
Return a mask of the configuration parameters for which this drawable
may change, requiring that it be re-created.
| |||||||||||
Return a
Drawable.ConstantState instance that holds the shared state of this Drawable. | |||||||||||
Return the intrinsic height of the underlying drawable object.
| |||||||||||
Return the intrinsic width of the underlying drawable object.
| |||||||||||
Return the opacity/transparency of this Drawable.
| |||||||||||
Return in padding the insets suggested by this Drawable for placing
content inside the drawable's bounds.
| |||||||||||
Inflate this Drawable from an XML resource optionally styled by a theme.
| |||||||||||
Called when the drawable needs to be redrawn.
| |||||||||||
Indicates whether this drawable will change its appearance based on
state.
| |||||||||||
Make this drawable mutable.
| |||||||||||
A Drawable can call this to schedule the next frame of its
animation.
| |||||||||||
Specify an alpha value for the drawable.
| |||||||||||
Specify an optional color filter for the drawable.
| |||||||||||
Sets the drawable rotated by this RotateDrawable.
| |||||||||||
Sets the start angle for rotation.
| |||||||||||
Sets the X position around which the drawable is rotated.
| |||||||||||
Sets whether the X pivot value represents a fraction of the drawable
width or an absolute value in pixels.
| |||||||||||
Sets the Y position around which the drawable is rotated.
| |||||||||||
Sets whether the Y pivot value represents a fraction of the drawable
height or an absolute value in pixels.
| |||||||||||
Sets the end angle for rotation.
| |||||||||||
Set whether this Drawable is visible.
| |||||||||||
A Drawable can call this to unschedule an action previously
scheduled with
scheduleDrawable(Drawable, Runnable, long) . |
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Override this in your subclass to change appearance if you vary based on
the bounds.
| |||||||||||
Override this in your subclass to change appearance if you vary based
on level.
| |||||||||||
Override this in your subclass to change appearance if you recognize the
specified state.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.graphics.drawable.Drawable
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
android.graphics.drawable.Drawable.Callback
|
Reference to a drawable resource to use for the frame. If not given, the drawable must be defined by the first child tag.
Must be a reference to another resource, in the form "@[+][package:]type:name
"
or to a theme attribute in the form "?[package:][type:]name
".
This corresponds to the global attribute
resource symbol drawable
.
Provides initial visibility state of the drawable; the default
value is false. See
setVisible(boolean, boolean)
.
Must be a boolean value, either "true
" or "false
".
This may also be a reference to a resource (in the form
"@[package:]type:name
") or
theme attribute (in the form
"?[package:][type:]name
")
containing a value of this type.
This corresponds to the global attribute
resource symbol visible
.
Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter).
canvas | The canvas to draw into |
---|
Gets the current alpha value for the drawable. 0 means fully transparent, 255 means fully opaque. This method is implemented by Drawable subclasses and the value returned is specific to how that class treats alpha. The default return value is 255 if the class does not override this method to return a value specific to its use of alpha.
Return a mask of the configuration parameters for which this drawable
may change, requiring that it be re-created. The default implementation
returns whatever was provided through
setChangingConfigurations(int)
or 0 by default. Subclasses
may extend this to or in the changing configurations of any other
drawables they hold.
Configuration
.Return a Drawable.ConstantState
instance that holds the shared state of this Drawable.
Return the intrinsic height of the underlying drawable object. Returns -1 if it has no intrinsic height, such as with a solid color.
Return the intrinsic width of the underlying drawable object. Returns -1 if it has no intrinsic width, such as with a solid color.
Return the opacity/transparency of this Drawable. The returned value is
one of the abstract format constants in
PixelFormat
:
UNKNOWN
,
TRANSLUCENT
,
TRANSPARENT
, or
OPAQUE
.
Generally a Drawable should be as conservative as possible with the
value it returns. For example, if it contains multiple child drawables
and only shows one of them at a time, if only one of the children is
TRANSLUCENT and the others are OPAQUE then TRANSLUCENT should be
returned. You can use the method resolveOpacity(int, int)
to perform a
standard reduction of two opacities to the appropriate single output.
Note that the returned value does not take into account a
custom alpha or color filter that has been applied by the client through
the setAlpha(int)
or setColorFilter(ColorFilter)
methods.
Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. Positive values move toward the center of the Drawable (set Rect.inset).
Inflate this Drawable from an XML resource optionally styled by a theme.
r | Resources used to resolve attribute values |
---|---|
parser | XML parser from which to inflate this Drawable |
attrs | Base set of attribute values |
theme | Theme to apply, may be null |
Called when the drawable needs to be redrawn. A view at this point should invalidate itself (or at least the part of itself where the drawable appears).
who | The drawable that is requesting the update. |
---|
Indicates whether this drawable will change its appearance based on state. Clients can use this to determine whether it is necessary to calculate their state and call setState.
Make this drawable mutable. This operation cannot be reversed. A mutable drawable is guaranteed to not share its state with any other drawable. This is especially useful when you need to modify properties of drawables loaded from resources. By default, all drawables instances loaded from the same resource share a common state; if you modify the state of one instance, all the other instances will receive the same modification. Calling this method on a mutable Drawable will have no effect.
A Drawable can call this to schedule the next frame of its
animation. An implementation can generally simply call
postAtTime(Runnable, Object, long)
with
the parameters (what, who, when) to perform the
scheduling.
who | The drawable being scheduled. |
---|---|
what | The action to execute. |
when | The time (in milliseconds) to run. The timebase is
uptimeMillis()
|
Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.
Specify an optional color filter for the drawable. Pass null
to
remove any existing color filter.
cf | the color filter to apply, or null to remove the
existing color filter
|
---|
Sets the drawable rotated by this RotateDrawable.
drawable | The drawable to rotate |
---|
Sets the start angle for rotation.
fromDegrees | Starting angle in degrees |
---|
Sets the X position around which the drawable is rotated.
pivotX | X position around which to rotate. If the X pivot is relative, the position represents a fraction of the drawable width. Otherwise, the position represents an absolute value in pixels. |
---|
Sets whether the X pivot value represents a fraction of the drawable width or an absolute value in pixels.
relative | True if the X pivot represents a fraction of the drawable width, or false if it represents an absolute value in pixels |
---|
Sets the Y position around which the drawable is rotated.
pivotY | Y position around which to rotate. If the Y pivot is relative, the position represents a fraction of the drawable height. Otherwise, the position represents an absolute value in pixels. |
---|
Sets whether the Y pivot value represents a fraction of the drawable height or an absolute value in pixels.
relative | True if the Y pivot represents a fraction of the drawable height, or false if it represents an absolute value in pixels |
---|
Sets the end angle for rotation.
toDegrees | Ending angle in degrees |
---|
Set whether this Drawable is visible. This generally does not impact the Drawable's behavior, but is a hint that can be used by some Drawables, for example, to decide whether run animations.
visible | Set to true if visible, false if not. |
---|---|
restart | You can supply true here to force the drawable to behave as if it has just become visible, even if it had last been set visible. Used for example to force animations to restart. |
A Drawable can call this to unschedule an action previously
scheduled with scheduleDrawable(Drawable, Runnable, long)
. An implementation can
generally simply call
removeCallbacks(Runnable, Object)
with
the parameters (what, who) to unschedule the drawable.
who | The drawable being unscheduled. |
---|---|
what | The action being unscheduled. |
Override this in your subclass to change appearance if you vary based on the bounds.
Override this in your subclass to change appearance if you vary based on level.
Override this in your subclass to change appearance if you recognize the specified state.