de.saxsys.styleablefx.core

Class StyleableAdditionBase

java.lang.Object

de.saxsys.styleablefx.core.StyleableAdditionBase

Direct Known Subclasses:

SVGStyleableAddition

public abstract class StyleableAdditionBase
extends Object

The idea of this class is simply to allow both Regions and Controls to share a base class which responsible to style a Node, so there is no need to have the same code twice. Usually an instance of this class will be created within the Skin or Region it should be used by. Then the region calls the getClassCssMetaData()s, which will provide the list of CssMetaData that can be styled for this class.

Author:

Xyanid on 08.11.2015.

Constructor Summary

Constructors

Constructor and Description
StyleableAdditionBase()

Method Summary

Modifier and Type	Method and Description
static List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>>	getClassCssMetaData() This methods need to be provided in any class extending a StyleableAdditionBase.
static <TStyleableAddition extends StyleableAdditionBase> TStyleableAddition	getStyleableAddition(javafx.css.Styleable styleable, Class<TStyleableAddition> clazz) Returns the StyleableAdditionBase from the given Styleable using the given clazz.

Methods inherited from class java.lang.Object

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

Constructor Detail

StyleableAdditionBase

public StyleableAdditionBase()

Method Detail

getStyleableAddition

public static <TStyleableAddition extends StyleableAdditionBase> TStyleableAddition getStyleableAddition(javafx.css.Styleable styleable,
                                                                                                         Class<TStyleableAddition> clazz)

Returns the StyleableAdditionBase from the given Styleable using the given clazz. This method is supposed to be used inside a CssMetaData of a StyleableAdditionBase and ensured that the StyleableAdditionBase is found on the Styleable which used the StyleableAdditionBase. The way this method works is that it checks if the passed Styleable is a IStyleableAdditionProvider, if so the desired StyleableAdditionBase is requested from the IStyleableAdditionProvider. If the StyleableAdditionBase was not found this way, it is possible that the Styleable is a Control. In this case the Skin is checked the same way.

Type Parameters:

TStyleableAddition - type of the styleable addition.

Parameters:

styleable - Styleable to use.

clazz - class to use.

Returns:

the StyleableAdditionBase from the Styleable.

Throws:

IllegalArgumentException - if either Styleable or Class is null or the desired StyleableAdditionBase was not found on the Styleable.

getClassCssMetaData

public static List<javafx.css.CssMetaData<? extends javafx.css.Styleable,?>> getClassCssMetaData()

This methods need to be provided in any class extending a StyleableAdditionBase. The sole purpose of the method in the StyleableAdditionBase is to provide an recommendation for the name to use, as such this method will only return an empty ArrayList.

Returns:

an empty ArrayList.