Module com.aoapps.web.resources.registry

Package com.aoapps.web.resources.registry

Class Style

java.lang.Object

com.aoapps.web.resources.registry.Resource<Style>

com.aoapps.web.resources.registry.Style

All Implemented Interfaces:

Serializable, Comparable<Style>

public final class Style
extends Resource<Style>
implements Comparable<Style>

A CSS stylesheet is identified by URI, but has other constraints. Including:

1. an optional media condition
2. an optional crossorigin attribute
3. a disabled attribute

Optimizers should be careful to only group styles that have equivalent constraints.

TODO: Support a "group" (or "position" / "category"?): prelude, main, and coda. "prelude" is before all others (except possibly other prelude). "main" (the default) is the middle. "coda" is after all others (except possibly other coda). It would be an error if the topological sort results in prelude that is not first or coda that is not last. Use "prelude" for "html5.css".

TODO: Support inline styles without URI.

Author:

AO Industries, Inc.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Style.Builder	Builder pattern for Style.
static enum	Style.Direction	The direction of a Style.

Field Summary

Fields

Modifier and Type	Field	Description
static final Comparator<Style>	COMPARATOR	Styles start with a default ordering that should minimize the number of explicit ordering declarations: TODO: Review that this is the best default ordering.

Constructor Summary

Constructors

Constructor	Description
Style(String href)	Creates a new style.
Style(String href, String media, Style.Direction direction, String crossorigin, boolean disabled)	Creates a new style.

Method Summary

Modifier and Type	Method	Description
static Style.Builder	builder()
int	compareTo(Style o)	All concrete implementations of Resource must be comparable to themselves.
boolean	equals(Object obj)	Two resources may be compared to see if they are exactly equal, including all relevant attributes.
String	getCrossorigin()	Gets the optional crossorigin policy.
Style.Direction	getDirection()	Gets the direction for the style.
String	getMedia()	Gets the optional media condition.
int	hashCode()	The hash key must be consistent with Resource.equals(java.lang.Object).
boolean	isDisabled()	Style may be disabled by default, then enabled via JavaScript.
String	toString()

Methods inherited from class com.aoapps.web.resources.registry.Resource

getUri

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

COMPARATOR

public static final Comparator<Style> COMPARATOR

Styles start with a default ordering that should minimize the number of explicit ordering declarations: TODO: Review that this is the best default ordering.

1. Order by media condition, nulls first
2. Order by direction, nulls first
3. Order by URI

Note: The crossorigin policy is not used in ordering.

Note: The disabled flag is not used in ordering.

All string comparisons are performed via SmartComparator.ROOT.

As an example of this ordering, consider the following order would be the default, which we expect will often match the way CSS styles override base definitions:

1. global.css (no media)
2. global-print.css (media="print")

Constructor Details

Style

public Style(String href,
 String media,
 Style.Direction direction,
 String crossorigin,
 boolean disabled)

Creates a new style.

Parameters:

href - See Resource.getUri()

media - See getMedia()

direction - See getDirection()

crossorigin - See getCrossorigin()

disabled - See isDisabled()

Style

public Style(String href)

Creates a new style.

Parameters:

href - See Resource.getUri()

Method Details

builder

public static Style.Builder builder()

toString

public String toString()

Overrides:

toString in class Resource<Style>

See Also:

• Resource.toString()
• getMedia()
• getDirection()
• getCrossorigin()
• isDisabled()

equals

public boolean equals(Object obj)

Description copied from class: Resource

Two resources may be compared to see if they are exactly equal, including all relevant attributes.

Specified by:

equals in class Resource<Style>

hashCode

public int hashCode()

Description copied from class: Resource

The hash key must be consistent with Resource.equals(java.lang.Object).

Specified by:

hashCode in class Resource<Style>

compareTo

public int compareTo(Style o)

All concrete implementations of Resource must be comparable to themselves.

This default implementation compares by URI only via SmartComparator.ROOT.

Specified by:

compareTo in interface Comparable<Style>

Overrides:

compareTo in class Resource<Style>

See Also:

• COMPARATOR

getMedia

public String getMedia()

Gets the optional media condition.

getDirection

public Style.Direction getDirection()

Gets the direction for the style. This is matched against the current response language/locale, when know, to selectively include the style.

getCrossorigin

public String getCrossorigin()

Gets the optional crossorigin policy.

isDisabled

public boolean isDisabled()

Style may be disabled by default, then enabled via JavaScript.