Class DynamicCardView

All Implemented Interfaces:
Drawable.Callback, AccessibilityEventSource, KeyEvent.Callback, ViewManager, ViewParent, BaseWidget, DynamicCornerWidget<Float>, DynamicFloatingWidget, DynamicSurfaceWidget, DynamicWidget
Direct Known Subclasses:
DynamicPopupBackground

A CardView to apply DynamicTheme according to the supplied parameters.
  • Field Details

    • mColorType

      protected int mColorType
      Color type applied to this view.
      See Also:
    • mContrastWithColorType

      protected int mContrastWithColorType
      Background color type for this view so that it will remain in contrast with this color type.
    • mColor

      @ColorInt protected int mColor
      Color applied to this view.
    • mAppliedColor

      @ColorInt protected int mAppliedColor
      Color applied to this view after considering the background aware properties.
    • mContrastWithColor

      @ColorInt protected int mContrastWithColor
      Background color for this view so that it will remain in contrast with this color.
    • mBackgroundAware

      protected int mBackgroundAware
      The background aware functionality to change this view color according to the background. It was introduced to provide better legibility for colored views and to avoid dark view on dark background like situations.

      If this is enabled then, it will check for the contrast color and do color calculations according to that color so that this text view will always be visible on that background. If no contrast color is found then, it will take the default background color.

      See Also:
    • mContrast

      protected int mContrast
      Minimum contrast value to generate contrast color for the background aware functionality.
    • mForceElevation

      protected boolean mForceElevation
      true to force elevation for this widget.

      When disabled, widget will follow the dynamic theme elevation.

    • mFloatingView

      protected boolean mFloatingView
      true if this view is floating.

      It will be useful to provide the stroke for popup and dialogs.

    • mElevation

      protected float mElevation
      Intended elevation for this view without considering the background.
  • Constructor Details

  • Method Details

    • loadFromAttributes

      public void loadFromAttributes(@Nullable AttributeSet attrs)
      Description copied from interface: BaseWidget
      Load values from the supplied attribute set.
      Specified by:
      loadFromAttributes in interface BaseWidget
      Parameters:
      attrs - The supplied attribute set to load the values.
    • initialize

      public void initialize()
      Description copied from interface: BaseWidget
      Initialize this widget by setting color type. If it is background aware then, background color will also taken into account while setting the color filter.
      Specified by:
      initialize in interface BaseWidget
      See Also:
    • getColorType

      public int getColorType()
      Description copied from interface: DynamicWidget
      Returns the color type applied to this widget.
      Specified by:
      getColorType in interface DynamicWidget
      Returns:
      The color type applied to this widget.
      See Also:
    • setColorType

      public void setColorType(int colorType)
      Description copied from interface: DynamicWidget
      Set the color type to this widget.
      Specified by:
      setColorType in interface DynamicWidget
      Parameters:
      colorType - The color type for this widget.
      See Also:
    • getContrastWithColorType

      public int getContrastWithColorType()
      Description copied from interface: DynamicWidget
      Returns the contrast with color type applied to this widget.
      Specified by:
      getContrastWithColorType in interface DynamicWidget
      Returns:
      The contrast with color type applied to this widget.
      See Also:
    • setContrastWithColorType

      public void setContrastWithColorType(int contrastWithColorType)
      Description copied from interface: DynamicWidget
      Set the contrast with color type to this widget.
      Specified by:
      setContrastWithColorType in interface DynamicWidget
      Parameters:
      contrastWithColorType - The contrast with color type for this widget.
      See Also:
    • getColor

      @ColorInt public int getColor(boolean resolve)
      Description copied from interface: DynamicWidget
      Returns the value of color applied to this widget.
      Specified by:
      getColor in interface DynamicWidget
      Parameters:
      resolve - true to resolve the applied color.
      Returns:
      The value of color applied to this widget.
    • getColor

      @ColorInt public int getColor()
      Description copied from interface: DynamicWidget
      Returns the value of color applied to this widget.
      Specified by:
      getColor in interface DynamicWidget
      Returns:
      The value of color applied to this widget.
    • setColor

      public void setColor(@ColorInt int color)
      Description copied from interface: DynamicWidget
      Set the value of color for this widget.
      Specified by:
      setColor in interface DynamicWidget
      Parameters:
      color - Color for this widget.
    • getContrastWithColor

      @ColorInt public int getContrastWithColor()
      Description copied from interface: DynamicWidget
      Returns the value of contrast with color applied to this widget.
      Specified by:
      getContrastWithColor in interface DynamicWidget
      Returns:
      The value of contrast with color applied to this widget.
    • setContrastWithColor

      public void setContrastWithColor(@ColorInt int contrastWithColor)
      Description copied from interface: DynamicWidget
      Set the value of contrast with color for this widget.
      Specified by:
      setContrastWithColor in interface DynamicWidget
      Parameters:
      contrastWithColor - Contrast with color for this widget.
    • getBackgroundAware

      public int getBackgroundAware()
      Description copied from interface: DynamicWidget
      Returns the background aware functionality used by this widget.
      Specified by:
      getBackgroundAware in interface DynamicWidget
      Returns:
      The background aware functionality used by this widget.
    • isBackgroundAware

      public boolean isBackgroundAware()
      Description copied from interface: DynamicWidget
      Checks whether the background aware functionality is enabled.
      Specified by:
      isBackgroundAware in interface DynamicWidget
      Returns:
      true if this widget changes color according to the background.
    • setBackgroundAware

      public void setBackgroundAware(int backgroundAware)
      Description copied from interface: DynamicWidget
      Set the value to make this widget background aware or not.
      Specified by:
      setBackgroundAware in interface DynamicWidget
      Parameters:
      backgroundAware - The background aware functionality to be set.
    • getContrast

      public int getContrast(boolean resolve)
      Description copied from interface: DynamicWidget
      Get the contrast value used by this widget.
      Specified by:
      getContrast in interface DynamicWidget
      Parameters:
      resolve - true to resolve auto contrast.
      Returns:
      The contrast value used by this widget.
    • getContrast

      public int getContrast()
      Description copied from interface: DynamicWidget
      Get the contrast value used by this widget.
      Specified by:
      getContrast in interface DynamicWidget
      Returns:
      The contrast value used by this widget.
    • getContrastRatio

      public float getContrastRatio()
      Description copied from interface: DynamicWidget
      Returns the contrast ratio for by this widget.
      Specified by:
      getContrastRatio in interface DynamicWidget
      Returns:
      The contrast ratio for by this widget.
    • setContrast

      public void setContrast(int contrast)
      Description copied from interface: DynamicWidget
      Set the contrast value used for this widget.
      Specified by:
      setContrast in interface DynamicWidget
      Parameters:
      contrast - The contrast value to be set.
    • setBackgroundColor

      public void setBackgroundColor(@ColorInt int color)
      Overrides:
      setBackgroundColor in class View
    • onSizeChanged

      protected void onSizeChanged(int w, int h, int oldw, int oldh)
      Overrides:
      onSizeChanged in class View
    • getCorner

      @NonNull public Float getCorner()
      Description copied from interface: DynamicCornerWidget
      Returns the corner radius used by this widget.
      Specified by:
      getCorner in interface DynamicCornerWidget<Float>
      Returns:
      The corner radius used by this widget.
    • setCorner

      public void setCorner(@NonNull Float cornerSize)
      Description copied from interface: DynamicCornerWidget
      Set the corner radius for this widget.
      Specified by:
      setCorner in interface DynamicCornerWidget<Float>
      Parameters:
      cornerSize - The corner radius to be set.
    • setCardBackgroundColor

      public void setCardBackgroundColor(@ColorInt int color)
      Overrides:
      setCardBackgroundColor in class CardView
    • setColor

      public void setColor()
      Description copied from interface: DynamicWidget
      Set color for this widget according to the supplied values.
      Specified by:
      setColor in interface DynamicWidget
    • setCardElevation

      public void setCardElevation(float elevation)
      Overrides:
      setCardElevation in class CardView
    • isForceElevation

      public boolean isForceElevation()
      Description copied from interface: DynamicSurfaceWidget
      Returns whether to force elevation for this widget.
      Specified by:
      isForceElevation in interface DynamicSurfaceWidget
      Returns:
      true to force elevation for this widget.
    • setForceElevation

      public void setForceElevation(boolean forceElevation)
      Description copied from interface: DynamicSurfaceWidget
      Sets whether to force elevation for this widget.
      Specified by:
      setForceElevation in interface DynamicSurfaceWidget
      Parameters:
      forceElevation - true to force elevation.
    • isFloatingView

      public boolean isFloatingView()
      Description copied from interface: DynamicFloatingWidget
      Returns whether this widget a floating view.
      Specified by:
      isFloatingView in interface DynamicFloatingWidget
      Returns:
      true if this view is a floating view.
    • setFloatingView

      public void setFloatingView(boolean floatingView)
      Description copied from interface: DynamicFloatingWidget
      Set the floating view option for this widget.
      Specified by:
      setFloatingView in interface DynamicFloatingWidget
      Parameters:
      floatingView - true to enable floating view.
    • setSurface

      public void setSurface()
      Description copied from interface: DynamicSurfaceWidget
      Set surface for this widget according to the supplied values.
      Specified by:
      setSurface in interface DynamicSurfaceWidget
    • isBackgroundSurface

      public boolean isBackgroundSurface()
      Description copied from interface: DynamicSurfaceWidget
      Checks whether the background should be used as the surface.
      Specified by:
      isBackgroundSurface in interface DynamicSurfaceWidget
      Returns:
      true if the background should be used as surface.
    • isStrokeRequired

      public boolean isStrokeRequired()
      Description copied from interface: DynamicSurfaceWidget
      Checks whether the stroke is required for the surface card view.
      Specified by:
      isStrokeRequired in interface DynamicSurfaceWidget
      Returns:
      true if the stroke is required for this surface card view.
      See Also: