Package dev.prozilla.pine.common.property.style

Class StyledProperty<T,P extends Property<T>,A extends AdaptiveProperty<T,P>,R extends TransitionedProperty<T>>

java.lang.Object

dev.prozilla.pine.common.property.style.StyledProperty<T,P,A,R>

All Implemented Interfaces:

Animatable, Printable, Property<T>, Functor<T>

Direct Known Subclasses:

StyledIntProperty, StyledObjectProperty

public abstract class StyledProperty<T,P extends Property<T>,A extends AdaptiveProperty<T,P>,R extends TransitionedProperty<T>>
extends Object
implements Property<T>, Animatable, Printable

A property used to style nodes based on a set of rules.

If a transition rule applies to this property, it will start a transition whenever its value changes.

Field Summary

Fields

Modifier and Type	Field	Description
protected A	adaptiveProperty
protected final StyledPropertyKey<T>	name
protected final Node	node
protected final List<StyleRule<T>>	rules
protected final List<StyleRule<AnimationCurve>>	transitionRules

Constructor Summary

Constructors

Constructor	Description
StyledProperty(StyledPropertyKey<T> name, Node node, List<StyleRule<T>> rules, A defaultValue)	Creates a styled property without any transitions.
StyledProperty(StyledPropertyKey<T> name, Node node, List<StyleRule<T>> rules, A defaultValue, List<StyleRule<AnimationCurve>> transitionRules)	Creates a styled property with transitions.

Method Summary

Modifier and Type	Method	Description
void	addRule(StyleRule<T> rule)
void	addTransitionRule(StyleRule<AnimationCurve> transitionRule)
protected void	applyRules()
protected void	applyTransitionRules()
protected abstract A	createAdaptiveProperty(Property<T> property)
protected abstract A	createAdaptiveProperty(T value)
protected abstract R	createTransitionedProperty(T initialValue, AnimationCurve curve)
protected <U> StyleRule<U>	getBestMatch(List<StyleRule<U>> rules)
T	getValue()	Returns the value of this property.
void	invalidate()
void	restartAnimation()	Restarts the animation from the beginning.
protected void	setAdaptiveProperty(A adaptiveProperty)
boolean	supportsTransitions()
@NotNull String	toString()	Returns a string representation of this object.
void	updateAnimation(float deltaTime)	Progresses the animation in time.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.prozilla.pine.common.Printable

print, print

Methods inherited from interface dev.prozilla.pine.common.property.Property

getValueOr, hasValue, hasValueProperty, isNotNull, isNotNullProperty, isNull, map, replaceNull, requireValue, snapshot, toStringProperty

Field Details

name

protected final StyledPropertyKey<T> name

node

protected final Node node

rules

protected final List<StyleRule<T>> rules

adaptiveProperty

protected A extends AdaptiveProperty<T,P> adaptiveProperty

transitionRules

protected final List<StyleRule<AnimationCurve>> transitionRules

Constructor Details

StyledProperty

public StyledProperty(StyledPropertyKey<T> name,
 Node node,
 List<StyleRule<T>> rules,
 A defaultValue)

Creates a styled property without any transitions.

Parameters:

node - The node this property belongs to

rules - The rules that determine the value of this property

defaultValue - The initial value of this property. Also used when no rule is applied.

StyledProperty

public StyledProperty(StyledPropertyKey<T> name,
 Node node,
 List<StyleRule<T>> rules,
 A defaultValue,
 List<StyleRule<AnimationCurve>> transitionRules)

Creates a styled property with transitions.

Parameters:

node - The node this property belongs to

rules - The rules that determine the value of this property

defaultValue - The initial value of this property. Also used when no rule is applied.

transitionRules - The rules that determine how the value of this property transitions when changed

Method Details

addRule

public void addRule(StyleRule<T> rule)

invalidate

public void invalidate()

applyRules

protected void applyRules()

addTransitionRule

public void addTransitionRule(StyleRule<AnimationCurve> transitionRule)

applyTransitionRules

protected void applyTransitionRules()

createAdaptiveProperty

protected abstract A createAdaptiveProperty(T value)

createAdaptiveProperty

protected abstract A createAdaptiveProperty(Property<T> property)

createTransitionedProperty

protected abstract R createTransitionedProperty(T initialValue,
 AnimationCurve curve)

supportsTransitions

public boolean supportsTransitions()

getBestMatch

protected <U> StyleRule<U> getBestMatch(List<StyleRule<U>> rules)

setAdaptiveProperty

protected void setAdaptiveProperty(A adaptiveProperty)

restartAnimation

public void restartAnimation()

Description copied from interface: Animatable

Restarts the animation from the beginning.

Specified by:

restartAnimation in interface Animatable

updateAnimation

public void updateAnimation(float deltaTime)

Description copied from interface: Animatable

Progresses the animation in time.

Specified by:

updateAnimation in interface Animatable

Parameters:

deltaTime - Time between this frame and the last one, in seconds.

getValue

public T getValue()

Description copied from interface: Property

Returns the value of this property.

Specified by:

getValue in interface Property<T>

Returns:

The value of this property.

toString

@NotNull
public @NotNull String toString()

Description copied from interface: Printable

Returns a string representation of this object.

Specified by:

toString in interface Printable

Overrides:

toString in class Object

Returns:

String representation of this object.