Class DynamicHorizontalScrollView

java.lang.Object
android.view.View
android.view.ViewGroup
android.widget.FrameLayout
android.widget.HorizontalScrollView
com.pranavpandey.android.dynamic.support.widget.DynamicHorizontalScrollView
All Implemented Interfaces:
Drawable.Callback, AccessibilityEventSource, KeyEvent.Callback, ViewManager, ViewParent, BaseWidget, DynamicScrollableWidget, DynamicWidget, WindowInsetsWidget

public class DynamicHorizontalScrollView extends HorizontalScrollView implements WindowInsetsWidget, DynamicScrollableWidget
A HorizontalScrollView to apply DynamicTheme according to the supplied parameters.
  • Field Details

    • mColorType

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

      protected int mScrollBarColorType
      Scroll bar 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.
    • mScrollBarColor

      @ColorInt protected int mScrollBarColor
      Scroll bar color applied to this view.
    • mAppliedScrollBarColor

      @ColorInt protected int mAppliedScrollBarColor
      Scroll bar 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.
  • 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:
    • applyWindowInsets

      public void applyWindowInsets()
      Description copied from interface: WindowInsetsWidget
      Apply window insets for the widget.
      Specified by:
      applyWindowInsets in interface WindowInsetsWidget
    • 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:
    • getScrollBarColorType

      public int getScrollBarColorType()
      Description copied from interface: DynamicScrollableWidget
      Returns the scroll bar color type applied to this widget.
      Specified by:
      getScrollBarColorType in interface DynamicScrollableWidget
      Returns:
      The scroll bar color type applied to this widget.
      See Also:
    • setScrollBarColorType

      public void setScrollBarColorType(int scrollBarColorType)
      Description copied from interface: DynamicScrollableWidget
      Set the scroll bar color type to this widget.
      Specified by:
      setScrollBarColorType in interface DynamicScrollableWidget
      Parameters:
      scrollBarColorType - Scroll bar 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.
    • getScrollBarColor

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

      @ColorInt public int getScrollBarColor()
      Description copied from interface: DynamicScrollableWidget
      Returns the value of scroll bar color applied to this widget.
      Specified by:
      getScrollBarColor in interface DynamicScrollableWidget
      Returns:
      The value of scroll bar color applied to this widget.
    • setScrollBarColor

      public void setScrollBarColor(@ColorInt int scrollBarColor)
      Description copied from interface: DynamicScrollableWidget
      Set the value of scroll bar color for this widget.
      Specified by:
      setScrollBarColor in interface DynamicScrollableWidget
      Parameters:
      scrollBarColor - Scroll bar 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.
    • onOverScrolled

      protected void onOverScrolled(int scrollX, int scrollY, boolean clampedX, boolean clampedY)
      Overrides:
      onOverScrolled in class HorizontalScrollView
    • 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
    • setScrollBarColor

      public void setScrollBarColor()
      Description copied from interface: DynamicScrollableWidget
      Set scroll bar color for this widget according to the supplied values.
      Specified by:
      setScrollBarColor in interface DynamicScrollableWidget
    • setScrollableWidgetColor

      public void setScrollableWidgetColor(boolean setScrollBarColor)
      Description copied from interface: DynamicScrollableWidget
      Set color and scroll bar color for this widget at once.
      Specified by:
      setScrollableWidgetColor in interface DynamicScrollableWidget
      Parameters:
      setScrollBarColor - true to set the scroll bar color also.