senselogic.sitevision.api.resource

Interface ColorUtil

@Requireable(value="ColorUtil")
public interface ColorUtil

Utility interface for Colors.

An instance of the Sitevision class implementing this interface can be obtained via Utils.getColorUtil(). See Utils for how to obtain an instance of the Utils interface.

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
Node	getColorByHtmlHexValue(String aHexString) Gets the color with a given html hex value (i.e. a '#' followed by 6 characters [0-9,a-f,A-F]).
Node	getColorByHtmlHexValue(String aHexString, Node aDefaultValue) Gets the color with a given html hex value (i.e. a '#' followed by 6 characters [0-9,a-f,A-F]) with a fallback value if no color matches.
Node	getColorByName(String aColorName) Gets the color with a given name
Node	getColorByName(String aColorName, Node aDefaultValue) Gets the color with a given name with a fallback value if no color matches

Method Detail

getColorByName

Node getColorByName(String aColorName)

Gets the color with a given name

Parameters:

aColorName - the name of the font

Returns:

the first color with name aColorName, or null if no color matches

getColorByName

Node getColorByName(String aColorName,
                    Node aDefaultValue)

Gets the color with a given name with a fallback value if no color matches

Parameters:

aColorName - the name of the font

aDefaultValue - fallback value

Returns:

the first color with name aColorName, or aDefaultValue if no color matches

getColorByHtmlHexValue

Node getColorByHtmlHexValue(String aHexString)

Gets the color with a given html hex value (i.e. a '#' followed by 6 characters [0-9,a-f,A-F]).

Parameters:

aHexString - the hex string value of the font (starts with a '#' and ends with 6 characters [0-9,a-f,A-F])

Returns:

the first color with the corresponding hex string, or null if no color matches

getColorByHtmlHexValue

Node getColorByHtmlHexValue(String aHexString,
                            Node aDefaultValue)

Gets the color with a given html hex value (i.e. a '#' followed by 6 characters [0-9,a-f,A-F]) with a fallback value if no color matches.

Parameters:

aHexString - the hex string value of the font (starts with a '#' and ends with 6 characters [0-9,a-f,A-F])

aDefaultValue - fallback value

Returns:

the first color with the corresponding hex string, or aDefaultValue if no color matches