Package com.google.gwt.safecss.shared

Class SafeStylesHostedModeUtils

java.lang.Object

com.google.gwt.safecss.shared.SafeStylesHostedModeUtils

public class SafeStylesHostedModeUtils
extends Object

SafeStyles utilities whose implementation differs between Development and Production Mode.

This class has a super-source peer that provides the Production Mode implementation.

Do not use this class - it is used for implementation only, and its methods may change in the future.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FORCE_CHECK_VALID_STYLES	Name of system property that if set, enables checks in server-side code (even if assertions are disabled).

Constructor Summary

Constructors

Constructor	Description
SafeStylesHostedModeUtils()

Method Summary

Modifier and Type	Method	Description
static String	isValidStyleName(String name)	Check if the specified style property name is valid.
static String	isValidStyleValue(String value)	Check if the specified style property value is valid.
static void	maybeCheckValidStyleName(String name)	Checks if the provided string is a valid style property name.
static void	maybeCheckValidStyleValue(String value)	Checks if the provided string is a valid style property value.
static void	setForceCheckValidStyle(boolean check)	Sets a global flag that controls whether or not maybeCheckValidStyleName(String) and maybeCheckValidStyleValue(String) should perform their checks in a server-side environment.
(package private) static void	setForceCheckValidStyleFromProperty()	Sets a global flag that controls whether or not maybeCheckValidStyleName(String) and maybeCheckValidStyleValue(String) should perform their checks in a server-side environment from the value of the "com.google.gwt.safecss.ForceCheckValidStyles" property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FORCE_CHECK_VALID_STYLES

public static final String FORCE_CHECK_VALID_STYLES

Name of system property that if set, enables checks in server-side code (even if assertions are disabled).

See Also:

• Constant Field Values

Constructor Details

SafeStylesHostedModeUtils

public SafeStylesHostedModeUtils()

Method Details

isValidStyleName

public static String isValidStyleName(String name)

Check if the specified style property name is valid.

NOTE: This method does NOT guarantee the safety of a style name. It looks for common errors, but does not check for every possible error. It is intended to help validate a string that the user has already asserted is safe.

Parameters:

name - the name to check

Returns:

null if valid, an error string if not

See Also:

• CSS 2.1 identifiers

isValidStyleValue

public static String isValidStyleValue(String value)

Check if the specified style property value is valid.

NOTE: This method does NOT guarantee the safety of a style value. It looks for common errors, but does not check for every possible error. It is intended to help validate a string that the user has already asserted is safe.

Parameters:

value - the value to check

Returns:

null if valid, an error string if not

See Also:

• CSS 2.1 declarations and properties

maybeCheckValidStyleName

public static void maybeCheckValidStyleName(String name)

Checks if the provided string is a valid style property name.

Parameters:

name - the style name

See Also:

• CSS 2.1 identifiers

maybeCheckValidStyleValue

public static void maybeCheckValidStyleValue(String value)

Checks if the provided string is a valid style property value.

Parameters:

value - the style value

See Also:

• CSS 2.1 declarations and properties

setForceCheckValidStyle

public static void setForceCheckValidStyle(boolean check)

Sets a global flag that controls whether or not maybeCheckValidStyleName(String) and maybeCheckValidStyleValue(String) should perform their checks in a server-side environment.

Parameters:

check - if true, perform server-side checks.

setForceCheckValidStyleFromProperty

static void setForceCheckValidStyleFromProperty()

Sets a global flag that controls whether or not maybeCheckValidStyleName(String) and maybeCheckValidStyleValue(String) should perform their checks in a server-side environment from the value of the "com.google.gwt.safecss.ForceCheckValidStyles" property.