Package icyllis.modernui.graphics.drawable

Class LayerDrawable

java.lang.Object
icyllis.modernui.graphics.drawable.Drawable
icyllis.modernui.graphics.drawable.LayerDrawable
All Implemented Interfaces:
Drawable.Callback
Direct Known Subclasses:
RippleDrawable
public class LayerDrawable extends Drawable implements Drawable.Callback
A Drawable that manages an array of other Drawables. These are drawn in array order, so the element with the largest index will be drawn on top.

  • Field Details

  • Constructor Details

    • LayerDrawable

      public LayerDrawable(@NonNull Drawable... layers)
      Creates a new layer drawable with the list of specified layers.
      Parameters:
      layers - a list of drawables to use as layers in this new drawable, must be non-null

  • Method Details

    • canApplyTheme

      public boolean canApplyTheme()
      Overrides:
      canApplyTheme in class Drawable

    • addLayer

      public int addLayer(Drawable dr)
      Adds a new layer containing the specified drawable to the end of the layer list and returns its index.
      Parameters:
      dr - The drawable to add as a new layer.
      Returns:
      The index of the new layer.

    • findDrawableByLayerId

      public Drawable findDrawableByLayerId(int id)
      Looks for a layer with the given ID and returns its Drawable.

      If multiple layers are found for the given ID, returns the Drawable for the matching layer at the highest index.

      Parameters:
      id - The layer ID to search for.
      Returns:
      The Drawable for the highest-indexed layer that has the given ID, or null if not found.

    • setId

      public void setId(int index, int id)
      Sets the ID of a layer.
      Parameters:
      index - The index of the layer to modify, must be in the range 0...getNumberOfLayers()-1.
      id - The id to assign to the layer.
      See Also:

    • getId

      public int getId(int index)
      Returns the ID of the specified layer.
      Parameters:
      index - The index of the layer, must be in the range 0...getNumberOfLayers()-1.
      Returns:
      The id of the layer or View.NO_ID if the layer has no id.
      See Also:

    • getNumberOfLayers

      public int getNumberOfLayers()
      Returns the number of layers contained within this layer drawable.
      Returns:
      The number of layers.

    • setDrawableByLayerId

      public boolean setDrawableByLayerId(int id, Drawable drawable)
      Replaces the Drawable for the layer with the given id.
      Parameters:
      id - The layer ID to search for.
      drawable - The replacement Drawable.
      Returns:
      Whether the Drawable was replaced (could return false if the id was not found).

    • findIndexByLayerId

      public int findIndexByLayerId(int id)
      Returns the layer with the specified id.

      If multiple layers have the same ID, returns the layer with the lowest index.

      Parameters:
      id - The ID of the layer to return.
      Returns:
      The index of the layer with the specified ID.

    • setDrawable

      public void setDrawable(int index, Drawable drawable)
      Sets the drawable for the layer at the specified index.
      Parameters:
      index - The index of the layer to modify, must be in the range 0...getNumberOfLayers()-1.
      drawable - The drawable to set for the layer.
      See Also:

    • getDrawable

      public Drawable getDrawable(int index)
      Returns the drawable for the layer at the specified index.
      Parameters:
      index - The index of the layer, must be in the range 0...getNumberOfLayers()-1.
      Returns:
      The Drawable at the specified layer index.
      See Also:

    • setLayerSize

      public void setLayerSize(int index, int w, int h)
      Sets an explicit size for the specified layer.

      Note: Setting an explicit layer size changes the default layer gravity behavior. See setLayerGravity(int, int) for more information.

      Parameters:
      index - the index of the layer to adjust
      w - width in pixels, or -1 to use the intrinsic width
      h - height in pixels, or -1 to use the intrinsic height
      See Also:

    • setLayerWidth

      public void setLayerWidth(int index, int w)
      Parameters:
      index - the index of the layer to adjust
      w - width in pixels, or -1 to use the intrinsic width

    • getLayerWidth

      public int getLayerWidth(int index)
      Parameters:
      index - the index of the drawable to adjust
      Returns:
      the explicit width of the layer, or -1 if not specified
      See Also:

    • setLayerHeight

      public void setLayerHeight(int index, int h)
      Parameters:
      index - the index of the layer to adjust
      h - height in pixels, or -1 to use the intrinsic height

    • getLayerHeight

      public int getLayerHeight(int index)
      Parameters:
      index - the index of the drawable to adjust
      Returns:
      the explicit height of the layer, or -1 if not specified
      See Also:

    • setLayerGravity

      public void setLayerGravity(int index, int gravity)
      Sets the gravity used to position or stretch the specified layer within its container. Gravity is applied after any layer insets (see setLayerInset(int, int, int, int, int)) or padding (see setPaddingMode(int)).

      If gravity is specified as Gravity.NO_GRAVITY, the default behavior depends on whether an explicit width or height has been set (see setLayerSize(int, int, int)), If a dimension is not set, gravity in that direction defaults to Gravity.FILL_HORIZONTAL or Gravity.FILL_VERTICAL; otherwise, gravity in that direction defaults to Gravity.LEFT or Gravity.TOP.

      Parameters:
      index - the index of the drawable to adjust
      gravity - the gravity to set for the layer
      See Also:

    • getLayerGravity

      public int getLayerGravity(int index)
      Parameters:
      index - the index of the layer
      Returns:
      the gravity used to position or stretch the specified layer within its container
      See Also:

    • setLayerInset

      public void setLayerInset(int index, int l, int t, int r, int b)
      Specifies the insets in pixels for the drawable at the specified index.
      Parameters:
      index - the index of the drawable to adjust
      l - number of pixels to add to the left bound
      t - number of pixels to add to the top bound
      r - number of pixels to subtract from the right bound
      b - number of pixels to subtract from the bottom bound

    • setLayerInsetRelative

      public void setLayerInsetRelative(int index, int s, int t, int e, int b)
      Specifies the relative insets in pixels for the drawable at the specified index.
      Parameters:
      index - the index of the layer to adjust
      s - number of pixels to inset from the start bound
      t - number of pixels to inset from the top bound
      e - number of pixels to inset from the end bound
      b - number of pixels to inset from the bottom bound

    • setLayerInsetLeft

      public void setLayerInsetLeft(int index, int l)
      Parameters:
      index - the index of the layer to adjust
      l - number of pixels to inset from the left bound

    • getLayerInsetLeft

      public int getLayerInsetLeft(int index)
      Parameters:
      index - the index of the layer
      Returns:
      number of pixels to inset from the left bound

    • setLayerInsetRight

      public void setLayerInsetRight(int index, int r)
      Parameters:
      index - the index of the layer to adjust
      r - number of pixels to inset from the right bound

    • getLayerInsetRight

      public int getLayerInsetRight(int index)
      Parameters:
      index - the index of the layer
      Returns:
      number of pixels to inset from the right bound

    • setLayerInsetTop

      public void setLayerInsetTop(int index, int t)
      Parameters:
      index - the index of the layer to adjust
      t - number of pixels to inset from the top bound

    • getLayerInsetTop

      public int getLayerInsetTop(int index)
      Parameters:
      index - the index of the layer
      Returns:
      number of pixels to inset from the top bound

    • setLayerInsetBottom

      public void setLayerInsetBottom(int index, int b)
      Parameters:
      index - the index of the layer to adjust
      b - number of pixels to inset from the bottom bound

    • getLayerInsetBottom

      public int getLayerInsetBottom(int index)
      Parameters:
      index - the index of the layer
      Returns:
      number of pixels to inset from the bottom bound

    • setLayerInsetStart

      public void setLayerInsetStart(int index, int s)
      Parameters:
      index - the index of the layer to adjust
      s - number of pixels to inset from the start bound

    • getLayerInsetStart

      public int getLayerInsetStart(int index)
      Parameters:
      index - the index of the layer
      Returns:
      the number of pixels to inset from the start bound, or INSET_UNDEFINED if not specified

    • setLayerInsetEnd

      public void setLayerInsetEnd(int index, int e)
      Parameters:
      index - the index of the layer to adjust
      e - number of pixels to inset from the end bound, or INSET_UNDEFINED if not specified

    • getLayerInsetEnd

      public int getLayerInsetEnd(int index)
      Parameters:
      index - the index of the layer
      Returns:
      number of pixels to inset from the end bound

    • setPaddingMode

      public void setPaddingMode(int mode)
      Specifies how layer padding should affect the bounds of subsequent layers. The default value is PADDING_MODE_NEST.
      Parameters:
      mode - padding mode, one of:
      See Also:

    • getPaddingMode

      public int getPaddingMode()
      Returns:
      the current padding mode
      See Also:

    • invalidateDrawable

      public void invalidateDrawable(@NonNull Drawable who)
      Description copied from interface: Drawable.Callback
      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).
      Specified by:
      invalidateDrawable in interface Drawable.Callback
      Parameters:
      who - The drawable that is requesting the update.

    • scheduleDrawable

      public void scheduleDrawable(@NonNull Drawable who, @NonNull Runnable what, long when)
      Description copied from interface: Drawable.Callback
      A Drawable can call this to schedule the next frame of its animation. An implementation can generally simply call Handler.postAtTime(Runnable, Object, long) with the parameters (what, who, when) to perform the scheduling.
      Specified by:
      scheduleDrawable in interface Drawable.Callback
      Parameters:
      who - The drawable being scheduled.
      what - The action to execute.
      when - The time (in milliseconds) to run. The timebase is Core.timeMillis()

    • unscheduleDrawable

      public void unscheduleDrawable(@NonNull Drawable who, @NonNull Runnable what)
      Description copied from interface: Drawable.Callback
      A Drawable can call this to unschedule an action previously scheduled with Drawable.Callback.scheduleDrawable(icyllis.modernui.graphics.drawable.Drawable, java.lang.Runnable, long). An implementation can generally simply call Handler.removeCallbacks(Runnable, Object) with the parameters (what, who) to unschedule the drawable.
      Specified by:
      unscheduleDrawable in interface Drawable.Callback
      Parameters:
      who - The drawable being unscheduled.
      what - The action being unscheduled.

    • draw

      public void draw(@NonNull Canvas canvas)
      Description copied from class: Drawable
      Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha).
      Specified by:
      draw in class Drawable
      Parameters:
      canvas - The canvas to draw into

    • getChangingConfigurations

      public int getChangingConfigurations()
      Description copied from class: Drawable
      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 Drawable.setChangingConfigurations(int) or 0 by default. Subclasses may extend this to or in the changing configurations of any other drawables they hold.
      Overrides:
      getChangingConfigurations in class Drawable
      Returns:
      Returns a mask of the changing configuration parameters

    • getPadding

      public boolean getPadding(@NonNull Rect padding)
      Description copied from class: Drawable
      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(int, int)).
      Overrides:
      getPadding in class Drawable
      Returns:
      true if this drawable actually has a padding, else false. When false is returned, the padding is always set to 0.

    • setPadding

      public void setPadding(int left, int top, int right, int bottom)
      Sets the absolute padding.

      If padding in a dimension is specified as -1, the resolved padding will use the value computed according to the padding mode (see setPaddingMode(int)).

      Calling this method clears any relative padding values previously set using setPaddingRelative(int, int, int, int).

      Parameters:
      left - the left padding in pixels, or -1 to use computed padding
      top - the top padding in pixels, or -1 to use computed padding
      right - the right padding in pixels, or -1 to use computed padding
      bottom - the bottom padding in pixels, or -1 to use computed padding
      See Also:

    • setPaddingRelative

      public void setPaddingRelative(int start, int top, int end, int bottom)
      Sets the relative padding.

      If padding in a dimension is specified as -1, the resolved padding will use the value computed according to the padding mode (see setPaddingMode(int)).

      Calling this method clears any absolute padding values previously set using setPadding(int, int, int, int).

      Parameters:
      start - the start padding in pixels, or -1 to use computed padding
      top - the top padding in pixels, or -1 to use computed padding
      end - the end padding in pixels, or -1 to use computed padding
      bottom - the bottom padding in pixels, or -1 to use computed padding
      See Also:

    • getLeftPadding

      public int getLeftPadding()
      Returns the left padding in pixels.

      A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(Rect) will be computed from the child layers according to the padding mode (see getPaddingMode().

      Returns:
      the left padding in pixels, or -1 if not explicitly specified
      See Also:

    • getRightPadding

      public int getRightPadding()
      Returns the right padding in pixels.

      A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(Rect) will be computed from the child layers according to the padding mode (see getPaddingMode().

      Returns:
      the right padding in pixels, or -1 if not explicitly specified
      See Also:

    • getStartPadding

      public int getStartPadding()
      Returns the start padding in pixels.

      A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(Rect) will be computed from the child layers according to the padding mode (see getPaddingMode().

      Returns:
      the start padding in pixels, or -1 if not explicitly specified
      See Also:

    • getEndPadding

      public int getEndPadding()
      Returns the end padding in pixels.

      A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(Rect) will be computed from the child layers according to the padding mode (see getPaddingMode().

      Returns:
      the end padding in pixels, or -1 if not explicitly specified
      See Also:

    • getTopPadding

      public int getTopPadding()
      Returns the top padding in pixels.

      A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(Rect) will be computed from the child layers according to the padding mode (see getPaddingMode().

      Returns:
      the top padding in pixels, or -1 if not explicitly specified
      See Also:

    • getBottomPadding

      public int getBottomPadding()
      Returns the bottom padding in pixels.

      A return value of -1 means there is no explicit padding set for this dimension. As a result, the value for this dimension returned by getPadding(Rect) will be computed from the child layers according to the padding mode (see getPaddingMode().

      Returns:
      the bottom padding in pixels, or -1 if not explicitly specified
      See Also:

    • getOutline

      public void getOutline(@NonNull Outline outline)
      Populates outline with the first available (non-empty) layer outline.
      Overrides:
      getOutline in class Drawable
      Parameters:
      outline - Outline in which to place the first available layer outline
      See Also:

    • setHotspot

      public void setHotspot(float x, float y)
      Description copied from class: Drawable
      Specifies the hotspot's location within the drawable.
      Overrides:
      setHotspot in class Drawable
      Parameters:
      x - The X coordinate of the center of the hotspot
      y - The Y coordinate of the center of the hotspot

    • setHotspotBounds

      public void setHotspotBounds(int left, int top, int right, int bottom)
      Description copied from class: Drawable
      Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds.
      Overrides:
      setHotspotBounds in class Drawable
      Parameters:
      left - position in pixels of the left bound
      top - position in pixels of the top bound
      right - position in pixels of the right bound
      bottom - position in pixels of the bottom bound
      See Also:

    • getHotspotBounds

      public void getHotspotBounds(@NonNull Rect outRect)
      Description copied from class: Drawable
      Populates outRect with the hotspot bounds.
      Overrides:
      getHotspotBounds in class Drawable
      Parameters:
      outRect - the rect to populate with the hotspot bounds
      See Also:

    • setVisible

      public boolean setVisible(boolean visible, boolean restart)
      Description copied from class: Drawable
      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.
      Overrides:
      setVisible in class Drawable
      Parameters:
      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.
      Returns:
      true if the new visibility is different from its previous state.

    • setAlpha

      public void setAlpha(int alpha)
      Description copied from class: Drawable
      Specify an alpha value for the drawable. 0 means fully transparent, and 255 means fully opaque.
      Overrides:
      setAlpha in class Drawable

    • getAlpha

      public int getAlpha()
      Description copied from class: Drawable
      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.
      Overrides:
      getAlpha in class Drawable

    • setTintList

      public void setTintList(ColorStateList tint)
      Description copied from class: Drawable
      Specifies tint color for this drawable as a color state list.

      A Drawable's drawing content will be blended together with its tint before it is drawn to the screen.

      Note: Setting a color filter via Drawable.setColorFilter(ColorFilter) overrides tint.

      Overrides:
      setTintList in class Drawable
      Parameters:
      tint - Color state list to use for tinting this drawable, or null to clear the tint
      See Also:

    • setTintBlendMode

      public void setTintBlendMode(@NonNull BlendMode blendMode)
      Description copied from class: Drawable
      Specifies a tint blending mode for this drawable.

      Defines how this drawable's tint color should be blended into the drawable before it is drawn to screen. Default tint mode is BlendMode.SRC_IN.

      Note: Setting a color filter via Drawable.setColorFilter(ColorFilter)

      Overrides:
      setTintBlendMode in class Drawable
      Parameters:
      blendMode - BlendMode to apply to the drawable, a value of null sets the default blend mode value of BlendMode.SRC_IN
      See Also:

    • setAutoMirrored

      public void setAutoMirrored(boolean mirrored)
      Description copied from class: Drawable
      Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). See LayoutDirection.
      Overrides:
      setAutoMirrored in class Drawable
      Parameters:
      mirrored - Set to true if the Drawable should be mirrored, false if not.

    • isAutoMirrored

      public boolean isAutoMirrored()
      Description copied from class: Drawable
      Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. See LayoutDirection.
      Overrides:
      isAutoMirrored in class Drawable
      Returns:
      boolean Returns true if this Drawable will be automatically mirrored.

    • jumpToCurrentState

      public void jumpToCurrentState()
      Description copied from class: Drawable
      If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations.
      Overrides:
      jumpToCurrentState in class Drawable

    • isStateful

      public boolean isStateful()
      Description copied from class: Drawable
      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.
      Overrides:
      isStateful in class Drawable
      Returns:
      True if this drawable changes its appearance based on state, false otherwise.
      See Also:

    • hasFocusStateSpecified

      public boolean hasFocusStateSpecified()
      Description copied from class: Drawable
      Indicates whether this drawable has at least one state spec explicitly specifying state_focused.

      Note: A View uses a Drawable instance as its background and it changes its appearance based on a state. On keyboard devices, it should specify its state_focused to make sure the user knows which view is holding the focus.

      Overrides:
      hasFocusStateSpecified in class Drawable
      Returns:
      true if state_focused is specified for this drawable.

    • onStateChange

      protected boolean onStateChange(@NonNull int[] state)
      Description copied from class: Drawable
      Override this in your subclass to change appearance if you recognize the specified state.
      Overrides:
      onStateChange in class Drawable
      Returns:
      Returns true if the state 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 state.

    • onLevelChange

      protected boolean onLevelChange(int level)
      Description copied from class: Drawable
      Override this in your subclass to change appearance if you vary based on level.
      Overrides:
      onLevelChange in class Drawable
      Returns:
      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.

    • onBoundsChange

      protected void onBoundsChange(@NonNull Rect bounds)
      Description copied from class: Drawable
      Override this in your subclass to change appearance if you vary based on the bounds.
      Overrides:
      onBoundsChange in class Drawable

    • getIntrinsicWidth

      public int getIntrinsicWidth()
      Description copied from class: Drawable
      Returns the drawable's intrinsic width.

      Intrinsic width is the width at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic width, such as a solid color, this method returns -1.

      Overrides:
      getIntrinsicWidth in class Drawable
      Returns:
      the intrinsic width, or -1 if no intrinsic width

    • getIntrinsicHeight

      public int getIntrinsicHeight()
      Description copied from class: Drawable
      Returns the drawable's intrinsic height.

      Intrinsic height is the height at which the drawable would like to be laid out, including any inherent padding. If the drawable has no intrinsic height, such as a solid color, this method returns -1.

      Overrides:
      getIntrinsicHeight in class Drawable
      Returns:
      the intrinsic height, or -1 if no intrinsic height

    • getConstantState

      public Drawable.ConstantState getConstantState()
      Description copied from class: Drawable
      Return a Drawable.ConstantState instance that holds the shared state of this Drawable.
      Overrides:
      getConstantState in class Drawable
      Returns:
      The ConstantState associated to that Drawable.
      See Also:

    • mutate

      @NonNull public Drawable mutate()
      Description copied from class: Drawable
      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.

      Overrides:
      mutate in class Drawable
      Returns:
      This drawable.
      See Also:

    • clearMutated

      public void clearMutated()
      Description copied from class: Drawable
      Clears the mutated state, allowing this drawable to be cached and mutated again.
      Overrides:
      clearMutated in class Drawable

    • onLayoutDirectionChanged

      public boolean onLayoutDirectionChanged(int layoutDirection)
      Description copied from class: Drawable
      Called when the drawable's resolved layout direction changes.
      Overrides:
      onLayoutDirectionChanged in class Drawable
      Parameters:
      layoutDirection - the new resolved layout direction
      Returns:
      true if the layout direction change has caused the appearance of the drawable to change such that it needs to be re-drawn, false otherwise
      See Also: