Class ShiftColorScheme

    • Constructor Detail

      • ShiftColorScheme

        public ShiftColorScheme​(SubstanceColorScheme origScheme,
                                Color shiftColor,
                                double shiftFactor)
        Creates a new shifted color scheme.
        Parameters:
        origScheme - The original color scheme.
        shiftColor - Shift color for the colors.
        shiftFactor - Shift factor for the colors. Should be in 0.0-1.0 range.
      • ShiftColorScheme

        public ShiftColorScheme​(SubstanceColorScheme origScheme,
                                Color backgroundShiftColor,
                                double backgroundShiftFactor,
                                Color foregroundShiftColor,
                                double foregroundShiftFactor,
                                boolean shiftByBrightness)
        Creates a new shifted color scheme.
        Parameters:
        origScheme - The original color scheme.
        backgroundShiftColor - Shift color for the background colors.
        backgroundShiftFactor - Shift factor for the background colors. Should be in 0.0-1.0 range.
        foregroundShiftColor - Shift color for the foreground colors.
        foregroundShiftFactor - Shift factor for the foreground colors. Should be in 0.0-1.0 range.
        shiftByBrightness - If true, the shift will account for the brightness of the original color scheme colors.
    • Method Detail

      • getForegroundColor

        public Color getForegroundColor()
        Description copied from interface: SchemeBaseColors
        Retrieves the foreground color.
        Returns:
        Foreground color.
      • getUltraLightColor

        public Color getUltraLightColor()
        Description copied from interface: SchemeBaseColors
        Retrieves the ultra-light color.
        Returns:
        Ultra-light color.
      • getExtraLightColor

        public Color getExtraLightColor()
        Description copied from interface: SchemeBaseColors
        Retrieves the extra color.
        Returns:
        Extra color.
      • getLightColor

        public Color getLightColor()
        Description copied from interface: SchemeBaseColors
        Retrieves the light color.
        Returns:
        Light color.
      • getMidColor

        public Color getMidColor()
        Description copied from interface: SchemeBaseColors
        Retrieves the medium color.
        Returns:
        Medium color.
      • getDarkColor

        public Color getDarkColor()
        Description copied from interface: SchemeBaseColors
        Retrieves the dark color.
        Returns:
        Dark color.
      • getUltraDarkColor

        public Color getUltraDarkColor()
        Description copied from interface: SchemeBaseColors
        Retrieves the ultra-dark color.
        Returns:
        Ultra-dark color.
      • getOrigScheme

        public SubstanceColorScheme getOrigScheme()
        Returns the original color scheme.
        Returns:
        The original color scheme.
      • getShiftFactor

        public double getShiftFactor()
        Returns the shift factor.
        Returns:
        Shift factor.
      • getShiftedScheme

        public static SubstanceColorScheme getShiftedScheme​(SubstanceColorScheme orig,
                                                            Color backgroundShiftColor,
                                                            double backgroundShiftFactor,
                                                            Color foregroundShiftColor,
                                                            double foregroundShiftFactor)
        Returns a shifted color scheme. This method is for internal use only.
        Parameters:
        orig - The original color scheme.
        backgroundShiftColor - Shift color for the background color scheme colors. May be null - in this case, the background color scheme colors will not be shifted.
        backgroundShiftFactor - Shift factor for the background color scheme colors. If the shift color for the background color scheme colors is null, this value is ignored.
        foregroundShiftColor - Shift color for the foreground color scheme colors. May be null - in this case, the foreground color scheme colors will not be shifted.
        foregroundShiftFactor - Shift factor for the foreground color scheme colors. If the shift color for the foreground color scheme colors is null, this value is ignored.
        Returns:
        Shifted scheme.