Spec-Zone.ru › OpenJavaFX 17

Класс CssMetaData<S extends Styleable,​V>

java.lang.Object
javafx.css.CssMetaData<S,​V>
Параметры типа:
S - Тип Styleable
V - Тип, в который преобразуется разобранное значение.
Непосредственные подклассы:
FontCssMetaData
public abstract class CssMetaData<S extends Styleable,​V>
extends Object
Объект CssMetaData предоставляет информацию о CSS-стиле и предоставляет механизмы, позволяющие CSS установить значение свойства. Он encapsulates имя CSS-свойства, тип, в который преобразуется значение CSS, и значение свойства по умолчанию.

CssMetaData — это мост между значением, которое можно синтаксически представить в файле .css, и StyleableProperty. Существует взаимно однозначное соответствие между CssMetaData и StyleableProperty. Как правило, CssMetaData узла будет включать CssMetaData его предков. Например, CssMetaData прямоугольника включает CssMetaData фигуры и также узла. Во время обработки CSS движок CSS итерируется по CssMetaData узла, находит разобранное значение каждого property, преобразует разобранное значение и устанавливает значение на StyleableProperty.

Метод Node.getCssMetaData() используется для получения списка List<CssMetaData>. Этот метод часто вызывается, и целесообразно возвращать статический список, а не создавать список при каждом вызове. По соглашению, классы узлов, имеющие CssMetaData, будут реализовывать статический метод getClassCssMetaData(), и обычно getCssMetaData() просто возвращает getClassCssMetaData(). Цель getClassCssMetaData() — позволить подклассам легко включать CssMetaData некоторого предка.

StyleablePropertyFactory значительно упрощает создание StyleableProperty и соответствующего CssMetaData.

Этот пример — типичная реализация.


 private DoubleProperty gapProperty = new StyleableDoubleProperty(0) {
     @Override
      public CssMetaData<MyWidget,Number> getCssMetaData() {
          return GAP_META_DATA;
      }

      @Override
      public Object getBean() {
          return MyWidget.this;
      }

      @Override
      public String getName() {
          return "gap";
      }
 };

 private static final CssMetaData GAP_META_DATA =
     new CssMetaData<MyWidget,Number>("-my-gap", StyleConverter.getSizeConverter(), 0d) {

        @Override
        public boolean isSettable(MyWidget node) {
            return node.gapProperty == null || !node.gapProperty.isBound();
        }

        @Override
        public StyleableProperty<Number> getStyleableProperty(MyWidget node) {
            return (StyleableProperty<Number>)node.gapProperty;
        }
 };

 private static final List<CssMetaData<? extends Node, ?>> cssMetaDataList;
 static {
     List<CssMetaData<? extends Node, ?>> temp =
         new ArrayList<CssMetaData<? extends Node, ?>>(Control.getClassCssMetaData());
     temp.add(GAP_META_DATA);
     cssMetaDataList = Collections.unmodifiableList(temp);
 }

 public static List<CssMetaData<? extends Node, ?>> getClassCssMetaData() {
     return cssMetaDataList;
 }

 @Override
 public List<CssMetaData<? extends Node, ?>> getCssMetaData() {
     return getClassCssMetaData();
 }
 
С:
JavaFX 8.0
См. также:
StyleablePropertyFactory

Краткое описание конструкторов

Конструкторы
Модификатор Конструктор Описание
protected CssMetaData​(String property, StyleConverter<?,​V> converter)
Создает CssMetaData с заданными параметрами, initialValue равен null, inherit установлен в false, и нет дочерних свойств.
protected CssMetaData​(String property, StyleConverter<?,​V> converter, V initialValue)
Создает CssMetaData с заданными параметрами, inherit установлен в false, и нет дочерних свойств.
protected CssMetaData​(String property, StyleConverter<?,​V> converter, V initialValue, boolean inherits)
Создает CssMetaData с заданными параметрами и без дочерних свойств.
protected CssMetaData​(String property, StyleConverter<?,​V> converter, V initialValue, boolean inherits, List<CssMetaData<? extends Styleable,​?>> subProperties)
Создает CssMetaData с заданными параметрами и без дочерних свойств.

Краткое описание методов

Модификатор и тип Метод Описание
boolean equals​(Object obj)
Два объекта CssMetaData считаются равными, если их значения property равны.
StyleConverter<?,​V> getConverter()
Получает конвертер CSS, который обрабатывает преобразование значения CSS в Java-объект.
V getInitialValue​(S styleable)
Начальное значение CssMetaData соответствует значению по умолчанию StyleableProperty в коде.
String getProperty()
Получает имя CSS-свойства.
abstract StyleableProperty<V> getStyleableProperty​(S styleable)
Возвращает соответствующее StyleableProperty для данного узла.
List<CssMetaData<? extends Styleable,​?>> getSubProperties()
Подсвойства ссылаются на составляющие свойства этого свойства, если таковые имеются.
boolean isInherits()
Если true, значение этого свойства такое же, как значение родительского вычисленного свойства.
abstract boolean isSettable​(S styleable)
Проверяет, установлено ли соответствующее свойство на заданном узле.
void set​(S styleable, V value, StyleOrigin origin)
Устарело.
Этот метод больше не вызывается из CSS-кода.

