de.saxsys.svgfx.css.core

Class CssBase<TParent extends CssBase>

java.lang.Object

de.saxsys.svgfx.css.core.CssBase<TParent>

Type Parameters:

TParent - type of the parent Created by Xyanid on 29.10.2015.

Direct Known Subclasses:

CssStyle, CssStyleDeclaration, CssValue

public abstract class CssBase<TParent extends CssBase>
extends Object

This class represents the base class for all CssElements, it provides field to hold the cssText as well as parent. It also contains an indication field which will be set internally when the cssElement is modified, thus the next time the cssText is requested it will be updated using the createCssText() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CssBase.CharacterState Determines in which state a character read from a css text is.

Constructor Summary

Constructors

Constructor and Description
CssBase() Creates a new instance.
CssBase(boolean isModifiable) Creates a new instance of the class.
CssBase(TParent parent) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
abstract void	consumeCssText(String cssText) Will be called when the given cssText should be consumed by this element.
abstract String	createCssText() Creates the cssText for this element, this should be based upon the current status of the element.
protected javafx.util.Pair<Boolean,Boolean>	filterCommentAndString(String data, Function<Character,Boolean> commentConsumer, Function<Character,Boolean> insideConsumer, Function<Character,Boolean> outsideConsumer) Filters out comments and allows to react differently to characters which are read within a string and outside a string.
String	getCssText() Gets the cssText.
boolean	getIsModifiable() Returns the isModifiable of this element.
TParent	getParent() Returns the parent or this element.
void	setCssText(String cssText) Sets the cssText.
void	setNeedsUpdateCssText(boolean needsUpdateCssText) Sets the needsUpdateCssText of this element.

Methods inherited from class java.lang.Object

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

Constructor Detail

CssBase

public CssBase(TParent parent)

Creates a new instance.

Parameters:

parent - set the parent of this element.

CssBase

public CssBase(boolean isModifiable)

Creates a new instance of the class.

Parameters:

isModifiable - determines if the element is modifiable or not

CssBase

public CssBase()

Creates a new instance.

Method Detail

getParent

public final TParent getParent()

Returns the parent or this element.

Returns:

the parent of this element.

getIsModifiable

public final boolean getIsModifiable()

Returns the isModifiable of this element.

Returns:

the isModifiable of this element

getCssText

public String getCssText()

Gets the cssText.

Returns:

the cssText

setCssText

public final void setCssText(String cssText)
                      throws DOMException

Sets the cssText.

Parameters:

cssText - the cssText which will be set

Throws:

DOMException - will be thrown when en error occurs

setNeedsUpdateCssText

public final void setNeedsUpdateCssText(boolean needsUpdateCssText)

Sets the needsUpdateCssText of this element.

Parameters:

needsUpdateCssText - the value for needsUpdateCssText of this element

filterCommentAndString

protected javafx.util.Pair<Boolean,Boolean> filterCommentAndString(String data,
                                                                   Function<Character,Boolean> commentConsumer,
                                                                   Function<Character,Boolean> insideConsumer,
                                                                   Function<Character,Boolean> outsideConsumer)
                                                            throws DOMException

Filters out comments and allows to react differently to characters which are read within a string and outside a string.

Parameters:

data - data to be read

commentConsumer - function to be called when a comment character is read, if this function returns true the iteration is stopped, can be null

insideConsumer - function to be called when a character inside a string is to be consumed, if this function returns true the iteration is stopped, must not be null

outsideConsumer - function to be called when a character outside a string is to be consumed, if this function returns true the iteration is stopped, must not be null

Returns:

a Pair contains at its first position if we exited while being in a comment and at its second position if we exited while being in a string

Throws:

DOMException - when a comment or string is not properly closed, this is only true if the string was read until the end and not exited by one of the consumers

consumeCssText

public abstract void consumeCssText(String cssText)
                             throws DOMException

Will be called when the given cssText should be consumed by this element.

Parameters:

cssText - the cssText to be consumed

Throws:

DOMException - if an error during consumption occurs

createCssText

public abstract String createCssText()

Creates the cssText for this element, this should be based upon the current status of the element.

Returns:

the cssText for this element.