cz.vutbr.web.css

Interface NodeData

All Known Implementing Classes:

BaseNodeDataImpl, QuadrupleMapNodeData, SingleMapNodeData

public interface NodeData

Wrap of CSS properties defined for element. Enumeration values follows this syntax:

• UPPERCASE terminal symbols, direct values present in stylesheet, such as background-color: transparent;
• lowercase non-terminal symbols, just information that concrete value is stored somewhere else

Author:

kapy, burgetr

Method Summary

Modifier and Type	Method and Description
NodeData	concretize() Replaces all inherit, initial and unset CSS properties with the inherited values or default values of user agent.
String	getAsString(String name, boolean includeInherited) Returns a string representation of the property value.
<T extends CSSProperty> T	getProperty(String name) Returns property of given name and supposed type.
<T extends CSSProperty> T	getProperty(String name, boolean includeInherited) Returns property of given name and supposed type.
Collection<String>	getPropertyNames() Returns the names of all the that are available in the current node.
Declaration	getSourceDeclaration(String name) Obtains the source declaration used for the given property.
Declaration	getSourceDeclaration(String name, boolean includeInherited) Obtains the source declaration used for the given property.
<T extends CSSProperty> T	getSpecifiedProperty(String name) Returns the property of the given name after applying the defaulting processes.
<T extends Term<?>> T	getSpecifiedValue(Class<T> clazz, String name) Returns the specified value of a property which corresponds to the cascaded value (obtained by getValue(String, boolean)) with applying the defaulting processes.
Term<?>	getSpecifiedValue(String name) Returns the specified value of a property which corresponds to the cascaded value (obtained by getValue(String, boolean)) with applying the defaulting processes.
<T extends Term<?>> T	getValue(Class<T> clazz, String name) Returns the cascaded value of property of given name and supposed type.
<T extends Term<?>> T	getValue(Class<T> clazz, String name, boolean includeInherited) Returns the cascaded value of property of given name and supposed type.
Term<?>	getValue(String name, boolean includeInherited) Returns the cascaded value of property of given name.
NodeData	inheritFrom(NodeData parent) Accepts values from parent as its own.
NodeData	push(Declaration d) Adds data stored in declaration into current instance

Method Detail

getProperty

<T extends CSSProperty> T getProperty(String name)

Returns property of given name and supposed type. Inherited properties are included.

Type Parameters:

T - Type of property returned. Let compiler infer returning type from left part of statement, otherwise return just CSSProperty

Parameters:

name - Name of property

Returns:

Value of property of type T or null

getProperty

<T extends CSSProperty> T getProperty(String name,
                                      boolean includeInherited)

Returns property of given name and supposed type. Inherited properties can be avoided

Type Parameters:

T - Type of property returned. Let compiler infer returning type from left part of statement, otherwise return just CSSProperty

Parameters:

name - Name of property

includeInherited - Whether to include inherited properties or not

Returns:

Value of property of type T or null

getSpecifiedProperty

<T extends CSSProperty> T getSpecifiedProperty(String name)

Returns the property of the given name after applying the defaulting processes.

Parameters:

name - Property name

Returns:

The specified value of the property of the type T or null if the value is not available and no default value is applicable.

getValue

Term<?> getValue(String name,
                 boolean includeInherited)

Returns the cascaded value of property of given name. Inherited values can be avoided.

Parameters:

name - Name of property

includeInherited - Whether to include inherited properties or not

Returns:

Value of property or null

getValue

<T extends Term<?>> T getValue(Class<T> clazz,
                               String name)

Returns the cascaded value of property of given name and supposed type. Inherited values can be avoided.

Type Parameters:

T - Type of value returned

Parameters:

clazz - Class of type

name - Name of property

Returns:

Value of property of type T or null

getValue

<T extends Term<?>> T getValue(Class<T> clazz,
                               String name,
                               boolean includeInherited)

Returns the cascaded value of property of given name and supposed type. Inherited values can be avoided.

Type Parameters:

T - Type of value returned

Parameters:

clazz - Class of type

name - Name of property

includeInherited - Whether to include inherited properties or not

Returns:

Value of property of type T or null

getSpecifiedValue

Term<?> getSpecifiedValue(String name)

Returns the specified value of a property which corresponds to the cascaded value (obtained by getValue(String, boolean)) with applying the defaulting processes.

Parameters:

name - the property name

Returns:

the property value or null when the property value is not defined and no default value is available.

getSpecifiedValue

<T extends Term<?>> T getSpecifiedValue(Class<T> clazz,
                                        String name)

Returns the specified value of a property which corresponds to the cascaded value (obtained by getValue(String, boolean)) with applying the defaulting processes.

Parameters:

clazz - the expected class of the result

name - the property name

Returns:

the property value or null when the property value is not defined and no default value is available.

getAsString

String getAsString(String name,
                   boolean includeInherited)

Returns a string representation of the property value.

Parameters:

name - Property name

includeInherited - Whether to include inherited properties or not

Returns:

The string representation of the assigned property value or null when the property is not defined.

inheritFrom

NodeData inheritFrom(NodeData parent)
              throws ClassCastException

Accepts values from parent as its own. null parent is allowed, than instance is returned unchanged.

Parameters:

parent - Source of inheritance

Returns:

Modified instance

Throws:

ClassCastException - When parent implementation class is not the same

concretize

NodeData concretize()

Replaces all inherit, initial and unset CSS properties with the inherited values or default values of user agent.

Returns:

Modified property

push

NodeData push(Declaration d)

Adds data stored in declaration into current instance

Parameters:

d - Declaration to be added

Returns:

Modified instance

getPropertyNames

Collection<String> getPropertyNames()

Returns the names of all the that are available in the current node.

Returns:

the name of the properties.

getSourceDeclaration

Declaration getSourceDeclaration(String name)

Obtains the source declaration used for the given property. Inherited properties are included.

Parameters:

name - The property name.

Returns:

the source declaration

getSourceDeclaration

Declaration getSourceDeclaration(String name,
                                 boolean includeInherited)

Obtains the source declaration used for the given property.

Parameters:

name - The property name.

includeInherited - whether to include the inherited properties.

Returns:

the source declaration