Методы, унаследованные от класса java.lang.Object

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

Подробное описание конструкторов

CssMetaData

protected CssMetaData(String property, StyleConverter<?,​V> converter, V initialValue, boolean inherits, List<CssMetaData<? extends Styleable,​?>> subProperties)
Создайте CssMetaData с заданными параметрами и без дочерних свойств.
Параметры:
property - свойство CSS
converter - StyleConverter, используемый для преобразования значения, прочитанного из CSS, в объект Java.
initialValue - Начальное или значение по умолчанию соответствующего StyleableProperty
inherits - true, если это свойство использует наследование CSS
subProperties - дочерние свойства этого свойства. Например, свойство -fx-font имеет дочерние свойства -fx-font-family, -fx-font-size, -fx-font-weight и -fx-font-style.

CssMetaData

protected CssMetaData(String property, StyleConverter<?,​V> converter, V initialValue, boolean inherits)
Создайте CssMetaData с заданными параметрами и без дочерних свойств.
Параметры:
property - свойство CSS
converter - StyleConverter, используемый для преобразования значения, прочитанного из CSS, в объект Java.
initialValue - Начальное или значение по умолчанию соответствующего StyleableProperty
inherits - true, если это свойство использует наследование CSS

CssMetaData

protected CssMetaData(String property, StyleConverter<?,​V> converter, V initialValue)
Создайте CssMetaData с заданными параметрами, наследование установлено в false и без дочерних свойств.
Параметры:
property - свойство CSS
converter - StyleConverter, используемый для преобразования значения, прочитанного из CSS, в объект Java.
initialValue - Начальное или значение по умолчанию соответствующего StyleableProperty

CssMetaData

protected CssMetaData(String property, StyleConverter<?,​V> converter)
Создайте CssMetaData с заданными параметрами, initialValue равно null, inherit равно false и без дочерних свойств.
Параметры:
property - свойство CSS
converter - StyleConverter, используемый для преобразования значения, прочитанного из CSS, в объект Java.

Подробное описание методов

set

@Deprecated(since="8") public void set(S styleable, V value, StyleOrigin origin)
Устарело.
Этот метод больше не вызывается из CSS-кода. Используйте StyleableProperty.applyStyle(javafx.css.StyleOrigin, java.lang.Object)
Устанавливает значение соответствующего свойства для заданного узла.
Параметры:
styleable - Стилевое свойство, для которого устанавливается значение
value - Значение, которое будет установлено для свойства
origin - источник

isSettable

public abstract boolean isSettable(S styleable)
Проверяет, может ли соответствующее свойство заданного узла быть установлено. Этот метод вызывается перед поиском стилей для данного свойства. Он абстрактен, чтобы код мог проверить, может ли быть установлено свойство, не расширяя его. Как правило, свойство может быть установлено, если оно не равно null или не привязано.
Параметры:
styleable - Стилевое свойство, для которого проверяется установление
Возвращает:
true, если свойство может быть установлено.

getStyleableProperty

public abstract StyleableProperty<V> getStyleableProperty(S styleable)
Возвращает соответствующее StyleableProperty для данного узла. Обратите внимание, что вызов этого метода приведет к расширению свойства.
Параметры:
styleable - Стилевое свойство, для которого возвращается свойство
Возвращает:
StyleableProperty, соответствующее этому CssMetaData для данного Styleable

getProperty

public final String getProperty()
Получает имя свойства CSS.
Возвращает:
имя свойства CSS

getConverter

public final StyleConverter<?,V> getConverter()
Получает конвертер CSS, который обрабатывает преобразование значения CSS в объект Java.
Возвращает:
конвертер CSS

getInitialValue

public V getInitialValue(S styleable)
Начальное значение CssMetaData соответствует значению по умолчанию StyleableProperty в коде. Например, значение по умолчанию для Shape.fill — Color.BLACK, а initialValue для Shape.StyleableProperties.FILL также Color.BLACK.

Однако могут быть исключения. Начальное значение может зависеть от состояния узла. ScrollBar имеет ориентацию по умолчанию по горизонтали. Если ScrollBar — вертикальный, однако, этот метод должен возвращать Orientation.VERTICAL. В противном случае, вертикальный ScrollBar будет неправильно установлен на горизонтальный ScrollBar при применении начального значения.

Параметры:
styleable - стилевое свойство
Возвращает:
Начальное значение свойства, возможно null

getSubProperties

public final List<CssMetaData<? extends Styleable,?>> getSubProperties()
Дочерние свойства относятся к составляющим свойствам этого свойства, если они есть. Например, "-fx-font-weight" — дочернее свойство "-fx-font".
Возвращает:
список дочерних свойств

isInherits

public final boolean isInherits()
Если true, значение этого свойства такое же, как вычисленное значение родительского свойства.
Возвращает:
false по умолчанию, если не inherit true
См. также:
Наследование CSS

equals

public boolean equals(Object obj)
Два объекта CssMetaData считаются равными, если их значения property равны.
Overrides:
equals в классе Object
Возвращает:
true, если obj равен, иначе false

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API